ITopActionsField interface

Configuration used for a single Top Action command.

Properties

properties

Strongly typed properties object. Specific to each field type.

shouldFocus

Whether this control should be focused.

targetProperty

Target property from the web part's property bag.

title

Display name for the action which can be used in a tooltip or aria-label.

type

Type of the top actions field.

Property Details

properties

Strongly typed properties object. Specific to each field type.

readonly properties: TProperties;

Property Value

TProperties

Remarks

Example: Dropdown has ITopActionsChoiceGroupProps, Button has ITopActionsButtonProps props.

shouldFocus

Whether this control should be focused.

readonly shouldFocus?: boolean;

Property Value

boolean

Remarks

The default value is false.

targetProperty

Target property from the web part's property bag.

readonly targetProperty: string;

Property Value

string

title

Display name for the action which can be used in a tooltip or aria-label.

readonly title?: string;

Property Value

string

type

Type of the top actions field.

readonly type: TopActionsFieldType;

Property Value