Skip to content

Document richtext extension reload behavior #847

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

Merged
alvarosabu merged 2 commits into from
Oct 19, 2026
Merged

Document richtext extension reload behavior #847

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef2df5e
Enhance rich text extension documentation with reload guidance
alvarosabu Oct 10, 2026
12b727f
Name the actions that reload extensions in the richtext guide
alvarosabu Oct 19, 2026
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
10 changes: 10 additions & 0 deletions content/guides/09.extensions/3.app-extensions/7.richtext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,16 @@ When a Directus major version upgrades Tiptap, update your extension before your
4. Set `host` to the new major version, for example `^13.0.0`.
5. Publish the update as a new major version of your extension.

## Reload During Development

The editor builds its schema from the registered extensions when it opens. Tiptap does not let an open editor change its schema, so an open editor does not pick up a reloaded extension.

When Directus reloads extensions (with `EXTENSIONS_AUTO_RELOAD`, or when you enable, disable, install or uninstall an extension in Settings → Extensions), editors that are already open keep the previous version of your extension. The Data Studio shows a "Reload Required" notice. Save your changes and reload the page to use the new version.

::callout{icon="i-lucide-info"}
If a rich text field has unsaved changes, the browser asks you to confirm before it reloads the page.
::

## Next Steps

Read about [publishing to the Marketplace](/guides/extensions/marketplace/publishing), the [WYSIWYG interface options](/guides/data-model/interfaces#wysiwyg), and [custom formats](/guides/data-model/rich-text) for the editor.
Loading