SliderOwnProps

Properties

Link copied to clipboard
abstract external var ariaLabel: String?

The label of the slider.

Link copied to clipboard
abstract external var ariaLabelledBy: ElementId?

The id of the element containing a label for the slider.

Link copied to clipboard
abstract external var ariaValueText: String?

A string value that provides a user-friendly name for the current value of the slider.

Link copied to clipboard
abstract external var classes: SliderClasses?

Override or extend the styles applied to the component.

Link copied to clipboard
abstract external override var className: ClassName?
Link copied to clipboard
abstract external var color: SliderColor?

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Link copied to clipboard
abstract external var defaultValue: Any?

The default value. Use when the component is not controlled.

Link copied to clipboard
abstract external var disabled: Boolean?

If true, the component is disabled.

Link copied to clipboard
abstract external var disableSwap: Boolean?

If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.

Link copied to clipboard
abstract external var getAriaLabel: (index: Number) -> String?

Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

Link copied to clipboard
abstract external var getAriaValueText: (value: Number, index: Number) -> String?

Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

Link copied to clipboard
abstract external var key: Key?
Link copied to clipboard
abstract external var marks: Any?

Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.

Link copied to clipboard
abstract external var max: Double?

The maximum allowed value of the slider. Should not be equal to min.

Link copied to clipboard
abstract external var min: Double?

The minimum allowed value of the slider. Should not be equal to max.

Link copied to clipboard
abstract external var name: String?

Name attribute of the hidden input element.

Link copied to clipboard
abstract external var onChange: (event: Event, ReadonlyArray<Number>, activeThumb: Number) -> Unit?

Callback function that is fired when the slider's value changed.

Link copied to clipboard
abstract external var onChangeCommitted: (event: SyntheticEvent<*, *>, ReadonlyArray<Number>) -> Unit?

Callback function that is fired when the pointer or touch interaction ends.

Link copied to clipboard
abstract external var orientation: Orientation?

The component orientation.

Link copied to clipboard
abstract external var scale: (value: Number) -> Number?

A transformation function, to change the scale of the slider.

Link copied to clipboard
abstract external var shiftStep: Number?

The granularity with which the slider can step through values when using Page Up/Page Down or Shift + Arrow Up/Arrow Down.

Link copied to clipboard
abstract external var size: BaseSize?

The size of the slider.

Link copied to clipboard
abstract external var step: Number?

The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.

Link copied to clipboard
abstract external override var sx: SxProps<Theme>?

The system prop that allows defining system overrides as well as additional CSS styles.

Link copied to clipboard
abstract external var tabIndex: Int?

Tab index attribute of the hidden input element.

Link copied to clipboard
abstract external var track: Union?

The track presentation:

Link copied to clipboard
abstract external var value: Any?

The value of the slider. For ranged sliders, provide an array with two values.

Link copied to clipboard
abstract external var valueLabelDisplay: Union?

Controls when the value label is displayed:

Link copied to clipboard
abstract external var valueLabelFormat: String?

The format function the value label's value.

Functions

Link copied to clipboard
open inline operator external fun Props?.unaryPlus()