Question

Methods

name	summary	defined by
addAutocompleter()	Registers a new auto completer component. When a configured string pattern is matched in the content while typing, the autocompleter will be triggered. Emoticons and Charmap use an autocompleter.	tinymce.editor.ui.registry
addButton()	Registers a new toolbar button that executes a command when clicked or activated via keyboard navigation controls.	tinymce.editor.ui.registry
addContextForm()	Registers a new contextual form item. Similar to a context menu item, a contextual form is an item with an input form element appearing when a content predicate is matched. An example us of a contextual form is the link plugin when the configuration { link_context_toolbar: true } is used. When the cursor is on a link, a contextual input form appears allowing for quick changes to the url field.	tinymce.editor.ui.registry
addContextMenu()	Registers a new context menu section that only appears when a content predicate is matched for example the cursor is inside a table.	tinymce.editor.ui.registry
addContextToolbar()	Registers a new context toolbar that only appears when a content predicate is matched for example the cursor is on an image element.	tinymce.editor.ui.registry
addIcon()	Registers a new SVG icon, the icon name reference can be configured by any TinyMCE 5 Ui components that can display an icon. The icon is only available to the editor instance it was configured for.	tinymce.editor.ui.registry
addMenuButton()	Registers a new menu button. Adds a toolbar button that opens a menu when clicked. The menu can be populated by items created by addMenuItem, addNestedMenuItem or addToggleMenuItem	tinymce.editor.ui.registry
addMenuItem()	Registers a new menu item that executes a command when clicked or activated via keyboard navigation controls.	tinymce.editor.ui.registry
addNestedMenuItem()	Registers a new menu item that reveals a submenu when clicked or activated by keyboard navigation controls. The submenu can be populated by items created by addMenuItem, addNestedMenuItem or addToggleMenuItem	tinymce.editor.ui.registry
addSidebar()	Registers a new sidebar container. This sidebar container is attached to the right side of the editor and can be toggled open or closed. When registered, a new toolbar toggle button with the same sidebar name is created. Additionally there is a ToggleSidebar command and a 'ToggleSidebar' event that can used to manage the sidebar open/closed state. The tinycomments plugin uses a sidebar for its Ui components.	tinymce.editor.ui.registry
addSplitButton()	Registers a new split button for the toolbar. The advanced list plugin uses a split button to simplify its functionality.	tinymce.editor.ui.registry
addToggleButton()	Registers a new toggle button for the toolbar. A toggle buttons state can be set in the configuration.	tinymce.editor.ui.registry
addToggleMenuItem()	Registers a new menu item that will act like a toggle button, showing a tick in the menu item to represent state.	tinymce.editor.ui.registry

Methods

addAutocompleter

addAutocompleter(name:String, obj:InlineContent.AutocompleterApi):void

Registers a new auto completer component. When a configured string pattern is matched in the content while typing, the autocompleter will be triggered. Emoticons and Charmap use an autocompleter.

Parameters

• name (String) - Unique name identifying this autocomplete configuration.
• obj (InlineContent.AutocompleterApi) - The autocomplete configuration object.

Return value

• void - void

addButton

addButton(name:String, obj:Toolbar.ToolbarButtonApi):void

Registers a new toolbar button that executes a command when clicked or activated via keyboard navigation controls.

Parameters

• name (String) - Unique name identifying the button, this button name will be used in the toolbar configuration to reference the button.
• obj (Toolbar.ToolbarButtonApi) - the button configuration object.

Return value

• void - void

addContextForm

addContextForm(name:String, obj:Toolbar.ContextFormApi):void

Registers a new contextual form item. Similar to a context menu item, a contextual form is an item with an input form element appearing when a content predicate is matched. An example us of a contextual form is the link plugin when the configuration { link_context_toolbar: true } is used. When the cursor is on a link, a contextual input form appears allowing for quick changes to the url field.

Parameters

• name (String) - Unique name identifying the new contextual form item.
• obj (Toolbar.ContextFormApi) - the context form configuration object.

Return value

