ITopActionsDropdownOption interface

  • Reference
Package:
@microsoft/sp-top-actions

TopActions Dropdown option props.

Properties

ariaLabel

The aria label of the choice group option for the benefit of screen readers.
checked

Whether the choice group option is checked or not.

Default value is false.
dataAutomationId

The data-automation-id property for the dropdown option.
disabled

Whether the choice group option is disabled or not.
iconProps

The Icon component props for choice field.
imageSize

The width and height of the image in px for choice field.
imageSrc

The src of image for choice field.
key

A required key to uniquely identify the option.
selectedImageSrc

The src of image for choice field which is selected.
text

The text string for the option.
title

Title (tooltip) text displayed when hovering over an item.

Property Details

ariaLabel

The aria label of the choice group option for the benefit of screen readers.

readonly ariaLabel?: string;

Property Value

string

checked

Whether the choice group option is checked or not.

Default value is false.

readonly checked?: boolean;

Property Value

boolean

dataAutomationId

The data-automation-id property for the dropdown option.

readonly dataAutomationId?: string;

Property Value

string

disabled

Whether the choice group option is disabled or not.

readonly disabled?: boolean;

Property Value

boolean

iconProps

The Icon component props for choice field.

readonly iconProps?: ITopActionsDropdownOptionIconProps;

Property Value

ITopActionsDropdownOptionIconProps

imageSize

The width and height of the image in px for choice field.

readonly imageSize?: {
        readonly width: number;
        readonly height: number;
    };

Property Value

{ readonly width: number; readonly height: number; }

imageSrc

The src of image for choice field.

readonly imageSrc?: string;

Property Value

string

key

A required key to uniquely identify the option.

readonly key: string | number;

Property Value

string | number

selectedImageSrc

The src of image for choice field which is selected.

readonly selectedImageSrc?: string;

Property Value

string

text

The text string for the option.

readonly text: string;

Property Value

string

title

Title (tooltip) text displayed when hovering over an item.

readonly title?: string;

Property Value

string