IPropertyPaneButtonProps interface

Package:

@microsoft/sp-property-pane

PropertyPane button props.

Properties

ariaDescription	Detailed description of the button for the benefit of screen readers. Besides the compound button, other button types will need more information provided to screen reader.
ariaLabel	The aria label of the button for the benefit of screen readers.
buttonType	The type of button to render. Default value is ButtonType.normal.
description	Description of the action this button takes. Only used for compound buttons.
disabled	Whether the button is disabled.
icon	The button icon shown in command or hero type.
onClick	A callback which is invoked on the button click, which takes in the existing value for the bound property and returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props.
text	Display text of the element.

Property Details

ariaDescription

Detailed description of the button for the benefit of screen readers.

Besides the compound button, other button types will need more information provided to screen reader.

ariaDescription?: string;

Property Value

string

ariaLabel

The aria label of the button for the benefit of screen readers.

ariaLabel?: string;

Property Value

string

buttonType

The type of button to render. Default value is ButtonType.normal.

buttonType?: PropertyPaneButtonType;

Property Value

PropertyPaneButtonType

description

Description of the action this button takes. Only used for compound buttons.

description?: string;

Property Value

string

disabled

Whether the button is disabled.

disabled?: boolean;

Property Value

boolean

icon

The button icon shown in command or hero type.

icon?: string;

Property Value

string

onClick

A callback which is invoked on the button click, which takes in the existing value for the bound property and returns the new value and which is then used to update the properties bag. This update will result in the re-render of the PropertyPane with the new props.

onClick: (value: any) => any;

Property Value

(value: any) => any

text

Display text of the element.

text: string;

Property Value

string