AvailabilitiesFilter

The AvailabilitiesFilter object represents a availabilities filter in the storefront.

classDiagram
  direction LR
  AvailabilitiesFilter --> AvailabilitiesFilterValuesList
  class AvailabilitiesFilter{
    string name
    bool isActive
    bool hasCounters
    bool isSingleChoiceOnly
    int limit
    AvailabilitiesFilterValuesList values
  }
  class AvailabilitiesFilterValuesList{
  }

Properties

Attribute name	Type	Description
name	string	The name of the availabilities filter.
isActive	bool	Returns true when availabilities filter is active.
hasCounters	bool	Returns true when availabilities filter has counter.
isSingleChoiceOnly	bool	Returns true when availabilities filter is single choice.
limit	number	Number of visible options in the filter.
values	AvailabilitiesFilterValuesList	The AvailabilitiesFilterValuesList object that represents list of AvailabilitiesFilterValue object.

Examples

name property

sourceoutput

{{ availabilitiesFilter.name }}

example name

isActive property

sourceoutput

{{ availabilitiesFilter.isActive }}

true

hasCounters property

sourceoutput

{{ availabilitiesFilter.hasCounters }}

true

isSingleChoiceOnly property

sourceoutput

{{ availabilitiesFilter.isSingleChoiceOnly }}

true

limit property

sourceoutput

{{ availabilitiesFilter.limit }}

3

values property

sourceoutput

{% for filter in availabilitiesFilter.values %}
  <p>name: {{ filter.name }}</p>
{% endfor %}

<p>name: example filter name 1</p>
<p>name: example filter name 2</p>