tinymce.editor.ui.Ui

This editor ui instance.

Summary

Properties

Name Type Summary Defined by

registry

Registry

Editor UI registry instance.

Ui

styleSheetLoader

StyleSheetLoader

Editor UI stylesheet loader instance. StyleSheetLoader for styles in the editor UI. For content styles, use editor.dom.styleSheetLoader.

Added in TinyMCE 5.4

Ui

Methods

Name Summary Defined by

tinymce.editor.ui.disable()

Disables the editor user interface. This method affects all user interface elements, including: menu bar, toolbar, notifications, and dialogs.

Added in TinyMCE 5.6

Ui

tinymce.editor.ui.enable()

Enables the editor user interface. This method affects all user interface elements, including: menu bar, toolbar, notifications, and dialogs. Can not be used when in readonly mode.

Added in TinyMCE 5.6

Ui

tinymce.editor.ui.hide()

Hides the editor user interface for inline editors. This method affects all user interface elements, including: menu bar, toolbar, notifications, and dialogs.

If the toolbar_persist option is set to true and this method is used, the user interface will remain hidden, regardless of focus.

Added in TinyMCE 5.5

Ui

tinymce.editor.ui.isDisabled()

Determines if the editor user interface is disabled (true) or not (false).

Added in TinyMCE 5.6

Ui

tinymce.editor.ui.show()

Reveals the editor user interface for inline editors. This method affects all user interface elements, including: menu bar, toolbar, notifications, and dialogs.

If the toolbar_persist option is set to true and this method is used, the user interface will remain visible, regardless of focus.

Added in TinyMCE 5.5

Ui

Methods

tinymce.editor.ui.disable()

tinymce.editor.ui.disable()

Disables the editor user interface. This method affects all user interface elements, including: menu bar, toolbar, notifications, and dialogs.

Added in TinyMCE 5.6

tinymce.editor.ui.enable()

tinymce.editor.ui.enable()

Enables the editor user interface. This method affects all user interface elements, including: menu bar, toolbar, notifications, and dialogs. Can not be used when in readonly mode.

Added in TinyMCE 5.6

tinymce.editor.ui.hide()

tinymce.editor.ui.hide()

Hides the editor user interface for inline editors. This method affects all user interface elements, including: menu bar, toolbar, notifications, and dialogs.

If the toolbar_persist option is set to true and this method is used, the user interface will remain hidden, regardless of focus.

Added in TinyMCE 5.5

tinymce.editor.ui.isDisabled()

tinymce.editor.ui.isDisabled(): Boolean

Determines if the editor user interface is disabled (true) or not (false).

Added in TinyMCE 5.6

Return value

  • Boolean - true/false if the editor user interface is disabled (true) or not (false).

tinymce.editor.ui.show()

tinymce.editor.ui.show()

Reveals the editor user interface for inline editors. This method affects all user interface elements, including: menu bar, toolbar, notifications, and dialogs.

If the toolbar_persist option is set to true and this method is used, the user interface will remain visible, regardless of focus.

Added in TinyMCE 5.5