Interface IconDto

Hierarchy

  • IconDto

Properties

ariaLabel component displayName onClick order presets? svgIcon

Properties

ariaLabel

ariaLabel: any

An HTML Aria label attribute that would be attached to the provided icon - string | of preact-i18n Element

component

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

The icon react component

displayName

displayName: string

An ID uniquely identify a control (should be the plugin name in case of a plugin icon)

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

order

order: number

The plugin priority order (the lower the number the higher the priority - the order is from left to right - flows from upper bar (max 5 icon) to dropdown bar(the reset and again from top to bottom))

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