IPropertyPaneSpinButtonProps interface

Package:

@microsoft/sp-property-pane

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.

PropertyPaneSpinButton component props.

Properties

ariaLabel	A description of the SpinButton for the benefit of screen readers. Defaults to not apply the aria label.
defaultValue	The default value of the SpinButton. It shows as the initial value in the spin button control. Defaults to the min value.
disabled	Whether or not the SpinButton is disabled. Defaults to false.
label	Description label of the SpinButton.
max	The max value of the SpinButton. Defaults to 100.
min	The min value of the SpinButton. Defaults to 0.

Property Details

ariaLabel

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.

A description of the SpinButton for the benefit of screen readers. Defaults to not apply the aria label.

ariaLabel?: string;

Property Value

string

defaultValue

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.

The default value of the SpinButton. It shows as the initial value in the spin button control. Defaults to the min value.

defaultValue?: number;

Property Value

number

disabled

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.

Whether or not the SpinButton is disabled. Defaults to false.

disabled?: boolean;

Property Value

boolean

label

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.

Description label of the SpinButton.

label: string;

Property Value

string

max

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.

The max value of the SpinButton. Defaults to 100.

max?: number;

Property Value

number

min

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.

The min value of the SpinButton. Defaults to 0.

min?: number;

Property Value

number