IPropertyPaneChoiceGroupOption interface

Package:

@microsoft/sp-property-pane

PropertyPane ChoiceGroup option props.

Properties

ariaLabel	The aria label of the property pane choice group option for the benefit of screen readers.
checked	Whether the property pane choice group option is checked or not. Default value is false.
disabled	Whether the property pane choice group option is disabled or not.
iconProps	The Icon component props for choice field.
imageAlt	The alt text of an image for the 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.

Property Details

ariaLabel

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

ariaLabel?: string;

Property Value

string

checked

Whether the property pane choice group option is checked or not.

Default value is false.

checked?: boolean;

Property Value

boolean

disabled

Whether the property pane choice group option is disabled or not.

disabled?: boolean;

Property Value

boolean

iconProps

The Icon component props for choice field.

iconProps?: IPropertyPaneChoiceGroupOptionIconProps;

Property Value

IPropertyPaneChoiceGroupOptionIconProps

imageAlt

The alt text of an image for the choice field.

imageAlt?: string;

Property Value

string

imageSize

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

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

Property Value

{ width: number; height: number; }

imageSrc

The src of image for choice field.

imageSrc?: string;

Property Value

string

key

A required key to uniquely identify the option.

key: string | number;

Property Value

string | number

selectedImageSrc

The src of image for choice field which is selected.

selectedImageSrc?: string;

Property Value

string

text

The text string for the option.

text: string;

Property Value

string