Skip to content

DOC-3147: The ToggleToolbarDrawer command's skipFocus option has been deprecated. #3748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kemister85 merged 2 commits into from
Jul 15, 2025
Merged

DOC-3147: The ToggleToolbarDrawer command's skipFocus option has been deprecated. #3748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fb8bda
DOC-3147: The ToggleToolbarDrawer command's skipFocus option has been…
kemister85 Jun 4, 2025
9566acd
Merge branch 'feature/8.0.0/DOC-3147' into feature/8.0.0/DOC-3147_TIN…
kemister85 Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions modules/ROOT/pages/8.0-release-notes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,19 @@ tinymce.init({

For more information, see: xref:user-formatting-options.adoc#list_max_depth[User formatting - List max depth].

=== Added support for `skip_focus` option in ToggleToolbarDrawer command
// #TINY-12044

The `ToggleToolbarDrawer` command now supports the standard `skip_focus` option, which allows opening the toolbar drawer without focusing the editor. This provides consistent behavior with other editor commands.

.Updated new `skip_focus` option usage command
[source]
----
editor.execCommand('ToggleToolbarDrawer', false, null, { skip_focus: true });
----

For more information on the `ToggleToolbarDrawer` command, see: xref:editor-command-identifiers.adoc[Available Commands].

=== The translate API now automatically replaces three dots in a row with an ellipsis character.
// #TINY-12155

Expand Down Expand Up @@ -518,6 +531,27 @@ For information about setting up containerized server-side components using Dock

// CCFR here.

=== The `ToggleToolbarDrawer` command's `skipFocus` option has been deprecated
// #TINY-12044

The `ToggleToolbarDrawer` command previously accepted a non-standard `skipFocus` option to prevent the editor from receiving focus when the command was executed. This behavior differed from other editor commands, which use the generic `skip_focus` option for the same purpose. As a result, the inconsistency lead to confusion when implementing or maintaining command logic.

To resolve this, support for the standard `skip_focus` option has been added to the `ToggleToolbarDrawer` command. The `skipFocus` option is now **deprecated** in {productname} {release-version} and will be removed in a future release.

.Before deprecation using the `skipFocus` option
[source]
----
editor.execCommand('ToggleToolbarDrawer', false, { skipFocus: true });
----

.After deprecation using the `skip_focus` option
[source]
----
editor.execCommand('ToggleToolbarDrawer', false, null, { skip_focus: true });
----

This change improves consistency across commands and aligns with expected usage patterns in {productname} {release-version}.

=== Deprecated `editor.selection.setContent` API
// TINY-11692

Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/editor-command-identifiers.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ The commands in the following table are provided by the {productname} editor and
|mceTogglePlainTextPaste |Toggles paste as plain text.
|mceToggleVisualAid |Toggles the visual aids for: tables without borders and anchors.
|ToggleSidebar |Closes the current sidebar, or toggles the sidebar if the sidebar name is provided as a value (`_<sidebar-name>_`).
|ToggleToolbarDrawer |Toggles the Toolbar Drawer. For information on toolbars, see: xref:toolbar-configuration-options.adoc#toolbar[User interface options - Toolbar].
|ToggleToolbarDrawer |Toggles the Toolbar Drawer. Can be used with the `skip_focus` option to prevent focusing the editor. For information on toolbars, see: xref:toolbar-configuration-options.adoc#toolbar[User interface options - Toolbar].
|===

.Examples
Expand Down Expand Up @@ -199,7 +199,7 @@ tinymce.activeEditor.execCommand('mceTogglePlainTextPaste');
tinymce.activeEditor.execCommand('mceToggleVisualAid');
tinymce.activeEditor.execCommand('ToggleSidebar'); /* OR */
tinymce.activeEditor.execCommand('ToggleSidebar', false, '<sidebar-name>');
tinymce.activeEditor.execCommand('ToggleToolbarDrawer');
tinymce.activeEditor.execCommand('ToggleToolbarDrawer', false, null, { skip_focus: true });
----

[[core-table-commands]]
Expand Down Expand Up @@ -614,7 +614,7 @@ The following command states can be queried using the xref:apis/tinymce.editor.a
|Strikethrough |Returns `+true+` if the content is formatted using the same markup as the {productname} `+Strikethrough+` command.
|Subscript |Returns `+true+` if the content is formatted using the same markup as the {productname} `+Subscript+` command.
|Superscript |Returns `+true+` if the content is formatted using the same markup as the {productname} `+Superscript+` command.
|ToggleToolbarDrawer |Returns `+true+` if the Toolbar Drawer is open. The state can be controlled by the {productname} `+ToggleToolbarDrawer+` command.
|ToggleToolbarDrawer |Returns `+true+` if the Toolbar Drawer is open. The state can be controlled by the {productname} `+ToggleToolbarDrawer+` command. When controlling the state, use the `skip_focus` option (recommended) instead of the deprecated `skipFocus` option.
|Underline |Returns `+true+` if the content is formatted using the same markup as the {productname} `+Underline+` command.
|===

Expand Down