Interface IconDto

Hierarchy

  • IconDto

Properties

component label onClick presets? svgIcon

Properties

component

component: ComponentClass<Record<string, never>, {}> | FunctionalComponent<Record<string, never>>

The icon react component

label

label: string

An ID (usually the plugin name in case of a plugin) - used for icons order calculations has to be corresponds to the names of the icons (plugins) names in the ui-managers config (under upperBarManager.pluginsIconsOrder)

onClick

onClick: ((e: MouseEvent | KeyboardEvent) => void)

Type declaration

    • (e: MouseEvent | KeyboardEvent): void

    • The icon handler

      Remarks

      You can also define the handler inside the component itself and send an empty function here (also useful as backwards compatibility for some plugins)

      Parameters

      • e: MouseEvent | KeyboardEvent

      Returns void

Optional presets

presets?: ReservedPresetName[]

Relevant presets for the icon

svgIcon

svgIcon: SvgIcon

Icon that will appear in the dropdown menu

Settings

Member Visibility

Theme

Generated using TypeDoc