Skip to content

TINYDOC-3655: Document the View API keepToolbar option. #4396

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 1 commit into from
Oct 15, 2026
Merged

TINYDOC-3655: Document the View API keepToolbar option. #4396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion modules/ROOT/pages/8.10.0-release-notes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a
[[additions]]
== Additions

{productname} {release-version} also includes the following addition:
{productname} {release-version} also includes the following additions:

=== Added the `+BlobInfo+` type to the public API
// #TINYMCE-14853
Expand All @@ -381,6 +381,13 @@ Previously, {productname} passed a `+BlobInfo+` object to the functions set for

In {productname} {release-version}, the `+BlobInfo+` type is part of the public {productname} API. TypeScript integrations can use it to type the functions they set for these options.

=== New `+keepToolbar+` property for custom views
// #TINYMCE-14768

Previously, opening a xref:custom-view.adoc[custom view] hid the editor menu bar, toolbar, and status bar, so the view replaced the whole editor.

In {productname} {release-version}, the view specification object accepts a new xref:custom-view.adoc#keeptoolbar[`+keepToolbar+`] property. When `+keepToolbar+` is set to `+true+`, the menu bar, toolbar, and status bar stay visible while the view is open, and opening the view closes any open sidebar. The default value is `+false+`, which keeps the previous behavior.


[[bug-fixes]]
== Bug fixes
Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/changelog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ NOTE: This is the {productname} Community version changelog. For information abo
// #TINYMCE-14853
* New `revert-all` icon.
// #TINYMCE-14851
* Views can now keep the editor toolbar visible with the new `keepToolbar` option, which closes any open sidebar.
// #TINYMCE-14768

### Fixed
* Applying a list style did not change the markers, and the toolbar showed the wrong active style, on list items that had their own inline `list-style-type`.
Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/custom-view.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ This is the syntax for the `addView` function: `+editor.ui.registry.addView(name

| `+buttons+` | `+Array+` | The `+buttons+` property specifies an array of buttons to be displayed in the top right corner of the view.

| [[keeptoolbar]]`+keepToolbar+` | `+Boolean+` | The `+keepToolbar+` property specifies whether the editor menu bar, toolbar, and status bar stay visible while the view is open. When set to `+true+`, the view fills the space below the toolbar, opening the view closes any open sidebar, and the element path in the status bar is disabled until the view closes. Toolbar buttons and menu items are not disabled. Default value: `+false+`, where the view replaces the whole editor.

| `+onShow+` | `+Function+` | The `+onShow+` property specifies a function to be called when the view is displayed. It receives an API object.

| `+onHide+` | `+Function+` | The `+onHide+` property specifies a function to be called when the view is hidden. It receives an API object.
Expand Down
Loading