widget:slider

Description

Creates a slider

Usage

as element:
<widget:slider
       [response="{object}"]
       [query="{string}"]
       [facet-name="{string}"]
       [facet="{string}"]
       [field-name="{string}"]
       [min="{number}"]
       [max="{number}"]
       [step="{number}"]
       [button-label="{string}"]
       [to-label="{string}"]
       [prefix="{string}"]
       [suffix="{string}"]
       [invert-range="{boolean}"]
       [multiplier="{number}"]
       [date-format="{string}"]
       [sort="{boolean}"]>
</widget:slider>

Parameters

Param Type Details
response
(optional)
object

A response object

query
(optional)
string

The name of the query to build links from.

facet-name
(optional)
string

Facet name to use from the response object

facet
(optional)
string

A facet object to display

field-name
(optional)
string

The field name tells the slider which field to use when creating range filters.

min
(optional)
number

The minimum value for the slider. (Defaults to 0, not required for facets)

max
(optional)
number

The maximum value for the slider. (Defaults to 100, not required for facets)

step
(optional)
number

The interval between each step of the slider. (Defaults to 1, not required for facets)

button-label
(optional)
string

The text to be used for the 'Apply' button.

to-label
(optional)
string

The string to be inserted in the filter's display value between the 'from' and 'to' value. (Defaults to '-')

prefix
(optional)
string

Add a string before the display value. Useful for currency symbols, for instance.

suffix
(optional)
string

Add a string after the display value. Useful for adding units, such as “k” for thousands.

invert-range
(optional)
boolean

When invertRange is set to true, the from and to values of the resulting range filter are swapped.

multiplier
(optional)
number

The multiplier parameter accepts a number and multiplies the slider's value by the multiplier when creating a filter.

date-format
(optional)
string

How to format the date. See date format filter for valid formats.

sort
(optional)
boolean

Whether the data should be sort by the directive. Defaults to true.

Example

Source