Edit

IPropertyPaneDropdownProps interface

  • Reference
Package:
@microsoft/sp-property-pane

PropertyPane drop down component props.

Properties

ariaDescription

A description for the dropdown that includes instructions for the benefit of screen reader users.
ariaLabel

A label for the dropdown for the benefit of screen reader users.
ariaPositionInSet

Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1.
ariaSetSize

Defines the number of items in the current set of controls. Maps to native aria-setsize attribute.
calloutProps

Custom properties for Dropdown's Callout used to render options.
disabled

Whether the property pane dropdown option is disabled or not.
errorMessage

If set, this will be displayed as an error message.
label

Descriptive label for the Dropdown.
options

Collection of options for this Dropdown.
selectedKey

The key of the initially selected option.

Property Details

ariaDescription

A description for the dropdown that includes instructions for the benefit of screen reader users.

ariaDescription?: string;

Property Value

string

ariaLabel

A label for the dropdown for the benefit of screen reader users.

ariaLabel?: string;

Property Value

string

ariaPositionInSet

Defines an element's number or position in the current set of controls. Maps to native aria-posinset attribute. It starts from 1.

ariaPositionInSet?: number;

Property Value

number

ariaSetSize

Defines the number of items in the current set of controls. Maps to native aria-setsize attribute.

ariaSetSize?: number;

Property Value

number

calloutProps

Custom properties for Dropdown's Callout used to render options.

calloutProps?: IPropertyPaneDropdownCalloutProps;

Property Value

IPropertyPaneDropdownCalloutProps

disabled

Whether the property pane dropdown option is disabled or not.

disabled?: boolean;

Property Value

boolean

errorMessage

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.

If set, this will be displayed as an error message.

errorMessage?: string;

Property Value

string

label

Descriptive label for the Dropdown.

label: string;

Property Value

string

options

Collection of options for this Dropdown.

options?: IPropertyPaneDropdownOption[];

Property Value

IPropertyPaneDropdownOption[]

selectedKey

The key of the initially selected option.

selectedKey?: string | number;

Property Value

string | number