CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Interface

ToolbarBehavior (ui/toolbar)

@ckeditor/ckeditor5-ui/src/toolbar/toolbarview

interface private
See source

A class interface defining the behavior of the ToolbarView.

Toolbar behaviors extend its look and functionality and have an impact on the element template or rendering. They can be enabled conditionally, e.g. depending on the configuration of the toolbar.

Filtering

Properties

  • destroy : function

    readonly

    A method called after the toolbar has been destroyed. It allows cleaning up after the toolbar behavior, for instance, this is the right place to detach event listeners, free up references, etc.

    See source

  • render : function

    readonly

    A method called after the toolbar has been rendered. It can be used to, for example, customize the behavior of the toolbar when its element is available.

    See source

    Parameters

    view : ToolbarView

    An instance of the toolbar being rendered.

Methods

  • constructor( view )

    Creates a new toolbar behavior instance.

    See source

    The instance is created in the constructor of the toolbar. This is the right place to extend the template of the toolbar, define extra toolbar properties, etc.

    Parameters

    view : ToolbarView

    An instance of the toolbar that this behavior is added to.