filter_value

Properties

Anchor to

active

boolean

Returns true if the value is currently active. Returns false if not.

Can only return true for filters of type boolean or list.

Anchor to

count

number

The number of results related to the filter value.

Returns a value only for boolean and list type filters. Returns nil for price_range type filters.

Anchor to

image

image

The visual representation of the filter value when an image is used.

Returns an image drop for the filter value. Requires the filter presentation to be image and for an image to be available. Otherwise, returns nil.

Anchor to

label

string

The customer-facing label for the filter value. For example, Red or Rouge.

Returns a value only for boolean and list type filters. Returns nil for price_range type filters.

Anchor to

param_name

string

The URL parameter for the parent filter of the filter value.

For example, filter.v.option.color.

Filters of type price_range include an extra component depending on whether the filter value is for the filter's min_value or max_value. The following table outlines the URL parameter for each:

Value type	URL parameter
min_value	filter.v.price.gte
max_value	filter.v.price.lte

Anchor to

swatch

swatch

The visual representation of the filter value when a swatch is used.

Returns a swatch drop for the filter value. Requires the filter presentation to be swatch and saved color or image content for the swatch. Otherwise, returns nil.

Anchor to

url_to_add

string

The current page URL with the filter value parameter added.

Note

Any pagination URL parameters are removed.

Anchor to

url_to_remove

string

The current page URL with the filter value parameter removed.

Note

Any pagination URL parameters are also removed.

Anchor to

value

string

The value for the URL parameter. The value is paired with the param_name property.

For example, High will be used in the URL as filter.v.option.strength=High.