docs: document WYSIWYG TinyMCE to Tiptap migration (CMS-2851)#774
Open
AlexGaillard wants to merge 3 commits into
Open
Conversation
Add a Version 12 breaking-change notice covering the TinyMCE to Tiptap engine swap (first-edit HTML normalization and the tinymceOverrides deprecation) and a matching changelog entry. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Drop the TinyMCE style_formats/config links, mark Options Override deprecated, and link to the v12 breaking changes for the normalization behavior. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove the TinyMCE-specific shortcuts and dead tiny.cloud link, replacing them with editor/formatting shortcuts and a pointer to the v12 change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| Read more: https://www.tiny.cloud/docs/tinymce/6/tinymce-and-screenreaders/ | ||
| <!-- TODO(CMS-2851): confirm the exact toolbar keyboard-navigation keys for the Tiptap-based editor before publishing. --> | ||
|
|
||
| The WYSIWYG editor was rebuilt on [Tiptap](https://tiptap.dev) in Directus 12. See the [Version 12 breaking changes](/releases/breaking-changes/version-12#wysiwyg-editor-rebuilt-on-tiptap) for details. |
Contributor
There was a problem hiding this comment.
Should note the specific version
| | Folder | Default folder to store uploaded files. Does not affect existing files. | | ||
| | Soft Limit | Used to limit the number of characters within the Data Studio. | | ||
| | Static Access Token | Token appended to asset URLs when displaying in the editor. | | ||
| | Custom Formats | JSON array of custom formatting styles to add to the editor's formatting menu. | |
| The editor's schema now defines which HTML it can represent. When you open an existing value, change it, and save, markup the schema does not support is normalized or removed. This only happens when a field is edited and saved. Values you do not touch are left as they are. | ||
|
|
||
| Most common HTML is preserved, including: | ||
|
|
Contributor
There was a problem hiding this comment.
Can we list all the supported tags, not just the uncommon ones not typically supported by TipTap?
| - `<script>` and `<style>` tags. | ||
| - Custom or unrecognized tags not listed above. | ||
|
|
||
| The editor shows a warning the first time you edit a field whose stored HTML would be normalized. You can dismiss this warning permanently. If you style or process stored HTML by tag, class, or attribute, review affected fields before saving. |
Contributor
There was a problem hiding this comment.
Should we note the planned fallback field as well?
|
|
||
| <!-- TODO(CMS-2851): confirm the release version/date before publishing. --> | ||
|
|
||
| - Directus 12.2.0 has a potential breaking change: the WYSIWYG (rich text) interface is now built on [Tiptap](https://tiptap.dev) instead of TinyMCE. Existing fields keep working, but stored HTML is normalized to supported markup on first edit and the **Options Override** (`tinymceOverrides`) option is deprecated. See the [Version 12 breaking changes](/releases/breaking-changes/version-12#wysiwyg-editor-rebuilt-on-tiptap). |
Contributor
There was a problem hiding this comment.
Not "potential".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the WYSIWYG (
input-rich-text-html) editor engine swap from TinyMCE 6 → Tiptap 3 (Replace TinyMCE (WYSIWYG), CMS-2851).Changes
tinymceOverridesdeprecation, plus a matching changelog entry.guides/data-model/interfaces) — reworded the WYSIWYG config table, dropped the TinyMCEstyle_formats/config doc links, marked Options Override deprecated, and linked to the breaking changes.alt+F10shortcuts and the deadtiny.cloudlink; replaced with editor/formatting shortcuts.Scope
Only the entries carrying TinyMCE-specific detail were touched. The ~24 generic "WYSIWYG field" references across framework guides and tutorials were left as-is because the interface id and stored-HTML contract are preserved.
Note: CMS-2839 and CMS-2840 shipped, so semantic tags and
class/id/data-*/aria-*attributes are preserved. The docs reflect the narrower residual scope (HTML comments, non-whitelisted inline styles,<script>/<style>, unrecognized tags).Before merging
Two
TODO(CMS-2851)flags are intentionally left inline for a maintainer to confirm:12.2.0is a placeholder (CMS-2650 still in progress).Fixes CMS-2851