Skip to content

Tiptap RTE updates for v17.0 #7728

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
sofietoft merged 3 commits into from
Dec 17, 2025
Merged

Tiptap RTE updates for v17.0 #7728

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da453a0
Tiptap RTE: Corrects import namespace (for CMS v17)
leekelleher Dec 15, 2025
28257d0
Tiptap RTE: Adds reference to the `tiptapStatusbarExtension` extensio…
leekelleher Dec 15, 2025
a16ddf2
Fix grammar and punctuation in extensions.md
sofietoft Dec 17, 2025
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: 6 additions & 4 deletions ...operty-editors/built-in-umbraco-property-editors/rich-text-editor/extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Information on how to work with Tiptap extensions in the rich text

The Rich Text Editor (RTE) in Umbraco is based on the open-source editor [Tiptap](https://tiptap.dev/).

Out of the box, Tiptap has limited capabilities and everything is an extension by design. Basic text formatting features such as bold, italic, and underline are their own extensions. This offers great flexibility, making the rich text editor highly configurable. The implementation in Umbraco offers a wide range of built-in extensions to enhance the Tiptap editor capabilities.
Out of the box, Tiptap has limited capabilities, and everything is an extension by design. Basic text formatting features, such as bold, italic, and underline, are their own extensions. This offers great flexibility, making the rich text editor highly configurable. The implementation in Umbraco offers a wide range of built-in extensions to enhance the Tiptap editor capabilities.

Using the same extension points, this article will show you how to add a custom extension to the rich text editor.

Expand All @@ -16,12 +16,14 @@ Tiptap has a library of supported native extensions. You can find a list of thes

### Tiptap extension types

There are two types of extension: `tiptapExtension` and `tiptapToolbarExtension`.
There are three types of extensions: `tiptapExtension`, `tiptapToolbarExtension`, and `tiptapStatusbarExtension`.

The `tiptapExtension` extension is used to register a native [Tiptap Extension](https://tiptap.dev/docs/editor/extensions/). These will enhance the capabilities of the rich text editor itself. For example, to enable text formatting, drag-and-drop functionality and spell-checking.

The `tiptapToolbarExtension` extension adds a toolbar action that interacts with the Tiptap editor (and native Tiptap extensions).

The `tiptapStatusbarExtension` extension adds a component to the statusbar, located at the bottom of the Tiptap editor.

## Adding a native extension

{% hint style="info" %}
Expand Down Expand Up @@ -52,7 +54,7 @@ export default class UmbTiptapHighlightExtensionApi extends UmbTiptapExtensionAp

```js
import { UmbTiptapToolbarElementApiBase } from '@umbraco-cms/backoffice/tiptap';
import type { Editor } from '@umbraco-cms/backoffice/external/tiptap';
import type { Editor } from '@umbraco-cms/backoffice/tiptap';

export default class UmbTiptapToolbarHighlightExtensionApi extends UmbTiptapToolbarElementApiBase {
override execute(editor?: Editor) {
Expand All @@ -61,7 +63,7 @@ export default class UmbTiptapToolbarHighlightExtensionApi extends UmbTiptapTool
}
```

Once you have the above code in place, they can be referenced using a [bundle extension type](../../../../../customizing/extending-overview/extension-types/bundle.md).
Once you have the above code in place, it can be referenced using a [bundle extension type](../../../../../customizing/extending-overview/extension-types/bundle.md).

{% code title="manifests.ts" lineNumbers="true" %}
```js
Expand Down