Skip to content

Commit cc54ef6

Browse files
authored
DOC-3147: The ToggleToolbarDrawer command's skipFocus option has been deprecated. (#3748)
1 parent 5c4c0f0 commit cc54ef6

File tree

2 files changed

+37
-3
lines changed

2 files changed

+37
-3
lines changed

modules/ROOT/pages/8.0-release-notes.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,19 @@ tinymce.init({
275275

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

278+
=== Added support for `skip_focus` option in ToggleToolbarDrawer command
279+
// #TINY-12044
280+
281+
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.
282+
283+
.Updated new `skip_focus` option usage command
284+
[source]
285+
----
286+
editor.execCommand('ToggleToolbarDrawer', false, null, { skip_focus: true });
287+
----
288+
289+
For more information on the `ToggleToolbarDrawer` command, see: xref:editor-command-identifiers.adoc[Available Commands].
290+
278291
=== The translate API now automatically replaces three dots in a row with an ellipsis character.
279292
// #TINY-12155
280293

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

519532
// CCFR here.
520533

534+
=== The `ToggleToolbarDrawer` command's `skipFocus` option has been deprecated
535+
// #TINY-12044
536+
537+
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.
538+
539+
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.
540+
541+
.Before deprecation using the `skipFocus` option
542+
[source]
543+
----
544+
editor.execCommand('ToggleToolbarDrawer', false, { skipFocus: true });
545+
----
546+
547+
.After deprecation using the `skip_focus` option
548+
[source]
549+
----
550+
editor.execCommand('ToggleToolbarDrawer', false, null, { skip_focus: true });
551+
----
552+
553+
This change improves consistency across commands and aligns with expected usage patterns in {productname} {release-version}.
554+
521555
=== Deprecated `editor.selection.setContent` API
522556
// TINY-11692
523557

modules/ROOT/pages/editor-command-identifiers.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ The commands in the following table are provided by the {productname} editor and
155155
|mceTogglePlainTextPaste |Toggles paste as plain text.
156156
|mceToggleVisualAid |Toggles the visual aids for: tables without borders and anchors.
157157
|ToggleSidebar |Closes the current sidebar, or toggles the sidebar if the sidebar name is provided as a value (`_<sidebar-name>_`).
158-
|ToggleToolbarDrawer |Toggles the Toolbar Drawer. For information on toolbars, see: xref:toolbar-configuration-options.adoc#toolbar[User interface options - Toolbar].
158+
|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].
159159
|===
160160

161161
.Examples
@@ -199,7 +199,7 @@ tinymce.activeEditor.execCommand('mceTogglePlainTextPaste');
199199
tinymce.activeEditor.execCommand('mceToggleVisualAid');
200200
tinymce.activeEditor.execCommand('ToggleSidebar'); /* OR */
201201
tinymce.activeEditor.execCommand('ToggleSidebar', false, '<sidebar-name>');
202-
tinymce.activeEditor.execCommand('ToggleToolbarDrawer');
202+
tinymce.activeEditor.execCommand('ToggleToolbarDrawer', false, null, { skip_focus: true });
203203
----
204204

205205
[[core-table-commands]]
@@ -614,7 +614,7 @@ The following command states can be queried using the xref:apis/tinymce.editor.a
614614
|Strikethrough |Returns `+true+` if the content is formatted using the same markup as the {productname} `+Strikethrough+` command.
615615
|Subscript |Returns `+true+` if the content is formatted using the same markup as the {productname} `+Subscript+` command.
616616
|Superscript |Returns `+true+` if the content is formatted using the same markup as the {productname} `+Superscript+` command.
617-
|ToggleToolbarDrawer |Returns `+true+` if the Toolbar Drawer is open. The state can be controlled by the {productname} `+ToggleToolbarDrawer+` command.
617+
|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.
618618
|Underline |Returns `+true+` if the content is formatted using the same markup as the {productname} `+Underline+` command.
619619
|===
620620

0 commit comments

Comments
 (0)