Skip to content

ckeditor5-elements / ElementToolbarDefinition

Interface: ElementToolbarDefinition ​

A floating toolbar of the elements that match element.

Properties ​

ariaLabel? ​

ts
ariaLabel?: string;

The accessible name of the toolbar. Defaults to "Element toolbar".


element ​

ts
element: ElementMatcher;

The elements the toolbar is for: the name of a model element (e.g. 'note'), or a function that returns whether it is for the given element (e.g. element => element.name.startsWith('heading')).


items ​

ts
items: ToolbarConfigItem[];

The toolbar items, as in CKEditor's toolbar config:

  • the name of a command that acts on an element (an ElementOrPositionCommand, e.g. 'moveElementUp'): a button that acts on the element of the toolbar,
  • the name of another UI component (e.g. 'bold'), as in the main toolbar,
  • '|', a separator.