IconPickerProps

Interface

Properties for the IconPicker component.

Events

onButtonClick optional

onButtonClick: function

Callback fired when the dropdown button is clicked.

Type declaration
    (eany): void
    Parameters
    • eany
    Returns 
    void

onChange optional

onChange: function

Callback fired when the icon selection has been changed.

Type declaration
    (resultImmutableObject<IconResult>): void
    Parameters
    • resultImmutableObject<IconResult>
    Returns 
    void

Properties

buttonOptions optional

buttonOptions: ButtonProps

The options apply to the dropdown button element.

className optional

className: string

Defines the class names added to the element.

configurableOption optional

configurableOption: ConfigurableOption

Defines which icon propertie(s) can be configured in the icon picker.

customIcons optional

customIcons: IconResult[]

Configures additional icons as options.

groups optional

groups: void | void | void | void | PublicIconGroupType[]

Defines which groups of icons to show as the default icon options from Jimu UI's predefined library.

hideRemove optional

hideRemove: boolean

If true, the remove option will be hidden.

icon optional

icon: IconResult

The default icon.

previewOptions optional

previewOptions: PreviewOptions

Turn on/off preview options in the icon picker's dialog.

showLabel optional

showLabel: boolean

If true, the file name of the selected icon will display in the button node.

vertical optional

vertical: boolean

Is direction vertical

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.