PriceFilter

The PriceFilter object represents a price filter in the storefront.

classDiagram
  direction LR
  PriceFilter --> Url
  class PriceFilter{
    string name
    bool isActive
    string priceFromUrlKey
    string priceToUrlKey
    ?float priceFrom
    ?float priceTo
    ?Url urlWithFilterValueRemoved
    ?Url urlWithSingleFilterValue
    ?Url urlWithFilterValueAdded
    ?Url urlWithPriceFromFilterValueRemoved
    ?Url urlWithPriceToFilterValueRemoved
  }

Properties

Attribute name	Type	Description
name	string	The name of the price filter.
isActive	bool	Returns true if price filter is active.
priceFromUrlKey	string	Represents url key of 'price from' value.
priceToUrlKey	string	Represents url key of 'price to' value.
priceFrom	float | null	Represents 'price from' value.
priceTo	float | null	Represents 'price to' value.
urlWithFilterValueRemoved	null | Url	Returns Url object that represents link with filter value removed.
urlWithSingleFilterValue	null | Url	Returns Url object that represents link with single filter value.
urlWithFilterValueAdded	null | Url	Returns Url object that represents link with filter value added.
urlWithPriceFromFilterValueRemoved	null | Url	Returns Url object that represents link with filter value without priceFrom param.
urlWithPriceToFilterValueRemoved	null | Url	Returns Url object that represents link with filter value without priceTo param.

Examples

name property

sourceoutput

{{ priceFilter.name }}

example name

isActive property

sourceoutput

{{ priceFilter.isActive }}

true

priceFromUrlKey property

sourceoutput

{{ priceFilter.priceFromUrlKey }}

pricefrom

priceToUrlKey property

sourceoutput

{{ priceFilter.priceToUrlKey }}

priceto

priceFrom property

sourceoutput

{{ priceFilter.priceFrom }}

2.03

priceTo property

sourceoutput

{{ priceFilter.priceTo }}

4.56

urlWithFilterValueRemoved property

sourceoutput

{{ priceFilter.urlWithFilterValueRemoved }}

/pl/c/Fruit/52

urlWithSingleFilterValue property

sourceoutput

{{ priceFilter.urlWithSingleFilterValue }}

/pl/c/Fruit/52/1/default/1/pricefrom/2.03/priceto/4.56

urlWithFilterValueAdded property

sourceoutput

{{ priceFilter.urlWithFilterValueAdded }}

/pl/c/Fruit/52/1/default/1/pricefrom/2.03/priceto/4.56

urlWithPriceFromFilterValueRemoved property

sourceoutput

{{ priceFilter.urlWithPriceFromFilterValueRemoved }}

/pl/c/Fruit/52/1/default/1/priceto/4.56

urlWithPriceToFilterValueRemoved property

sourceoutput

{{ priceFilter.urlWithPriceToFilterValueRemoved }}

/pl/c/Fruit/52/1/default/1/pricefrom/2.03