Skip to content

Tiptap: Relocation of external extensions/package#20256

Merged
iOvergaard merged 16 commits intov17/devfrom
v17/feature/tiptap-externals-relocation
Sep 25, 2025
Merged

Tiptap: Relocation of external extensions/package#20256
iOvergaard merged 16 commits intov17/devfrom
v17/feature/tiptap-externals-relocation

Conversation

@leekelleher
Copy link
Copy Markdown
Member

Description

Following the Tiptap capabilities refactor in PR #20078 (for v16.3), we wanted to bring the "external" extensions source-code into the main "tiptap" package, however this is a breaking-change, so has been saved for v17.

In practical terms, the import namespace "@umbraco-cms/backoffice/external/tiptap" has been removed, replaced with "@umbraco-cms/backoffice/tiptap".

Meaning that any 3rd-party extension code would need to be updated from...

import { Editor } from '@umbraco-cms/backoffice/external/tiptap';

to...

import { Editor } from '@umbraco-cms/backoffice/tiptap';

It is worth noting that we no longer export the Tiptap StarterKit (@tiptap/starter-kit) library, as it has been removed since it is no longer used internally in the CMS backoffice.

How to test this?

In terms of testing the core CMS, it's mainly to check that the Tiptap RTE still functions as expected, with no JS errors or warnings.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR relocates the Tiptap "external" extensions source code from the "external/tiptap" module into the main "tiptap" package as part of the v17 breaking changes. The refactor consolidates all Tiptap-related functionality under a single namespace while removing the deprecated external module structure.

Key changes:

  • Removes the @umbraco-cms/backoffice/external/tiptap import namespace
  • Consolidates all Tiptap extensions and dependencies into the main @umbraco-cms/backoffice/tiptap package
  • Updates import statements across all files to use the new internal module structure

Reviewed Changes

Copilot reviewed 129 out of 130 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/Umbraco.Web.UI.Client/tsconfig.json Removes external/tiptap path mapping from TypeScript configuration
src/Umbraco.Web.UI.Client/src/packages/tiptap/package.json Adds all Tiptap dependencies previously defined in external module
src/Umbraco.Web.UI.Client/src/packages/tiptap/externals.ts New file exporting all Tiptap core extensions for internal use
Multiple extension files Updates imports from external/tiptap to use relative paths to externals.js
Multiple custom extension files Removes deprecated comments and updates interface/export names
src/Umbraco.Web.UI.Client/src/external/tiptap/ Removes entire external tiptap module directory
src/Umbraco.Web.UI.Client/package.json Removes external/tiptap export mapping
Files not reviewed (1)
  • src/Umbraco.Web.UI.Client/package-lock.json: Language not supported
Comments suppressed due to low confidence (2)

src/Umbraco.Web.UI.Client/src/packages/tiptap/extensions/table/table.tiptap-extension.ts:1

  • Remove large blocks of commented-out code. If this functionality might be needed in the future, consider creating a TODO comment or filing an issue instead of keeping dead code.
/* eslint-disable @typescript-eslint/consistent-type-imports */

src/Umbraco.Web.UI.Client/src/packages/tiptap/extensions/table/table.tiptap-extension.ts:1

  • Remove large blocks of commented-out code. If this functionality might be needed in the future, consider creating a TODO comment or filing an issue instead of keeping dead code.
/* eslint-disable @typescript-eslint/consistent-type-imports */

@leekelleher leekelleher marked this pull request as draft September 24, 2025 15:07
@leekelleher leekelleher marked this pull request as ready for review September 24, 2025 15:43
@iOvergaard iOvergaard merged commit ac23ff5 into v17/dev Sep 25, 2025
26 of 27 checks passed
@iOvergaard iOvergaard deleted the v17/feature/tiptap-externals-relocation branch September 25, 2025 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants