CategoryFilterSelectable
Represents a selectable option within a category filter.
Properties |
---|
color
Color | null
Swatch-based options will include a color (see displayType ) represented
as a Color object.
All other option types will have a null value for this property.
|
count
Number
The number of Products matching the current filter option (in combination with any selected filter options). |
displayType
CategoryFilterDisplayType
A string-based object containing the display preference for the filter options.
|
id
String
The ID of the selectable item. |
image
Url | null
Swatch-based options may include an image (see displayType ) represented
as a Url object.
All other option types will have a null value for this property.
|
isActive
Boolean
Indicates whether the option is currently selected. |
isMultiSelect
Boolean
True if the display preference should allow users to select more than one option. |
isRangeSelect
Boolean
True if the selection type permits a min and max value. |
isSingleSelect
Boolean
True if the a user should only be permitted to select one option from those available. |
label
String
Contains the text value to display as a selectable option. |
selectionType
CategoryFilterSelectionType
A string-based object containing the preferred method of selection for the filter options. This may be one of the following:
|
type
CategoryFilterType
A string-based object representing the type of filter, which may currently be one of the following supported types:
|