• void - void

addContextMenu

addContextMenu(name:String, obj:Menu.ContextMenuApi):void

Registers a new context menu section that only appears when a content predicate is matched for example the cursor is inside a table.

Parameters

• name (String) - Unique name identifying the new context menu.
• obj (Menu.ContextMenuApi) - The context menu configuration object.

Return value

• void - void

addContextToolbar

addContextToolbar(name:String, obj:Toolbar.ContextToolbarApi):void

Registers a new context toolbar that only appears when a content predicate is matched for example the cursor is on an image element.

Parameters

• name (String) - Unique name identifying the new context toolbar.
• obj (Toolbar.ContextToolbarApi) - The context menu configuration object.

Return value

• void - void

addIcon

addIcon(name:String, string:svgData):void

Registers a new SVG icon, the icon name reference can be configured by any TinyMCE 5 Ui components that can display an icon. The icon is only available to the editor instance it was configured for.

Parameters

• name (String) - Unique name identifying the new icon.
• string (svgData) - The SVG data string the browser will use to render the SVG icon.

Return value

• void - void

addMenuButton

addMenuButton(name:String, obj:Toolbar.ToolbarMenuButtonApi):void

Registers a new menu button. Adds a toolbar button that opens a menu when clicked. The menu can be populated by items created by addMenuItem, addNestedMenuItem or addToggleMenuItem

Parameters

• name (String) - Unique name identifying the new menu button.
• obj (Toolbar.ToolbarMenuButtonApi) - The menu button configuration object.

Return value

• void - void

addMenuItem

addMenuItem(name:String, obj:Menu.MenuItemApi):void

Registers a new menu item that executes a command when clicked or activated via keyboard navigation controls.

Parameters

• name (String) - Unique name identifying the new menu item.
• obj (Menu.MenuItemApi) - The menu item configuration object.

Return value

• void - void

addNestedMenuItem

addNestedMenuItem(name:String, obj:Menu.NestedMenuItemApi):void

Registers a new menu item that reveals a submenu when clicked or activated by keyboard navigation controls. The submenu can be populated by items created by addMenuItem, addNestedMenuItem or addToggleMenuItem

Parameters

• name (String) - Unique name identifying the new nested menu item.
• obj (Menu.NestedMenuItemApi) - The nested menu item configuration object.

Return value

• void - void

addSidebar

addSidebar(name:String, obj:Sidebar.SidebarApi):void

Registers a new sidebar container. This sidebar container is attached to the right side of the editor and can be toggled open or closed. When registered, a new toolbar toggle button with the same sidebar name is created. Additionally there is a ToggleSidebar command and a 'ToggleSidebar' event that can used to manage the sidebar open/closed state. The tinycomments plugin uses a sidebar for its Ui components.

Parameters

• name (String) - Unique name identifying the new sidebar.
• obj (Sidebar.SidebarApi) - The sidebar configuration object.

Return value

• void - void

addSplitButton

addSplitButton(name:String, obj:Toolbar.ToolbarSplitButtonApi):void

Registers a new split button for the toolbar. The advanced list plugin uses a split button to simplify its functionality.

Parameters

• name (String) - Unique name identifying the new split button.
• obj (Toolbar.ToolbarSplitButtonApi) - The split button configuration object.

Return value

• void - void

addToggleButton

addToggleButton(name:String, obj:Toolbar.ToolbarToggleButtonApi):void

Registers a new toggle button for the toolbar. A toggle buttons state can be set in the configuration.

Parameters

• name (String) - Unique name identifying the new split button.
• obj (Toolbar.ToolbarToggleButtonApi) - The toggle button configuration object.

Return value

• void - void

addToggleMenuItem

addToggleMenuItem(name:String, obj:Menu.ToggleMenuItemApi):void

Registers a new menu item that will act like a toggle button, showing a tick in the menu item to represent state.

Parameters

• name (String) - Unique name identifying the new menu item.
• obj (Menu.ToggleMenuItemApi) - The menu item configuration object.

Return value

• void - void

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.