IPropertyPaneCheckboxProps interface

Package:

@microsoft/sp-property-pane

PropertyPane CheckBox component props.

Properties

ariaLabel	Adds an aria-label to the checkbox for accessibility.
checked	Whether the property pane checkbox is checked or not.
disabled	Whether the property pane checkbox is disabled or not.
text	Label to display next to the checkbox.

Property Details

ariaLabel

Adds an aria-label to the checkbox for accessibility.

ariaLabel?: string;

Property Value

string

checked

Whether the property pane checkbox is checked or not.

checked?: boolean;

Property Value

boolean

Remarks

The default value is false.

disabled

Whether the property pane checkbox is disabled or not.

disabled?: boolean;

Property Value

boolean

text

Label to display next to the checkbox.

text?: string;

Property Value

string