SliderOwnProps

Types

Link copied to clipboard
interface Components
Link copied to clipboard
interface ComponentsProps
Link copied to clipboard
interface SlotProps
Link copied to clipboard
interface Slots

Properties

Link copied to clipboard
abstract var classes: SliderClasses?

Override or extend the styles applied to the component.

Link copied to clipboard
abstract override var className: ClassName?
Link copied to clipboard
abstract 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

The components used for each slot inside.

Link copied to clipboard

The extra props for the slot components. You can override the existing props or add new ones.

Link copied to clipboard
abstract var defaultValue: dynamic

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

Link copied to clipboard
abstract var disabled: Boolean?

If true, the component is disabled.

Link copied to clipboard
abstract 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 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 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 var key: Key?
Link copied to clipboard
abstract var marks: dynamic

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 var max: Number?

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

Link copied to clipboard
abstract var min: Number?

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

Link copied to clipboard
abstract var name: String?

Name attribute of the hidden input element.

Link copied to clipboard
abstract 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 var onChangeCommitted: (event: SyntheticEvent<*, *>, ReadonlyArray<Number>) -> Unit?

Callback function that is fired when the mouseup is triggered.

Link copied to clipboard
abstract var orientation: Orientation?

The component orientation.

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

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

Link copied to clipboard
abstract 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 var size: BaseSize?

The size of the slider.

Link copied to clipboard

The props used for each slot inside the Slider.

Link copied to clipboard

The components used for each slot inside the Slider. Either a string to use a HTML element or a component.

Link copied to clipboard
abstract 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 override var sx: SxProps<Theme>?

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

Link copied to clipboard
abstract var tabIndex: Int?

Tab index attribute of the hidden input element.

Link copied to clipboard
abstract var track: Union?

The track presentation:

Link copied to clipboard
abstract var value: dynamic

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

Link copied to clipboard
abstract var valueLabelDisplay: Union?

Controls when the value label is displayed:

Link copied to clipboard
abstract var valueLabelFormat: String?

The format function the value label's value.

Functions

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