You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
TIP: Use `editor.documentBaseURI.getURI()` for all base URL operations.
270
+
TIP: Use `editor.editorManager.documentBaseURI.getURI()` for all base URL operations.
271
271
272
272
**Impact**: This change improves URL handling consistency by removing an undocumented API that was not aligned with the documented `documentBaseURI` property.
273
273
274
274
**Migration steps:**
275
275
276
-
To update all references of `documentBaseUrl` to the new API, replace any usage of `editor.documentBaseUrl` (or similar) with `editor.documentBaseURI.getURI()`. The property `documentBaseUrl` has been removed, and the correct way to access the document base URL is now through the `documentBaseURI` property, which is a URI object. You can then call `.getURI()` on it to get the string value of the URL.
276
+
To update all references of `documentBaseUrl` to the new API, replace any usage of `editor.documentBaseUrl` (or similar) with `editor.editorManager.documentBaseURI.getURI()`. The property `documentBaseUrl` has been removed, and the correct way to access the document base URL is now through the `editorManager.documentBaseURI` property, which is a URI object. You can then call `.getURI()` on it to get the string value of the URL.
277
277
278
278
**Migration checklist:**
279
279
280
280
* [ ] Search your codebase for all instances of `editor.documentBaseUrl`.
281
-
* [ ] Replace them with `tinymce.activeEditor.documentBaseURI.getURI()` (or `editor.documentBaseURI.getURI()` if you have an `editor` reference).
281
+
* [ ] Replace them with `tinymce.activeEditor.editorManager.documentBaseURI.getURI()` (or `editor.editorManager.documentBaseURI.getURI()` if you have an `editor` reference).
282
282
283
283
===== skipFocus and skip_focus Consolidation (v8)
284
284
@@ -293,17 +293,17 @@ The `skipFocus` and `skip_focus` options for the `ToggleToolbarDrawer` command h
. **Backup and Prepare**: Ensure comprehensive backups before upgrading.
198
198
. **Update Core Initialization**:
199
-
.. Update `theme`, `skin`, and to refect the new oxide theme and skin.
200
-
... In {productname} 4, there were multiple themes available including 'modern', 'inlite', and 'mobile'. These themes were removed in {productname} 5 and combined into a single responsive theme called "Silver".
199
+
.. Verify `theme` and `skin` settings. In {productname} 5, the Silver theme with Oxide skin was already standard, so no theme changes are required when migrating to v{release-version}.
201
200
.. Update `forced_root_block: false` options to `forced_root_block: "p"`.
202
201
.. Consolidate toolbars.
203
202
.. Review new v{release-version} defaults for security settings.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/migration-from-6x-to-8x.adoc
+24-41Lines changed: 24 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,49 +13,22 @@ This guide provides a complete migration path from TinyMCE 6 to TinyMCE 8, cover
13
13
14
14
== Key Changes
15
15
16
-
=== UI Themes and Skins
17
-
18
-
The theme and skin system has been updated across versions 7 and 8:
19
-
20
-
* **Modern Theme**: Replaced by the `silver` theme with `oxide` skin
21
-
* **Lightgray Theme**: Replaced by the `silver` theme with `oxide` skin
22
-
* **Mobile Theme**: Replaced by the `silver` theme with `oxide` skin
23
-
24
-
**Migration Steps:**
25
-
26
-
1. Update theme configuration to use `silver` theme
27
-
2. Update skin configuration to use `oxide` skin
28
-
3. Test UI appearance and functionality
29
-
30
-
.Example:
31
-
[source,js]
32
-
----
33
-
// Old TinyMCE 6 configuration
34
-
tinymce.init({
35
-
selector: "textarea",
36
-
theme: "modern",
37
-
skin: "lightgray"
38
-
});
39
-
40
-
// New TinyMCE 7+ configuration
41
-
tinymce.init({
42
-
selector: "textarea",
43
-
theme: "silver",
44
-
skin: "oxide"
45
-
});
46
-
----
47
-
48
16
=== Plugin Ecosystem
49
17
50
18
The {productname} plugin ecosystem underwent changes starting in version 7.0, with several plugins being removed or reclassified.
51
19
52
20
* **Removed Plugins** (no longer available as of {productname} 7.0):
53
21
** `template`: Removed in 7.0. Replaced by the premium xref:advanced-templates.adoc[Templates] plugin.
54
22
55
-
* **Now Premium Only**:
23
+
* **Now Premium Only** (removed in 6.0, before this migration path):
56
24
** `imagetools`: Removed in 6.0. Replaced by the premium xref:editimage.adoc[Enhanced Image Editing] feature, available via the `+editimage+` plugin introduced in TinyMCE 6.0.
57
25
** `textcolor`: Removed in 6.0. Use the xref:user-formatting-options.adoc#text-color-options[premium Color Picker] functionality instead.
58
26
27
+
[NOTE]
28
+
====
29
+
If you're migrating from TinyMCE 6, these plugins (`imagetools` and `textcolor`) were already removed in version 6.0, so you won't need to migrate them. The sections below are included for reference only, in case you're upgrading from an older version or have legacy code.
30
+
====
31
+
59
32
==== Plugin Migration Examples
60
33
61
34
* `template` (removed in v7):
@@ -223,15 +196,15 @@ The `editor.documentBaseUrl` property has been removed. Use `editor.editorManage
**Impact**: This change improves URL handling consistency by removing an undocumented API that was not aligned with the documented `documentBaseURI` property.
230
203
231
204
**Migration checklist:**
232
205
233
206
* [ ] Search your codebase for all instances of `editor.documentBaseUrl`.
234
-
* [ ] Replace them with `tinymce.activeEditor.documentBaseURI.getURI()` (or `editor.documentBaseURI.getURI()` if you have an `editor` reference).
207
+
* [ ] Replace them with `tinymce.activeEditor.editorManager.documentBaseURI.getURI()` (or `editor.editorManager.documentBaseURI.getURI()` if you have an `editor` reference).
235
208
236
209
==== skipFocus and skip_focus Consolidation
237
210
@@ -246,23 +219,23 @@ The `skipFocus` and `skip_focus` options for the `ToggleToolbarDrawer` command w
246
219
**Migration Steps:**
247
220
248
221
1. Locate all instances of `ToggleToolbarDrawer` command usage
249
-
2. Replace `skip_focus` with `skipFocus` in command parameters
222
+
2. Replace `skipFocus` with `skip_focus` in command parameters
* [ ] Locate all instances of `ToggleToolbarDrawer` command usage
265
-
* [ ] Replace `skip_focus` with `skipFocus` in command options
238
+
* [ ] Replace `skipFocus` with `skip_focus` in command options
266
239
* [ ] Update any custom plugins using this command
267
240
* [ ] Test toolbar drawer behavior after changes
268
241
@@ -441,6 +414,11 @@ The `template` plugin was removed in TinyMCE 7.0. If you were using this plugin,
441
414
442
415
=== Image Tools Plugin Removal
443
416
417
+
[NOTE]
418
+
====
419
+
This section applies only if you're upgrading from TinyMCE 5 or earlier. The `imagetools` plugin was removed in TinyMCE 6.0, so if you're migrating from TinyMCE 6, this plugin was already unavailable.
420
+
====
421
+
444
422
The `imagetools` plugin was removed in TinyMCE 6.0. If you were using this plugin, you need to migrate to the premium Enhanced Image Editing feature.
445
423
446
424
**Migration Steps:**
@@ -477,6 +455,11 @@ tinymce.init({
477
455
478
456
=== Text Color Plugin Removal
479
457
458
+
[NOTE]
459
+
====
460
+
This section applies only if you're upgrading from TinyMCE 5 or earlier. The `textcolor` plugin was removed in TinyMCE 6.0, so if you're migrating from TinyMCE 6, this plugin was already unavailable.
461
+
====
462
+
480
463
The `textcolor` plugin was removed in TinyMCE 6.0. If you were using this plugin, you need to migrate to the xref:user-formatting-options.adoc#text-color-options[premium Color Picker] functionality.
TIP: Use `editor.documentBaseURI.getURI()` for all base URL operations.
364
+
TIP: Use `editor.editorManager.documentBaseURI.getURI()` for all base URL operations.
365
365
366
366
**Impact**: This change improves URL handling consistency by removing an undocumented API that was not aligned with the documented `documentBaseURI` property.
367
367
368
368
**Migration steps:**
369
369
370
370
371
-
To update all references of `documentBaseUrl` to the new API, replace any usage of `editor.documentBaseUrl` (or similar) with `editor.documentBaseURI.getURI()`. The property `documentBaseUrl` has been removed, and the correct way to access the document base URL is now through the `documentBaseURI` property, which is a URI object. You can then call `.getURI()` on it to get the string value of the URL.
371
+
To update all references of `documentBaseUrl` to the new API, replace any usage of `editor.documentBaseUrl` (or similar) with `editor.editorManager.documentBaseURI.getURI()`. The property `documentBaseUrl` has been removed, and the correct way to access the document base URL is now through the `editorManager.documentBaseURI` property, which is a URI object. You can then call `.getURI()` on it to get the string value of the URL.
This change is necessary because the undocumented `editor.documentBaseUrl` API has been removed to improve URL handling consistency. The new approach uses the documented `documentBaseURI` property, which provides a URI object with methods such as `getURI()` to retrieve the full URL string.
@@ -391,7 +391,7 @@ For more information see: link:https://www.tiny.cloud/docs/tinymce/latest/apis/t
391
391
392
392
393
393
* [ ] Search your codebase for all instances of `editor.documentBaseUrl`.
394
-
* [ ] Replace them with `tinymce.activeEditor.documentBaseURI.getURI()` (or `editor.documentBaseURI.getURI()` if you have an `editor` reference).
394
+
* [ ] Replace them with `tinymce.activeEditor.editorManager.documentBaseURI.getURI()` (or `editor.editorManager.documentBaseURI.getURI()` if you have an `editor` reference).
0 commit comments