IPropertyPaneSliderProps interface

Package:

@microsoft/sp-property-pane

PropertyPaneSliderProps component props.

Properties

ariaLabel	A description of the Slider for the benefit of screen readers.
disabled	Whether or not the Slider is disabled.
label	Description label of the Slider.
max	The max value of the Slider.
min	The min value of the Slider.
showValue	Whether to show the value on the right of the Slider.
step	The difference between the two adjacent values of the Slider. Defaults to 1.
value	The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events. Defaults to min.
valueFormat	Callback to format the Slider value. For example, if (value) => `${value}%` is specified, the value of the Slider has % after it.

Property Details

ariaLabel

A description of the Slider for the benefit of screen readers.

ariaLabel?: string;

Property Value

string

disabled

Whether or not the Slider is disabled.

disabled?: boolean;

Property Value

boolean

label

Description label of the Slider.

label?: string;

Property Value

string

max

The max value of the Slider.

max: number;

Property Value

number

min

The min value of the Slider.

min: number;

Property Value

number

showValue

Whether to show the value on the right of the Slider.

showValue?: boolean;

Property Value

boolean

Remarks

If you want to show the value by yourself, you may want to set this value to false.

step

The difference between the two adjacent values of the Slider. Defaults to 1.

step?: number;

Property Value

number

value

The initial value of the Slider. Use this if you intend to pass in a new value as a result of onChange events.

Defaults to min.

value?: number;

Property Value

number

valueFormat

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Callback to format the Slider value. For example, if

 (value) => `${value}%`

is specified, the value of the Slider has % after it.

valueFormat?: (value: number) => string;

Property Value

(value: number) => string