interface-toolbarbutton

Interface: ToolbarButton

Defines a button in the toolbar extension point.
The toolbar is displayed on the left side of the board.

By default your icon will be only displayed on the library.

See IPluginConfigExtensionPoints for examples.

Read more about Extension Points

Hierarchy

  • ToolbarButton

Index

Properties

Properties

librarySvgIcon

librarySvgIcon: string

The icon that will be displayed on the library (when clicking the dots ... icon
in the toolbar).
Must be an SVGElement

By default your button will be displayed here.
The user must drag and drop you plugin icon from the library into the toolbar to display it directly in
the toolbar.


onClick

onClick: () => void

A handler to be executed when the user clicks the button


title

title: string

The title of the button, It will be displayed on mouse over.


toolbarSvgIcon

toolbarSvgIcon: string

The icon that will be displayed in the toolbar after the user drag it from the library.
Must be an SVG Element


Did this page help you?