Skip to content

Commit 6a9bef5

Browse files
committed
DOC-3147: Add fire() method, update changelog to include license key message.
1 parent 38a3080 commit 6a9bef5

File tree

3 files changed

+50
-23
lines changed

3 files changed

+50
-23
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,7 @@
415415
*** {productname} 8.0
416416
**** xref:8.0-release-notes.adoc#overview[Overview]
417417
**** xref:8.0-release-notes.adoc#accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
418+
**** xref:accompanying-enhanced-skins-and-icon-packs-changes[Accompanying Enhanced Skins & Icon Packs changes]
418419
**** xref:8.0-release-notes.adoc#improvements[Improvements]
419420
**** xref:8.0-release-notes.adoc#additions[Additions]
420421
**** xref:8.0-release-notes.adoc#changes[Changes]

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

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ include::partial$misc/admon-releasenotes-for-stable.adoc[]
1414
{productname} {release-version} was released for {enterpriseversion} and {cloudname} on Wednesday, July 23^rd^, 2025. These release notes provide an overview of the changes for {productname} {release-version}, including:
1515

1616
* xref:accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
17+
* xref:accompanying-enhanced-skins-and-icon-packs-changes[Accompanying Enhanced Skins & Icon Packs changes]
1718
* xref:improvements[Improvements]
1819
* xref:additions[Additions]
1920
* xref:changes[Changes]
@@ -203,7 +204,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a
203204
[[improvements]]
204205
== Improvements
205206

206-
{productname} {release-version} also includes the following improvement<s>:
207+
{productname} {release-version} also includes the following improvements:
207208

208209
=== Enhanced cross-origin resource handling
209210

@@ -291,7 +292,7 @@ Previously, menu items and tooltips containing three consecutive periods (`...`)
291292
[[additions]]
292293
== Additions
293294

294-
{productname} {release-version} also includes the following addition<s>:
295+
{productname} {release-version} also includes the following additions:
295296

296297
=== New `allow_html_in_comments` option to allow HTML-like content inside comment data
297298
// #TINY-12220
@@ -643,23 +644,32 @@ editor.execCommand('ToggleToolbarDrawer', false, null, { skip_focus: true });
643644

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

646-
=== Deprecated `editor.selection.setContent` API
647-
// TINY-11692
647+
=== Deprecated `fire()` method for event handling
648+
// #TINY-12012
648649

649-
The `editor.selection.setContent` method has been deprecated in {productname} {release-version}. This low-level API was never intended for external use and does not guarantee consistent behavior when inserting complex content structures, such as lists. Integrators are advised to use the supported `editor.insertContent` method for reliable content insertion.
650+
The `fire()` method was originally deprecated in {productname} 6 in favor of the `dispatch()` method for event handling, but was never removed from the codebase. {productname} {release-version} now displays a deprecation warning when the `fire()` method is used, serving as a final notice before its removal in {productname} 9.
650651

651-
This deprecation helps reduce confusion and aligns content insertion with {productname}'s supported APIs.
652+
This long-overdue cleanup aligns the API with modern event handling conventions and removes confusion around method naming. Integrators should migrate to the `dispatch()` method to ensure compatibility with future releases.
652653

654+
.Deprecated approach for dispatching custom events
655+
[source,javascript]
656+
----
657+
// Deprecated in TinyMCE 8, will be removed in 9
658+
editor.fire('someEvent');
659+
----
653660

654-
[[known-issues]]
655-
== Known issues
661+
.New approach for dispatching custom events
662+
[source,javascript]
663+
----
664+
// Use dispatch() instead
665+
editor.dispatch('someEvent');
666+
----
656667

657-
This section describes issues that users of {productname} {release-version} may encounter and possible workarounds for these issues.
668+
For more information on the `dispatch()` method, see: xref:apis/tinymce.util.eventdispatcher.adoc[EventDispatcher].
658669

659-
There <is one | are <number> known issue<s> in {productname} {release-version}.
670+
=== Deprecated `editor.selection.setContent` API
671+
// TINY-11692
660672

661-
// === <TINY-vwxyz 1 changelog entry>
662-
// #TINY-vwxyz1
673+
The `editor.selection.setContent` method has been deprecated in {productname} {release-version}. This low-level API was never intended for external use and does not guarantee consistent behavior when inserting complex content structures, such as lists. Integrators are advised to use the supported `editor.insertContent` method for reliable content insertion.
663674

664-
// CCFR here.
665-
// **Status**: This issue is currently being investigated.
675+
This deprecation helps reduce confusion and aligns content insertion with {productname}'s supported APIs.

modules/ROOT/pages/changelog.adoc

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,29 @@
44

55
NOTE: This is the {productname} Community version changelog. For information about the latest {cloudname} or {enterpriseversion} Release, see: xref:release-notes.adoc[{productname} Release Notes].
66

7+
78
== xref:8.0-release-notes.adoc[8.0.0 - 2025-07-23]
89

