Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SliderConfig

The configuration for a {link @Slider} object.

Hierarchy

  • SliderConfig

Index

Properties

Properties

animate

animate: boolean

Optional. If true, animation will be enabled for the slider. Defaults to false.

Optional disableSnappingForNumericValues

disableSnappingForNumericValues: boolean

Disables snapping to data items or labels altogether. Will only work when the slider is in numeric mode i.e. all data item values are numeric. Defaults to true.

Optional lockMinSliderHandleAtMinVal

lockMinSliderHandleAtMinVal: boolean

If true, and if the slider is in range mode, locks the first slider handle at the slider min val. Defaults to false.

Optional range

range: boolean

Optional. If true, the slider will have two handles representing a range. Default is false.

Optional sliderMaxHandleAriaLabel

sliderMaxHandleAriaLabel: string

A language string to be applied to the aria-label of the slider max handle if in range mode. This is for WCAG compliance. If not defined, the currently selected time will be set as the label.

Optional sliderMinHandleAriaLabel

sliderMinHandleAriaLabel: string

A language string to be applied to the aria-label of the slider min handle if in range mode. This is for WCAG compliance. If not defined, the currently selected time will be set as the label.

Optional sliderSingleHandleAriaLabel

sliderSingleHandleAriaLabel: string

A language string to be applied to the aria-label of the slider handle if it is not in range mode. This is for WCAG compliance. If not defined, the currently selected time will be set as the label.