Skip to content

DOC-3243: New view_show option to display a specified view on initialization#4021

Open
kemister85 wants to merge 1 commit intofeature/8.4.0/DOC-3243from
feature/8.4.0/DOC-3243_TINY-11967
Open

DOC-3243: New view_show option to display a specified view on initialization#4021
kemister85 wants to merge 1 commit intofeature/8.4.0/DOC-3243from
feature/8.4.0/DOC-3243_TINY-11967

Conversation

@kemister85
Copy link
Contributor

@kemister85 kemister85 commented Mar 16, 2026

Ticket: DOC-3243

Site: Staging links:

Changes:

  • Added release note entry for TINY-11967 to modules/ROOT/pages/8.4.0-release-notes.adoc (Additions section): New view_show option to display a specified view on initialization.
  • Created modules/ROOT/partials/configuration/view_show.adoc – configuration option partial with description, plugin links, and examples (premium plugin and custom view).
  • Updated modules/ROOT/pages/custom-view.adoc – added Options section including view_show partial; restructured so Toggling and Querying remain under Editor View API.
  • Created modules/ROOT/partials/plugins/suggestededits-open-view.adoc and included in modules/ROOT/pages/suggestededits.adoc.
  • Created modules/ROOT/partials/plugins/revisionhistory-open-view.adoc and included in modules/ROOT/pages/revisionhistory.adoc.
  • Created modules/ROOT/partials/plugins/advcode-open-view.adoc and included in modules/ROOT/pages/advcode.adoc.
  • Fixed modules/ROOT/examples/live-demos/custom-view/index.js – removed .replace(/\s+/g, '') that stripped spaces from editor content; set textarea value separately to preserve content. - broken 2 years ago.

Pre-checks:

  • Branch is correctly prefixed (feature/8.4.0/DOC-3243_TINY-11967)
  • modules/ROOT/nav.adoc has been updated (if applicable).
  • Files have been included where required (if applicable).
  • Files removed have been deleted, not just excluded from the build (if applicable).
  • Files added for New product features include a release note entry.
  • Major or minor version changes have updated the supported-versions.adoc table.
  • Build passes without console errors, warnings, or issues.

Review:

  • Documentation Team Lead has reviewed.

@kemister85 kemister85 requested review from a team and soritaheng as code owners March 16, 2026 03:34
@kemister85 kemister85 requested review from EkimChau, ShiridiGandham and tiny-james and removed request for a team March 16, 2026 03:34
@kemister85 kemister85 added the upcoming release Documentation for features currently under development/QA label Mar 16, 2026
@kemister85 kemister85 added this to the TinyMCE 8.4.0 milestone Mar 16, 2026
@kemister85 kemister85 requested a review from MitchC1999 March 16, 2026 03:42
<textarea class="tox-view__pane_panel" style="width: 100%; height: 100%; resize: none; padding: 0.5em">
${editorContent}
</textarea>
</div>`.replace(/\s+/g, '');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
</div>`.replace(/\s+/g, '');
<textarea class="my-textarea" style="width: 100%; height: 100%; resize: none; padding: 0.5em"></textarea>
</div>`;
container.querySelector('.my-textarea').value = editorContent;

=== New `view_show` option to display a specified view on initialization.
// #TINY-11967

Previously, integrators could not configure the editor to open with a specific view (such as Suggested Edits or Revision History) displayed on initialization. This was needed when users would only need to resolve suggested changes or review content, or when the current user had permission only to review changes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Previously, integrators could not configure the editor to open with a specific view (such as Suggested Edits or Revision History) displayed on initialization. This was needed when users would only need to resolve suggested changes or review content, or when the current user had permission only to review changes.

Since this is a new feature, we don't need to describe the previous behaviour.

[[view_show]]
== `+view_show+`

This option allows the specified view to be displayed on editor initialization. It behaves similarly to xref:customsidebar.adoc#sidebar_show[`+sidebar_show+`] but applies to views and takes precedence when both are configured. Views and sidebars can both be set to show on init.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This option allows the specified view to be displayed on editor initialization. It behaves similarly to xref:customsidebar.adoc#sidebar_show[`+sidebar_show+`] but applies to views and takes precedence when both are configured. Views and sidebars can both be set to show on init.
This option allows the specified view to be displayed on editor initialization. It behaves similarly to xref:customsidebar.adoc#sidebar_show[`+sidebar_show+`] but applies to views and takes precedence when both are configured. Views and sidebars can both be set to show on init, with the sidebar shown once the view is closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

upcoming release Documentation for features currently under development/QA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants