Important changes to Tiny Cloud pricing > Find out more

NOTE: TinyMCE 5 reached End of Support in April 2023. No more bug fixes, security updates, or new features will be introduced to TinyMCE 5. We recommend you upgrade to TinyMCE 6 or consider TinyMCE 5 Long Term Support (LTS) if you need more time.

tinymce.editor.ui.Ui

This editor ui instance.

Properties

name type summary defined by
registry tinymce.editor.ui.Registry Editor UI registry instance. tinymce.editor.ui.Ui
styleSheetLoader tinymce.dom.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
tinymce.editor.ui.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
tinymce.editor.ui.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
tinymce.editor.ui.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
tinymce.editor.ui.Ui
tinymce.editor.ui.isDisabled() Determines if the editor user interface is `disabled` (`true`) or not (`false`).
Added in TinyMCE 5.6
tinymce.editor.ui.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
tinymce.editor.ui.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

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.