Skip to content

DOC-3243: New argument fullpagehtml to editor.getContent() and editor.setContent() APIs to only get/set the body of the content while the full page plugin is active #4025

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

Open
kemister85 wants to merge 1 commit into
base: feature/8.4.0/DOC-3243
Choose a base branch
from
Open

DOC-3243: New argument fullpagehtml to editor.getContent() and editor.setContent() APIs to only get/set the body of the content while the full page plugin is active #4025

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
15 changes: 15 additions & 0 deletions modules/ROOT/pages/8.4.0-release-notes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,21 @@ For information on the **<Open source plugin name>** plugin, see xref:<plugincod

The following premium plugin updates were released alongside {productname} {release-version}.

=== Full Page HTML

The {productname} {release-version} release includes an accompanying release of the **Full Page HTML** premium plugin.

**Full Page HTML** includes the following addition.

==== New argument `fullpagehtml` to `editor.getContent()` and `editor.setContent()` APIs to only get/set the body of the content while the full page plugin is active.
// #TINY-13744

Previously, setting and getting the editor content while the Full Page HTML plugin was active could be troublesome due to the presence of the full HTML document on all API calls, even when not needed. Attempting to get and act only on the body content (for example, for saving) was undocumented and required workarounds.

In {productname} {release-version}, the `fullpagehtml` option has been added to the `editor.getContent()` and `editor.setContent()` APIs. When set to `false`, this option allows getting and setting only the body content while the Full Page HTML plugin is active, without interfering with the full document structure. The document is now more resistant to accidental changes, and content can be retrieved or updated without including the full HTML document. For details, see xref:fullpagehtml.adoc#fullpagehtml-getcontent-setcontent[`fullpagehtml` option for getContent/setContent].

For information on the **Full Page HTML** plugin, see: xref:fullpagehtml.adoc[Full Page HTML].

=== <Premium plugin name 1> <Premium plugin name 1 version>

The {productname} {release-version} release includes an accompanying release of the **<Premium plugin name 1>** premium plugin.
Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/fullpagehtml.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ include::partial$configuration/fullpagehtml-default-body-style.adoc[leveloffset=

include::partial$configuration/fullpagehtml-hide-in-source-view.adoc[leveloffset=+1]

include::partial$configuration/fullpagehtml-getcontent-setcontent.adoc[leveloffset=+1]

include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]

include::partial$toolbar-button-ids/{plugincode}-toolbar-buttons.adoc[leveloffset=+1]
Expand Down
22 changes: 22 additions & 0 deletions modules/ROOT/partials/configuration/fullpagehtml-getcontent-setcontent.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[[fullpagehtml-getcontent-setcontent]]
== `+fullpagehtml+` option for `+getContent()+` and `+setContent()+`

When the {pluginname} plugin is active, `editor.getContent()` and `editor.setContent()` return and accept the full HTML document by default. The `fullpagehtml` option allows getting and setting only the body content when needed.

Pass `fullpagehtml: false` in the options object to bypass full-page processing and work with body content only:

* `editor.getContent({ fullpagehtml: false })` — Returns only the `<body>` content.
* `editor.setContent(content, { fullpagehtml: false })` — Sets only the body content without modifying the document head.

This option is useful when saving or loading body content separately (for example, when storing content in a database or when integrating with systems that expect body-only HTML). Unlike `fullpagehtml_hide_in_source_view`, which affects only the source code view display, the `fullpagehtml` option affects API behavior and requires no configuration.

=== Example: getting and setting body content

[source,js]
----
// Get only the body content for saving
const bodyContent = editor.getContent({ fullpagehtml: false });

// Set only the body content (preserves document head)
editor.setContent(newBodyContent, { format: 'html', fullpagehtml: false });
----
Loading