10+
[NOTE]
11+
====
12+
*Breaking Change in {productname} 8.0.0*: Users upgrading to {productname} {productmajorversion} with self-hosted commercial deployments must contact their account manager **to obtain new `T8LK:` prefixed license keys**. {productname} 7 license keys are not compatible with {productname} {productmajorversion} and cannot be modified to work by adding the `T8LK:` prefix. Cloud users ({cloudname}) are **not affected** as the commercial license is automatically applied. For complete details on the new license system and upgrade process, see: xref:license-key.adoc[License key configuration].
13+
====
14+
915
### Added
16+
* Support for TinyMCE 8 xref:license-key.adoc[license keys] and license key manager.
17+
// #TINY-12001
1018
* New `pageUid` property on the `tinymce` global instance.
1119
// #TINY-12021
1220
* New `editorUid` property on editor instances.
1321
// #TINY-12021
1422
* New `UserLookup` API to provide consistent user management and fetching/caching user information across TinyMCE plugins.
1523
// #TINY-11974
24+
* New toolbar icons for suggested edits plugin.
25+
// #TINY-12070
1626
* New `crossorigin` option that sets the `crossorigin` attribute on scripts loaded by the editor.
1727
// #TINY-12228
1828
* New `allow_html_in_comments` option to allow HTML like contents inside comment data.
1929
// #TINY-12220
20-
* Support for TinyMCE 8 license keys and license key manager.
21-
// #TINY-12001
2230
* New `list_max_depth` option that limits the maximum list indent depth.
2331
// #TINY-11937
2432

@@ -37,26 +45,32 @@ NOTE: This is the {productname} Community version changelog. For information abo
3745
// #TINY-12189
3846
* When `editor.resetContent()` is used, the resulting `SetContent` event now has the `initial` flag set in the event arguments.
3947
// #TINY-12146
40-
* Updated Image plugin decorative image check to align with accessbility standard
48+
* Updated Image plugin decorative image check to align with accessibility standard.
4149
// #TINY-12545
4250

4351
### Changed
4452
* DomParser no longer tries to fix some nodes when parsed with a context.
4553
// #TINY-11927
4654
* Split buttons are now rendered as separate action and chevron buttons.
4755
// #TINY-8665
56+
* Moved essential parts of the `lists` plugin into core.
57+
// #TINY-12121
4858
* Cut action now uses the editor delete implementation instead of the native `execCommand('Delete')` function.
4959
// #TINY-12171
5060
* Comments with HTML like content, attributes with HTML like values, elements with HTML Comment like textContent are no longer retained while content sanitization is active.
51-
// #TINY-12056, see TINY-12220
61+
// #TINY-12056
5262
* Added space to promotion message for ease of reading.
5363
// #TINY-12271
64+
* Added deprecation console warning to `fire()` method.
65+
// #TINY-12012
5466

5567
### Deprecated
5668
* Deprecated `skipFocus` option for ToggleToolbarDrawer command. To skip focus use `skip_focus` option.
5769
// #TINY-12044
5870
* Deprecated 'editor.selection.setContent' method.
5971
// #TINY-11692
72+
* Deprecated `fire()` method for event handling. Use `dispatch()` instead. The `fire()` method will be removed in TinyMCE 9.
73+
// #TINY-12012
6074

6175
### Removed
6276
* Removed undocumented `documentBaseUrl` property from `Editor` instances. `documentBaseURI` is the supported property.
@@ -65,7 +79,7 @@ NOTE: This is the {productname} Community version changelog. For information abo
6579
### Fixed
6680
* Long tooltips could overflow narrow browser windows.
6781
// #TINY-11884
68-
* Tab to create a new row in tables with a non-editable final row would freeze the editor.
82+
* Pressing Tab to create a new row in tables with a non-editable final row would freeze the editor.
6983
// #TINY-12018
7084
* Fixed an issue where the context form API `onSetup` was referencing the incorrect element.
7185
// #TINY-11912
@@ -77,13 +91,13 @@ NOTE: This is the {productname} Community version changelog. For information abo
7791
// #TINY-12073
7892
* New list item was not inserted correctly when existing list item had a block element inside.
7993
// #TINY-12102
80-
* Deleting a whole element would sometimes modify nearby content.
94+
* Deleting a whole element would sometimes replace the tag name of adjacent content.
8195
// #TINY-11868
8296
* HTML schema did not treat `colgroup` or `col` elements as block elements.
8397
// #TINY-12092
8498
* Inserting HTML fragments with invalid contents now retains more of the structure.
8599
// #TINY-11927
86-
* The `contextform` subtoolbar is no longer dismissed when using the back button in inline editors.
100+
* The `contextform` subtoolbar is no longer dismissed when using the toolbar back button in inline editors.
87101
// #TINY-12118
88102
* Tabbing when a `figure` was selected didn't move the selection on the `figcaption` correctly.
89103
// #TINY-11753
@@ -97,5 +111,7 @@ NOTE: This is the {productname} Community version changelog. For information abo
97111
// #TINY-12171
98112
* Added better support for template elements.
99113
// #TINY-12157
100-
* Tooltips no longer show above editor views
101-
// #TINY-12289
114+
* Tooltips no longer show above editor views.
115+
// #TINY-12289
116+
* `onboarding` plugin overlay now shows above popups.
117+
// #TINY-12522

0 commit comments

Comments
 (0)