diff --git a/.changeset/pre.json b/.changeset/pre.json index dc619413e8..6bb4f3c172 100644 --- a/.changeset/pre.json +++ b/.changeset/pre.json @@ -58,7 +58,8 @@ "@tiptap/vue-2": "2.5.6", "@tiptap/vue-3": "2.5.6", "@tiptap/extensions": "3.0.0-next.3", - "@tiptap/static-renderer": "3.0.0-next.1" + "@tiptap/static-renderer": "3.0.0-next.1", + "@tiptap/extension-list": "3.0.0-next.4" }, "changesets": [ "big-wolves-design", @@ -66,17 +67,29 @@ "chilled-trees-agree", "chilly-lemons-remember", "cool-bananas-breathe", + "curly-adults-move", "dirty-bats-look", "dirty-colts-shave", + "eighty-gifts-matter", "fair-jars-shout", + "gold-ads-own", "green-wolves-arrive", + "healthy-pigs-work", + "large-kangaroos-battle", "lazy-needles-train", + "moody-geckos-sort", "nervous-hairs-walk", "orange-spoons-rescue", "perfect-rice-vanish", "quick-days-matter", + "red-ants-wonder", "red-rivers-exist", + "seven-llamas-love", + "sixty-news-ring", "tame-worms-applaud", - "weak-books-eat" + "tidy-fireants-hang", + "twenty-moose-invent", + "weak-books-eat", + "witty-eels-cheer" ] } diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index becf31384e..b56e961bde 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,269 @@ # Change Log +## 3.0.0-next.5 + +### Major Changes + +- 32958d6: `Node`, `Mark` and `Extension` config options now are strongly typed and do not allow arbitrary keys on the options object. + + To add keys, like when using `extendNodeSchema` or `extendMarkSchema`, you can do this: + + ```ts + declare module '@tiptap/core' { + interface NodeConfig { + /** + * This key will be added to all NodeConfig objects in your project + */ + newKey?: string + } + interface MarkConfig { + /** + * This key will be added to all MarkConfig objects in your project + */ + newKey?: string + } + interface ExtensionConfig { + /** + * This key will be added to all ExtensionConfig objects in your project + */ + newKey?: string + } + } + ``` + +- 062afaf: `clearContent` command defaults to emitting updates now +- 062afaf: Change signature of `setContent` command to `(content, options)` and default to emitting updates +- 32958d6: `editor.storage` is now strongly typed `Storage` instances, using a similar pattern as commands, where you can define the type of the storage value using namespaces like: + + ```ts + declare module '@tiptap/core' { + interface Storage { + extensionName: StorageValue + } + } + ``` + +- 32958d6: `editor.storage` is instantiated per editor rather than per extension. + + Previously, the storage value was a singleton per extension instance, this caused strange bugs when using multiple editor instances on a single page. + + Now, storage instances are _per editor instance_, so changing the value on one `editor.storage` instance will not affect another editor's value. + +### Minor Changes + +- 0e3207f: Add support for [markviews](https://prosemirror.net/docs/ref/#view.MarkView), which allow you to render custom views for marks within the editor. This is useful for rendering custom UI for marks, like a color picker for a text color mark or a link editor for a link mark. + + Here is a plain JS markview example: + + ```ts + Mark.create({ + // Other options... + addMarkView() { + return ({ mark, HTMLAttributes }) => { + const dom = document.createElement('b') + const contentDOM = document.createElement('span') + + dom.appendChild(contentDOM) + + return { + dom, + contentDOM, + } + } + }, + }) + ``` + + ## React binding + + To use a React component for a markview, you can use the `@tiptap/react` package: + + ```ts + import { Mark } from '@tiptap/core' + import { ReactMarkViewRenderer } from '@tiptap/react' + + import Component from './Component.jsx' + + export default Mark.create({ + name: 'reactComponent', + + parseHTML() { + return [ + { + tag: 'react-component', + }, + ] + }, + + renderHTML({ HTMLAttributes }) { + return ['react-component', HTMLAttributes] + }, + + addMarkView() { + return ReactMarkViewRenderer(Component) + }, + }) + ``` + + And here is an example of a React component: + + ```tsx + import { MarkViewContent, MarkViewRendererProps } from '@tiptap/react' + import React from 'react' + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + export default (props: MarkViewRendererProps) => { + const [count, setCount] = React.useState(0) + + return ( + + + + + ) + } + ``` + + ## Vue 3 binding + + To use a Vue 3 component for a markview, you can use the `@tiptap/vue-3` package: + + ```ts + import { Mark } from '@tiptap/core' + import { VueMarkViewRenderer } from '@tiptap/vue-3' + + import Component from './Component.vue' + + export default Mark.create({ + name: 'vueComponent', + + parseHTML() { + return [ + { + tag: 'vue-component', + }, + ] + }, + + renderHTML({ HTMLAttributes }) { + return ['vue-component', HTMLAttributes] + }, + + addMarkView() { + return VueMarkViewRenderer(Component) + }, + }) + ``` + + And here is an example of a Vue 3 component: + + ```vue + + + + ``` + +- 28c5418: Adds a new `delete` event which can detect content which has been deleted by the editor as a core extension +- 704f462: This introduces a new behavior for the editor, the ability to be safely run on the server-side (without rendering). + + `prosemirror-view` encapsulates all view (& DOM) related code, and cannot safely be SSR'd, but, the majority of the editor instance itself is in plain JS that does not require DOM APIs (unless your content is specified in HTML). + + But, we have so many convenient methods available for manipulating content. So, it is a shame that they could not be used on the server side too. With this change, the editor can be rendered on the server-side and will use a stub for select prosemirror-view methods. If accessing unsupported methods or values on the `editor.view`, you will encounter runtime errors, so it is important for you to test to see if the methods you call actually work. + + This is a step towards being able to server-side render content, but, it is not completely supported yet. This does not mean that you can render an editor instance on the server and expect it to just output any HTML. + + ## Usage + + If you pass `element: null` to your editor options: + + - the `editor.view` will not be initialized + - the editor will not emit it's `'create'` event + - the focus will not be initialized to it's first position + + You can however, later use the new `mount` function on the instance, which will mount the editor view to a DOM element. This obviously will not be allowed on the server which has no document object. + + Therefore, this will work on the server: + + ```ts + import { Editor } from '@tiptap/core' + import StarterKit from '@tiptap/starter-kit' + + const editor = new Editor({ + element: null, + content: { type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Hello, World!' }] }] }, + extensions: [StarterKit], + }) + + editor + .chain() + .selectAll() + .setContent({ type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'XYZ' }] }] }) + .run() + + console.log(editor.state.doc.toJSON()) + // { type: 'doc', content: [ { type: 'paragraph', content: [ { type: 'text', text: 'XYZ' } ] } ] } + ``` + + Any of these things will not work on the server, and result in a runtime error: + + ```ts + import { Editor } from '@tiptap/core' + import StarterKit from '@tiptap/starter-kit' + + const editor = new Editor({ + // document will not be defined in a server environment + element: document.createElement('div'), + content: { type: 'doc', content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Hello, World!' }] }] }, + extensions: [StarterKit], + }) + + editor + .chain() + // focus is a command which depends on the editor-view, so it will not work in a server environment + .focus() + .run() + + console.log(editor.getHTML()) + // getHTML relies on the editor-view, so it will not work in a server environment + ``` + +- 32958d6: Extensions, Nodes and Marks no longer respect the deprecated `defaultOptions` config value + ## 3.0.0-next.4 ### Minor Changes diff --git a/packages/core/package.json b/packages/core/package.json index 99423aee42..6a68356693 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/core", "description": "headless rich text editor", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -51,7 +51,7 @@ "jsx-runtime" ], "devDependencies": { - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/pm": "^3.0.0-next.1" diff --git a/packages/extension-blockquote/CHANGELOG.md b/packages/extension-blockquote/CHANGELOG.md index 6b7dd61356..8dfecbf88d 100644 --- a/packages/extension-blockquote/CHANGELOG.md +++ b/packages/extension-blockquote/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-blockquote/package.json b/packages/extension-blockquote/package.json index d615f53ada..8f5f611530 100644 --- a/packages/extension-blockquote/package.json +++ b/packages/extension-blockquote/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-blockquote", "description": "blockquote extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-bold/CHANGELOG.md b/packages/extension-bold/CHANGELOG.md index 6c3d472ebb..3e85d112c8 100644 --- a/packages/extension-bold/CHANGELOG.md +++ b/packages/extension-bold/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-bold/package.json b/packages/extension-bold/package.json index 46b73644ad..da351d3af3 100644 --- a/packages/extension-bold/package.json +++ b/packages/extension-bold/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-bold", "description": "bold extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-bubble-menu/CHANGELOG.md b/packages/extension-bubble-menu/CHANGELOG.md index e7b2f5fc4e..81c78f1057 100644 --- a/packages/extension-bubble-menu/CHANGELOG.md +++ b/packages/extension-bubble-menu/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-bubble-menu/package.json b/packages/extension-bubble-menu/package.json index fb4d491f1c..c2366dc825 100644 --- a/packages/extension-bubble-menu/package.json +++ b/packages/extension-bubble-menu/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-bubble-menu", "description": "bubble-menu extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -37,8 +37,8 @@ }, "sideEffects": false, "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "dependencies": { "@floating-ui/dom": "^1.0.0" diff --git a/packages/extension-bullet-list/CHANGELOG.md b/packages/extension-bullet-list/CHANGELOG.md index f5210319a4..938e74068c 100644 --- a/packages/extension-bullet-list/CHANGELOG.md +++ b/packages/extension-bullet-list/CHANGELOG.md @@ -1,5 +1,162 @@ # Change Log +## 3.0.0-next.5 + +### Major Changes + +- 2c911d2: This adds all of the list packages to the `@tiptap/extension-list` package. + + ## ListKit + + The `ListKit` export allows configuring all list extensions with one extension, and is the recommended way of using the list extensions. + + ```ts + import { ListKit } from '@tiptap/extension-list' + + new Editor({ + extensions: [ + ListKit.configure({ + bulletList: { + HTMLAttributes: 'bullet-list', + }, + orderedList: { + HTMLAttributes: 'ordered-list', + }, + listItem: { + HTMLAttributes: 'list-item', + }, + taskList: { + HTMLAttributes: 'task-list', + }, + taskItem: { + HTMLAttributes: 'task-item', + }, + listKeymap: {}, + }), + ], + }) + ``` + + ## List repackaging + + Since we've moved the code out of the list extensions to the `@tiptap/extension-list` package, you can remove the following packages from your project: + + ```bash + npm uninstall @tiptap/extension-ordered-list @tiptap/extension-bullet-list @tiptap/extension-list-keymap @tiptap/extension-list-item @tiptap/extension-task-list + ``` + + And replace them with the new `@tiptap/extension-list` package: + + ```bash + npm install @tiptap/extension-list + ``` + + ## Want to use the extensions separately? + + For more control, you can also use the extensions separately. + + ### BulletList + + This extension adds a bullet list to the editor. + + Migrate from `@tiptap/extension-bullet-list` to `@tiptap/extension-list`: + + ```diff + - import BulletList from '@tiptap/extension-bullet-list' + + import { BulletList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { BulletList } from '@tiptap/extension-list' + ``` + + ### OrderedList + + This extension adds an ordered list to the editor. + + Migrate from `@tiptap/extension-ordered-list` to `@tiptap/extension-list`: + + ```diff + - import OrderedList from '@tiptap/extension-ordered-list' + + import { OrderedList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { OrderedList } from '@tiptap/extension-list' + ``` + + ### ListItem + + This extension adds a list item to the editor. + + Migrate from `@tiptap/extension-list-item` to `@tiptap/extension-list`: + + ```diff + - import ListItem from '@tiptap/extension-list-item' + + import { ListItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListItem } from '@tiptap/extension-list' + ``` + + ### TaskList + + This extension adds a task list to the editor. + + Migrate from `@tiptap/extension-task-list` to `@tiptap/extension-list`: + + ```diff + - import TaskList from '@tiptap/extension-task-list' + + import { TaskList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskList } from '@tiptap/extension-list' + ``` + + ### TaskItem + + This extension adds a task item to the editor. + + Migrate from `@tiptap/extension-task-item` to `@tiptap/extension-list`: + + ```diff + - import TaskItem from '@tiptap/extension-task-item' + + import { TaskItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskItem } from '@tiptap/extension-list' + ``` + + ### ListKeymap + + This extension adds better default keybindings for lists to the editor. + + Migrate from `@tiptap/extension-list-keymap` to `@tiptap/extension-list`: + + ```diff + - import ListKeymap from '@tiptap/extension-list-keymap' + + import { ListKeymap } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListKeymap } from '@tiptap/extension-list' + ``` + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-bullet-list/package.json b/packages/extension-bullet-list/package.json index f31f47ea85..574d69a456 100644 --- a/packages/extension-bullet-list/package.json +++ b/packages/extension-bullet-list/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-bullet-list", "description": "bullet list extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-list": "^3.0.0-next.4" + "@tiptap/extension-list": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-list": "^3.0.0-next.4" diff --git a/packages/extension-character-count/CHANGELOG.md b/packages/extension-character-count/CHANGELOG.md index 711a70833f..e43c76c2c3 100644 --- a/packages/extension-character-count/CHANGELOG.md +++ b/packages/extension-character-count/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-character-count/package.json b/packages/extension-character-count/package.json index 536b75dfd8..b4a70e98f3 100644 --- a/packages/extension-character-count/package.json +++ b/packages/extension-character-count/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-character-count", "description": "font family extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extensions": "^3.0.0-next.4" + "@tiptap/extensions": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extensions": "^3.0.0-next.3" diff --git a/packages/extension-code-block-lowlight/CHANGELOG.md b/packages/extension-code-block-lowlight/CHANGELOG.md index 9e0675580f..63aa2fa26e 100644 --- a/packages/extension-code-block-lowlight/CHANGELOG.md +++ b/packages/extension-code-block-lowlight/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-code-block-lowlight/package.json b/packages/extension-code-block-lowlight/package.json index 837c7296d1..1b6cf3c967 100644 --- a/packages/extension-code-block-lowlight/package.json +++ b/packages/extension-code-block-lowlight/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-code-block-lowlight", "description": "code block extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,9 +31,9 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/extension-code-block": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4", + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/extension-code-block": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5", "lowlight": "^3.3.0" }, "peerDependencies": { diff --git a/packages/extension-code-block/CHANGELOG.md b/packages/extension-code-block/CHANGELOG.md index c16acfb9bd..6686d3faf8 100644 --- a/packages/extension-code-block/CHANGELOG.md +++ b/packages/extension-code-block/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-code-block/package.json b/packages/extension-code-block/package.json index 3b92cc54bd..0a22cb1931 100644 --- a/packages/extension-code-block/package.json +++ b/packages/extension-code-block/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-code-block", "description": "code block extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,8 +31,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1", diff --git a/packages/extension-code/CHANGELOG.md b/packages/extension-code/CHANGELOG.md index 69d4c36257..5f72fd6045 100644 --- a/packages/extension-code/CHANGELOG.md +++ b/packages/extension-code/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-code/package.json b/packages/extension-code/package.json index 5c2280daa4..50e331dc4f 100644 --- a/packages/extension-code/package.json +++ b/packages/extension-code/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-code", "description": "code extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-collaboration-cursor/CHANGELOG.md b/packages/extension-collaboration-cursor/CHANGELOG.md index e77baf2c94..9d3e370ffe 100644 --- a/packages/extension-collaboration-cursor/CHANGELOG.md +++ b/packages/extension-collaboration-cursor/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## 3.0.0-next.5 + +### Major Changes + +- a33d20c: Replaced y-prosemirror with @tiptap/y-tiptap + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-collaboration-cursor/package.json b/packages/extension-collaboration-cursor/package.json index 13dd64c8b7..2eb098bc8c 100644 --- a/packages/extension-collaboration-cursor/package.json +++ b/packages/extension-collaboration-cursor/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-collaboration-cursor", "description": "collaboration cursor extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,8 +31,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4", + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5", "@tiptap/y-tiptap": "^1.0.0" }, "peerDependencies": { diff --git a/packages/extension-collaboration/CHANGELOG.md b/packages/extension-collaboration/CHANGELOG.md index 28e531db61..db4deba044 100644 --- a/packages/extension-collaboration/CHANGELOG.md +++ b/packages/extension-collaboration/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## 3.0.0-next.5 + +### Major Changes + +- a33d20c: Replaced y-prosemirror with @tiptap/y-tiptap + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-collaboration/package.json b/packages/extension-collaboration/package.json index 3eede27a1c..87aee447a1 100644 --- a/packages/extension-collaboration/package.json +++ b/packages/extension-collaboration/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-collaboration", "description": "collaboration extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,8 +31,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4", + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5", "@tiptap/y-tiptap": "^1.0.0" }, "peerDependencies": { diff --git a/packages/extension-color/CHANGELOG.md b/packages/extension-color/CHANGELOG.md index 89296a5077..20dfedb90e 100644 --- a/packages/extension-color/CHANGELOG.md +++ b/packages/extension-color/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-color/package.json b/packages/extension-color/package.json index 4eee69a9c3..a949ce2067 100644 --- a/packages/extension-color/package.json +++ b/packages/extension-color/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-color", "description": "text color extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-text-style": "^3.0.0-next.4" + "@tiptap/extension-text-style": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-text-style": "^3.0.0-next.1" diff --git a/packages/extension-document/CHANGELOG.md b/packages/extension-document/CHANGELOG.md index d91f98a75e..28af1053b3 100644 --- a/packages/extension-document/CHANGELOG.md +++ b/packages/extension-document/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-document/package.json b/packages/extension-document/package.json index 094b7effac..9988372652 100644 --- a/packages/extension-document/package.json +++ b/packages/extension-document/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-document", "description": "document extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-dropcursor/CHANGELOG.md b/packages/extension-dropcursor/CHANGELOG.md index 01c8150fba..7b1aff2185 100644 --- a/packages/extension-dropcursor/CHANGELOG.md +++ b/packages/extension-dropcursor/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-dropcursor/package.json b/packages/extension-dropcursor/package.json index b8965ff188..68f6b7ef73 100644 --- a/packages/extension-dropcursor/package.json +++ b/packages/extension-dropcursor/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-dropcursor", "description": "dropcursor extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extensions": "^3.0.0-next.4" + "@tiptap/extensions": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extensions": "^3.0.0-next.3" diff --git a/packages/extension-floating-menu/CHANGELOG.md b/packages/extension-floating-menu/CHANGELOG.md index 4ce08d4968..190e8d7ea2 100644 --- a/packages/extension-floating-menu/CHANGELOG.md +++ b/packages/extension-floating-menu/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-floating-menu/package.json b/packages/extension-floating-menu/package.json index 413d02fddf..373a7391bd 100644 --- a/packages/extension-floating-menu/package.json +++ b/packages/extension-floating-menu/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-floating-menu", "description": "floating-menu extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -32,8 +32,8 @@ ], "devDependencies": { "@floating-ui/dom": "^1.6.12", - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@floating-ui/dom": "^1.0.0", diff --git a/packages/extension-focus/CHANGELOG.md b/packages/extension-focus/CHANGELOG.md index 0ea6ed4ca1..8b83d4f308 100644 --- a/packages/extension-focus/CHANGELOG.md +++ b/packages/extension-focus/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## 3.0.0-next.5 + +### Patch Changes + +- @tiptap/extensions@3.0.0-next.5 + ## 3.0.0-next.4 ### Patch Changes diff --git a/packages/extension-focus/package.json b/packages/extension-focus/package.json index 21813e9e4d..5e058f6203 100644 --- a/packages/extension-focus/package.json +++ b/packages/extension-focus/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-focus", "description": "focus extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,10 +31,10 @@ "dist" ], "devDependencies": { - "@tiptap/extensions": "3.0.0-next.4" + "@tiptap/extensions": "3.0.0-next.5" }, "peerDependencies": { - "@tiptap/extensions": "3.0.0-next.4" + "@tiptap/extensions": "3.0.0-next.5" }, "repository": { "type": "git", diff --git a/packages/extension-font-family/CHANGELOG.md b/packages/extension-font-family/CHANGELOG.md index c24e3406cc..5a231e0940 100644 --- a/packages/extension-font-family/CHANGELOG.md +++ b/packages/extension-font-family/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-font-family/package.json b/packages/extension-font-family/package.json index d19ca7ab35..681e6d4365 100644 --- a/packages/extension-font-family/package.json +++ b/packages/extension-font-family/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-font-family", "description": "font family extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-text-style": "^3.0.0-next.4" + "@tiptap/extension-text-style": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-text-style": "^3.0.0-next.3" diff --git a/packages/extension-gapcursor/CHANGELOG.md b/packages/extension-gapcursor/CHANGELOG.md index d716af34b3..2be64053d6 100644 --- a/packages/extension-gapcursor/CHANGELOG.md +++ b/packages/extension-gapcursor/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-gapcursor/package.json b/packages/extension-gapcursor/package.json index 4677fca213..1b1b72da8c 100644 --- a/packages/extension-gapcursor/package.json +++ b/packages/extension-gapcursor/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-gapcursor", "description": "gapcursor extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extensions": "^3.0.0-next.4" + "@tiptap/extensions": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extensions": "^3.0.0-next.3" diff --git a/packages/extension-hard-break/CHANGELOG.md b/packages/extension-hard-break/CHANGELOG.md index 3541abdb19..2c64886b84 100644 --- a/packages/extension-hard-break/CHANGELOG.md +++ b/packages/extension-hard-break/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-hard-break/package.json b/packages/extension-hard-break/package.json index a4917d698b..a3e8c6d53f 100644 --- a/packages/extension-hard-break/package.json +++ b/packages/extension-hard-break/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-hard-break", "description": "hard break extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-heading/CHANGELOG.md b/packages/extension-heading/CHANGELOG.md index 87c676f84b..f956133036 100644 --- a/packages/extension-heading/CHANGELOG.md +++ b/packages/extension-heading/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-heading/package.json b/packages/extension-heading/package.json index 3c3b05f8a7..4cc4d84548 100644 --- a/packages/extension-heading/package.json +++ b/packages/extension-heading/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-heading", "description": "heading extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-highlight/CHANGELOG.md b/packages/extension-highlight/CHANGELOG.md index 97b14b6dcf..2e8a365570 100644 --- a/packages/extension-highlight/CHANGELOG.md +++ b/packages/extension-highlight/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-highlight/package.json b/packages/extension-highlight/package.json index 38babea31c..731cf1bb52 100644 --- a/packages/extension-highlight/package.json +++ b/packages/extension-highlight/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-highlight", "description": "highlight extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-history/CHANGELOG.md b/packages/extension-history/CHANGELOG.md index c32967550e..90a653e40d 100644 --- a/packages/extension-history/CHANGELOG.md +++ b/packages/extension-history/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-history/package.json b/packages/extension-history/package.json index 257d39a5c2..44d92be35d 100644 --- a/packages/extension-history/package.json +++ b/packages/extension-history/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-history", "description": "history extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extensions": "^3.0.0-next.4" + "@tiptap/extensions": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extensions": "^3.0.0-next.3" diff --git a/packages/extension-horizontal-rule/CHANGELOG.md b/packages/extension-horizontal-rule/CHANGELOG.md index 295ad88ed1..1e67e38f28 100644 --- a/packages/extension-horizontal-rule/CHANGELOG.md +++ b/packages/extension-horizontal-rule/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-horizontal-rule/package.json b/packages/extension-horizontal-rule/package.json index 231403caf7..96663deb56 100644 --- a/packages/extension-horizontal-rule/package.json +++ b/packages/extension-horizontal-rule/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-horizontal-rule", "description": "horizontal rule extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,8 +31,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1", diff --git a/packages/extension-image/CHANGELOG.md b/packages/extension-image/CHANGELOG.md index 6cdfce0d40..11d8ab1fa6 100644 --- a/packages/extension-image/CHANGELOG.md +++ b/packages/extension-image/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-image/package.json b/packages/extension-image/package.json index 00c2e4401e..a922eda22d 100644 --- a/packages/extension-image/package.json +++ b/packages/extension-image/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-image", "description": "image extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-italic/CHANGELOG.md b/packages/extension-italic/CHANGELOG.md index 031d7db685..eabcee2772 100644 --- a/packages/extension-italic/CHANGELOG.md +++ b/packages/extension-italic/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-italic/package.json b/packages/extension-italic/package.json index 154316108d..1f68c662fc 100644 --- a/packages/extension-italic/package.json +++ b/packages/extension-italic/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-italic", "description": "italic extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-link/CHANGELOG.md b/packages/extension-link/CHANGELOG.md index 418055bd4d..53ba7d5bb7 100644 --- a/packages/extension-link/CHANGELOG.md +++ b/packages/extension-link/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-link/package.json b/packages/extension-link/package.json index 5132aa9d26..ddfb5e9ef6 100644 --- a/packages/extension-link/package.json +++ b/packages/extension-link/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-link", "description": "link extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -34,8 +34,8 @@ "linkifyjs": "^4.2.0" }, "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1", diff --git a/packages/extension-list-item/CHANGELOG.md b/packages/extension-list-item/CHANGELOG.md index 6bb8a7e1cb..ec169ee576 100644 --- a/packages/extension-list-item/CHANGELOG.md +++ b/packages/extension-list-item/CHANGELOG.md @@ -1,5 +1,162 @@ # Change Log +## 3.0.0-next.5 + +### Major Changes + +- 2c911d2: This adds all of the list packages to the `@tiptap/extension-list` package. + + ## ListKit + + The `ListKit` export allows configuring all list extensions with one extension, and is the recommended way of using the list extensions. + + ```ts + import { ListKit } from '@tiptap/extension-list' + + new Editor({ + extensions: [ + ListKit.configure({ + bulletList: { + HTMLAttributes: 'bullet-list', + }, + orderedList: { + HTMLAttributes: 'ordered-list', + }, + listItem: { + HTMLAttributes: 'list-item', + }, + taskList: { + HTMLAttributes: 'task-list', + }, + taskItem: { + HTMLAttributes: 'task-item', + }, + listKeymap: {}, + }), + ], + }) + ``` + + ## List repackaging + + Since we've moved the code out of the list extensions to the `@tiptap/extension-list` package, you can remove the following packages from your project: + + ```bash + npm uninstall @tiptap/extension-ordered-list @tiptap/extension-bullet-list @tiptap/extension-list-keymap @tiptap/extension-list-item @tiptap/extension-task-list + ``` + + And replace them with the new `@tiptap/extension-list` package: + + ```bash + npm install @tiptap/extension-list + ``` + + ## Want to use the extensions separately? + + For more control, you can also use the extensions separately. + + ### BulletList + + This extension adds a bullet list to the editor. + + Migrate from `@tiptap/extension-bullet-list` to `@tiptap/extension-list`: + + ```diff + - import BulletList from '@tiptap/extension-bullet-list' + + import { BulletList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { BulletList } from '@tiptap/extension-list' + ``` + + ### OrderedList + + This extension adds an ordered list to the editor. + + Migrate from `@tiptap/extension-ordered-list` to `@tiptap/extension-list`: + + ```diff + - import OrderedList from '@tiptap/extension-ordered-list' + + import { OrderedList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { OrderedList } from '@tiptap/extension-list' + ``` + + ### ListItem + + This extension adds a list item to the editor. + + Migrate from `@tiptap/extension-list-item` to `@tiptap/extension-list`: + + ```diff + - import ListItem from '@tiptap/extension-list-item' + + import { ListItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListItem } from '@tiptap/extension-list' + ``` + + ### TaskList + + This extension adds a task list to the editor. + + Migrate from `@tiptap/extension-task-list` to `@tiptap/extension-list`: + + ```diff + - import TaskList from '@tiptap/extension-task-list' + + import { TaskList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskList } from '@tiptap/extension-list' + ``` + + ### TaskItem + + This extension adds a task item to the editor. + + Migrate from `@tiptap/extension-task-item` to `@tiptap/extension-list`: + + ```diff + - import TaskItem from '@tiptap/extension-task-item' + + import { TaskItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskItem } from '@tiptap/extension-list' + ``` + + ### ListKeymap + + This extension adds better default keybindings for lists to the editor. + + Migrate from `@tiptap/extension-list-keymap` to `@tiptap/extension-list`: + + ```diff + - import ListKeymap from '@tiptap/extension-list-keymap' + + import { ListKeymap } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListKeymap } from '@tiptap/extension-list' + ``` + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-list-item/package.json b/packages/extension-list-item/package.json index 0e5783e694..386d45f4c4 100644 --- a/packages/extension-list-item/package.json +++ b/packages/extension-list-item/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-list-item", "description": "list item extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-list": "^3.0.0-next.4" + "@tiptap/extension-list": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-list": "^3.0.0-next.4" diff --git a/packages/extension-list-keymap/CHANGELOG.md b/packages/extension-list-keymap/CHANGELOG.md index 1541a4b1d9..24ba59a6f9 100644 --- a/packages/extension-list-keymap/CHANGELOG.md +++ b/packages/extension-list-keymap/CHANGELOG.md @@ -1,5 +1,162 @@ # Change Log +## 3.0.0-next.5 + +### Major Changes + +- 2c911d2: This adds all of the list packages to the `@tiptap/extension-list` package. + + ## ListKit + + The `ListKit` export allows configuring all list extensions with one extension, and is the recommended way of using the list extensions. + + ```ts + import { ListKit } from '@tiptap/extension-list' + + new Editor({ + extensions: [ + ListKit.configure({ + bulletList: { + HTMLAttributes: 'bullet-list', + }, + orderedList: { + HTMLAttributes: 'ordered-list', + }, + listItem: { + HTMLAttributes: 'list-item', + }, + taskList: { + HTMLAttributes: 'task-list', + }, + taskItem: { + HTMLAttributes: 'task-item', + }, + listKeymap: {}, + }), + ], + }) + ``` + + ## List repackaging + + Since we've moved the code out of the list extensions to the `@tiptap/extension-list` package, you can remove the following packages from your project: + + ```bash + npm uninstall @tiptap/extension-ordered-list @tiptap/extension-bullet-list @tiptap/extension-list-keymap @tiptap/extension-list-item @tiptap/extension-task-list + ``` + + And replace them with the new `@tiptap/extension-list` package: + + ```bash + npm install @tiptap/extension-list + ``` + + ## Want to use the extensions separately? + + For more control, you can also use the extensions separately. + + ### BulletList + + This extension adds a bullet list to the editor. + + Migrate from `@tiptap/extension-bullet-list` to `@tiptap/extension-list`: + + ```diff + - import BulletList from '@tiptap/extension-bullet-list' + + import { BulletList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { BulletList } from '@tiptap/extension-list' + ``` + + ### OrderedList + + This extension adds an ordered list to the editor. + + Migrate from `@tiptap/extension-ordered-list` to `@tiptap/extension-list`: + + ```diff + - import OrderedList from '@tiptap/extension-ordered-list' + + import { OrderedList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { OrderedList } from '@tiptap/extension-list' + ``` + + ### ListItem + + This extension adds a list item to the editor. + + Migrate from `@tiptap/extension-list-item` to `@tiptap/extension-list`: + + ```diff + - import ListItem from '@tiptap/extension-list-item' + + import { ListItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListItem } from '@tiptap/extension-list' + ``` + + ### TaskList + + This extension adds a task list to the editor. + + Migrate from `@tiptap/extension-task-list` to `@tiptap/extension-list`: + + ```diff + - import TaskList from '@tiptap/extension-task-list' + + import { TaskList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskList } from '@tiptap/extension-list' + ``` + + ### TaskItem + + This extension adds a task item to the editor. + + Migrate from `@tiptap/extension-task-item` to `@tiptap/extension-list`: + + ```diff + - import TaskItem from '@tiptap/extension-task-item' + + import { TaskItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskItem } from '@tiptap/extension-list' + ``` + + ### ListKeymap + + This extension adds better default keybindings for lists to the editor. + + Migrate from `@tiptap/extension-list-keymap` to `@tiptap/extension-list`: + + ```diff + - import ListKeymap from '@tiptap/extension-list-keymap' + + import { ListKeymap } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListKeymap } from '@tiptap/extension-list' + ``` + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-list-keymap/package.json b/packages/extension-list-keymap/package.json index bcaabf09fa..c0c96bee04 100644 --- a/packages/extension-list-keymap/package.json +++ b/packages/extension-list-keymap/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-list-keymap", "description": "list keymap extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-list": "^3.0.0-next.4" + "@tiptap/extension-list": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-list": "^3.0.0-next.4" diff --git a/packages/extension-list/CHANGELOG.md b/packages/extension-list/CHANGELOG.md index 420e6f23d0..1a6b3c5867 100644 --- a/packages/extension-list/CHANGELOG.md +++ b/packages/extension-list/CHANGELOG.md @@ -1 +1,3 @@ # Change Log + +## 3.0.0-next.5 diff --git a/packages/extension-list/package.json b/packages/extension-list/package.json index b746438af7..26c1b3e852 100644 --- a/packages/extension-list/package.json +++ b/packages/extension-list/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-list", "description": "List extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -87,8 +87,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.4", diff --git a/packages/extension-mention/CHANGELOG.md b/packages/extension-mention/CHANGELOG.md index 2bdff7ea8b..50936c59d4 100644 --- a/packages/extension-mention/CHANGELOG.md +++ b/packages/extension-mention/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-mention/package.json b/packages/extension-mention/package.json index 8b4d20c3b4..bfd51f1b2a 100644 --- a/packages/extension-mention/package.json +++ b/packages/extension-mention/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-mention", "description": "mention extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,9 +31,9 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4", - "@tiptap/suggestion": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5", + "@tiptap/suggestion": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1", diff --git a/packages/extension-ordered-list/CHANGELOG.md b/packages/extension-ordered-list/CHANGELOG.md index 85d4f436e8..141e22ffd1 100644 --- a/packages/extension-ordered-list/CHANGELOG.md +++ b/packages/extension-ordered-list/CHANGELOG.md @@ -1,5 +1,162 @@ # Change Log +## 3.0.0-next.5 + +### Major Changes + +- 2c911d2: This adds all of the list packages to the `@tiptap/extension-list` package. + + ## ListKit + + The `ListKit` export allows configuring all list extensions with one extension, and is the recommended way of using the list extensions. + + ```ts + import { ListKit } from '@tiptap/extension-list' + + new Editor({ + extensions: [ + ListKit.configure({ + bulletList: { + HTMLAttributes: 'bullet-list', + }, + orderedList: { + HTMLAttributes: 'ordered-list', + }, + listItem: { + HTMLAttributes: 'list-item', + }, + taskList: { + HTMLAttributes: 'task-list', + }, + taskItem: { + HTMLAttributes: 'task-item', + }, + listKeymap: {}, + }), + ], + }) + ``` + + ## List repackaging + + Since we've moved the code out of the list extensions to the `@tiptap/extension-list` package, you can remove the following packages from your project: + + ```bash + npm uninstall @tiptap/extension-ordered-list @tiptap/extension-bullet-list @tiptap/extension-list-keymap @tiptap/extension-list-item @tiptap/extension-task-list + ``` + + And replace them with the new `@tiptap/extension-list` package: + + ```bash + npm install @tiptap/extension-list + ``` + + ## Want to use the extensions separately? + + For more control, you can also use the extensions separately. + + ### BulletList + + This extension adds a bullet list to the editor. + + Migrate from `@tiptap/extension-bullet-list` to `@tiptap/extension-list`: + + ```diff + - import BulletList from '@tiptap/extension-bullet-list' + + import { BulletList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { BulletList } from '@tiptap/extension-list' + ``` + + ### OrderedList + + This extension adds an ordered list to the editor. + + Migrate from `@tiptap/extension-ordered-list` to `@tiptap/extension-list`: + + ```diff + - import OrderedList from '@tiptap/extension-ordered-list' + + import { OrderedList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { OrderedList } from '@tiptap/extension-list' + ``` + + ### ListItem + + This extension adds a list item to the editor. + + Migrate from `@tiptap/extension-list-item` to `@tiptap/extension-list`: + + ```diff + - import ListItem from '@tiptap/extension-list-item' + + import { ListItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListItem } from '@tiptap/extension-list' + ``` + + ### TaskList + + This extension adds a task list to the editor. + + Migrate from `@tiptap/extension-task-list` to `@tiptap/extension-list`: + + ```diff + - import TaskList from '@tiptap/extension-task-list' + + import { TaskList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskList } from '@tiptap/extension-list' + ``` + + ### TaskItem + + This extension adds a task item to the editor. + + Migrate from `@tiptap/extension-task-item` to `@tiptap/extension-list`: + + ```diff + - import TaskItem from '@tiptap/extension-task-item' + + import { TaskItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskItem } from '@tiptap/extension-list' + ``` + + ### ListKeymap + + This extension adds better default keybindings for lists to the editor. + + Migrate from `@tiptap/extension-list-keymap` to `@tiptap/extension-list`: + + ```diff + - import ListKeymap from '@tiptap/extension-list-keymap' + + import { ListKeymap } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListKeymap } from '@tiptap/extension-list' + ``` + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-ordered-list/package.json b/packages/extension-ordered-list/package.json index c1944451f4..0560e7f4b1 100644 --- a/packages/extension-ordered-list/package.json +++ b/packages/extension-ordered-list/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-ordered-list", "description": "ordered list extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-list": "^3.0.0-next.4" + "@tiptap/extension-list": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-list": "^3.0.0-next.4" diff --git a/packages/extension-paragraph/CHANGELOG.md b/packages/extension-paragraph/CHANGELOG.md index 5d4a850064..b1974e70d4 100644 --- a/packages/extension-paragraph/CHANGELOG.md +++ b/packages/extension-paragraph/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-paragraph/package.json b/packages/extension-paragraph/package.json index 0dea1cb9d5..9b5be6dde5 100644 --- a/packages/extension-paragraph/package.json +++ b/packages/extension-paragraph/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-paragraph", "description": "paragraph extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-placeholder/CHANGELOG.md b/packages/extension-placeholder/CHANGELOG.md index de8697e13d..fd6e78661e 100644 --- a/packages/extension-placeholder/CHANGELOG.md +++ b/packages/extension-placeholder/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-placeholder/package.json b/packages/extension-placeholder/package.json index 239513e21f..68034741fe 100644 --- a/packages/extension-placeholder/package.json +++ b/packages/extension-placeholder/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-placeholder", "description": "placeholder extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extensions": "^3.0.0-next.4" + "@tiptap/extensions": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extensions": "^3.0.0-next.3" diff --git a/packages/extension-strike/CHANGELOG.md b/packages/extension-strike/CHANGELOG.md index 4e0551dee4..a415fb3170 100644 --- a/packages/extension-strike/CHANGELOG.md +++ b/packages/extension-strike/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-strike/package.json b/packages/extension-strike/package.json index 740b9366f6..39eaebdaed 100644 --- a/packages/extension-strike/package.json +++ b/packages/extension-strike/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-strike", "description": "strike extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-subscript/CHANGELOG.md b/packages/extension-subscript/CHANGELOG.md index 7f230f5ead..f27ccf5e53 100644 --- a/packages/extension-subscript/CHANGELOG.md +++ b/packages/extension-subscript/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-subscript/package.json b/packages/extension-subscript/package.json index 674b5477ed..a860c31618 100644 --- a/packages/extension-subscript/package.json +++ b/packages/extension-subscript/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-subscript", "description": "subscript extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,8 +31,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.3", diff --git a/packages/extension-superscript/CHANGELOG.md b/packages/extension-superscript/CHANGELOG.md index 58dea549eb..9263d43bcb 100644 --- a/packages/extension-superscript/CHANGELOG.md +++ b/packages/extension-superscript/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-superscript/package.json b/packages/extension-superscript/package.json index 9efce9a0af..334c26b463 100644 --- a/packages/extension-superscript/package.json +++ b/packages/extension-superscript/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-superscript", "description": "superscript extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,8 +31,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.3", diff --git a/packages/extension-table-cell/CHANGELOG.md b/packages/extension-table-cell/CHANGELOG.md index 75d2af9cf5..c922529440 100644 --- a/packages/extension-table-cell/CHANGELOG.md +++ b/packages/extension-table-cell/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ### Minor Changes diff --git a/packages/extension-table-cell/package.json b/packages/extension-table-cell/package.json index c92c6111be..5a8a50edb1 100644 --- a/packages/extension-table-cell/package.json +++ b/packages/extension-table-cell/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-table-cell", "description": "table cell extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-table": "^3.0.0-next.4" + "@tiptap/extension-table": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-table": "^3.0.0-next.3" diff --git a/packages/extension-table-header/CHANGELOG.md b/packages/extension-table-header/CHANGELOG.md index 90b65a4989..291961df0d 100644 --- a/packages/extension-table-header/CHANGELOG.md +++ b/packages/extension-table-header/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ### Minor Changes diff --git a/packages/extension-table-header/package.json b/packages/extension-table-header/package.json index e3d7db8b0f..0340241073 100644 --- a/packages/extension-table-header/package.json +++ b/packages/extension-table-header/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-table-header", "description": "table cell extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-table": "^3.0.0-next.4" + "@tiptap/extension-table": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-table": "^3.0.0-next.3" diff --git a/packages/extension-table-row/CHANGELOG.md b/packages/extension-table-row/CHANGELOG.md index 6c8531921a..8a992af274 100644 --- a/packages/extension-table-row/CHANGELOG.md +++ b/packages/extension-table-row/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ### Minor Changes diff --git a/packages/extension-table-row/package.json b/packages/extension-table-row/package.json index 9087553a4f..e856ecac52 100644 --- a/packages/extension-table-row/package.json +++ b/packages/extension-table-row/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-table-row", "description": "table row extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-table": "^3.0.0-next.4" + "@tiptap/extension-table": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-table": "^3.0.0-next.3" diff --git a/packages/extension-table/CHANGELOG.md b/packages/extension-table/CHANGELOG.md index b0494cc0fc..ab7756be3c 100644 --- a/packages/extension-table/CHANGELOG.md +++ b/packages/extension-table/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ### Minor Changes diff --git a/packages/extension-table/package.json b/packages/extension-table/package.json index 0c3d6eaa5c..32e725e707 100644 --- a/packages/extension-table/package.json +++ b/packages/extension-table/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-table", "description": "table extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -71,8 +71,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1", diff --git a/packages/extension-task-item/CHANGELOG.md b/packages/extension-task-item/CHANGELOG.md index d9f92e8e81..82062785d7 100644 --- a/packages/extension-task-item/CHANGELOG.md +++ b/packages/extension-task-item/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-task-item/package.json b/packages/extension-task-item/package.json index 833b6e3227..9da245db65 100644 --- a/packages/extension-task-item/package.json +++ b/packages/extension-task-item/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-task-item", "description": "task item extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-list": "^3.0.0-next.4" + "@tiptap/extension-list": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-list": "^3.0.0-next.4" diff --git a/packages/extension-task-list/CHANGELOG.md b/packages/extension-task-list/CHANGELOG.md index bfbcac55e2..eb806b9675 100644 --- a/packages/extension-task-list/CHANGELOG.md +++ b/packages/extension-task-list/CHANGELOG.md @@ -1,5 +1,162 @@ # Change Log +## 3.0.0-next.5 + +### Major Changes + +- 2c911d2: This adds all of the list packages to the `@tiptap/extension-list` package. + + ## ListKit + + The `ListKit` export allows configuring all list extensions with one extension, and is the recommended way of using the list extensions. + + ```ts + import { ListKit } from '@tiptap/extension-list' + + new Editor({ + extensions: [ + ListKit.configure({ + bulletList: { + HTMLAttributes: 'bullet-list', + }, + orderedList: { + HTMLAttributes: 'ordered-list', + }, + listItem: { + HTMLAttributes: 'list-item', + }, + taskList: { + HTMLAttributes: 'task-list', + }, + taskItem: { + HTMLAttributes: 'task-item', + }, + listKeymap: {}, + }), + ], + }) + ``` + + ## List repackaging + + Since we've moved the code out of the list extensions to the `@tiptap/extension-list` package, you can remove the following packages from your project: + + ```bash + npm uninstall @tiptap/extension-ordered-list @tiptap/extension-bullet-list @tiptap/extension-list-keymap @tiptap/extension-list-item @tiptap/extension-task-list + ``` + + And replace them with the new `@tiptap/extension-list` package: + + ```bash + npm install @tiptap/extension-list + ``` + + ## Want to use the extensions separately? + + For more control, you can also use the extensions separately. + + ### BulletList + + This extension adds a bullet list to the editor. + + Migrate from `@tiptap/extension-bullet-list` to `@tiptap/extension-list`: + + ```diff + - import BulletList from '@tiptap/extension-bullet-list' + + import { BulletList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { BulletList } from '@tiptap/extension-list' + ``` + + ### OrderedList + + This extension adds an ordered list to the editor. + + Migrate from `@tiptap/extension-ordered-list` to `@tiptap/extension-list`: + + ```diff + - import OrderedList from '@tiptap/extension-ordered-list' + + import { OrderedList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { OrderedList } from '@tiptap/extension-list' + ``` + + ### ListItem + + This extension adds a list item to the editor. + + Migrate from `@tiptap/extension-list-item` to `@tiptap/extension-list`: + + ```diff + - import ListItem from '@tiptap/extension-list-item' + + import { ListItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListItem } from '@tiptap/extension-list' + ``` + + ### TaskList + + This extension adds a task list to the editor. + + Migrate from `@tiptap/extension-task-list` to `@tiptap/extension-list`: + + ```diff + - import TaskList from '@tiptap/extension-task-list' + + import { TaskList } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskList } from '@tiptap/extension-list' + ``` + + ### TaskItem + + This extension adds a task item to the editor. + + Migrate from `@tiptap/extension-task-item` to `@tiptap/extension-list`: + + ```diff + - import TaskItem from '@tiptap/extension-task-item' + + import { TaskItem } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { TaskItem } from '@tiptap/extension-list' + ``` + + ### ListKeymap + + This extension adds better default keybindings for lists to the editor. + + Migrate from `@tiptap/extension-list-keymap` to `@tiptap/extension-list`: + + ```diff + - import ListKeymap from '@tiptap/extension-list-keymap' + + import { ListKeymap } from '@tiptap/extension-list' + ``` + + Usage: + + ```ts + import { ListKeymap } from '@tiptap/extension-list' + ``` + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-task-list/package.json b/packages/extension-task-list/package.json index c2c62567b1..f3c3ecfed8 100644 --- a/packages/extension-task-list/package.json +++ b/packages/extension-task-list/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-task-list", "description": "task list extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/extension-list": "^3.0.0-next.4" + "@tiptap/extension-list": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/extension-list": "^3.0.0-next.4" diff --git a/packages/extension-text-align/CHANGELOG.md b/packages/extension-text-align/CHANGELOG.md index a22eebbdb3..7c32ae6fbe 100644 --- a/packages/extension-text-align/CHANGELOG.md +++ b/packages/extension-text-align/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-text-align/package.json b/packages/extension-text-align/package.json index fa16eff661..151d97d5eb 100644 --- a/packages/extension-text-align/package.json +++ b/packages/extension-text-align/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-text-align", "description": "text align extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-text-style/CHANGELOG.md b/packages/extension-text-style/CHANGELOG.md index 643bae3915..e835645d58 100644 --- a/packages/extension-text-style/CHANGELOG.md +++ b/packages/extension-text-style/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## 3.0.0-next.5 + +### Minor Changes + +- f77cbac: This updates the default value of the option `mergeNestedSpanStyles` to `true`, this will attempt to merge the styles of nested spans into the child span during HTML parsing. This prioritizes the style of the child span. This is used when parsing content created in other editors. (Fix for ProseMirror's default behavior.) + ## 3.0.0-next.4 ### Minor Changes diff --git a/packages/extension-text-style/package.json b/packages/extension-text-style/package.json index 3ce0c4d1c9..75ab1cdd82 100644 --- a/packages/extension-text-style/package.json +++ b/packages/extension-text-style/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-text-style", "description": "text style extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -87,7 +87,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-text/CHANGELOG.md b/packages/extension-text/CHANGELOG.md index 7ce1ac7ccc..cf96d6ad9b 100644 --- a/packages/extension-text/CHANGELOG.md +++ b/packages/extension-text/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-text/package.json b/packages/extension-text/package.json index 23964be7db..4b0be6dc07 100644 --- a/packages/extension-text/package.json +++ b/packages/extension-text/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-text", "description": "text extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-typography/CHANGELOG.md b/packages/extension-typography/CHANGELOG.md index 5c0ea3c9cb..e9227a6c98 100644 --- a/packages/extension-typography/CHANGELOG.md +++ b/packages/extension-typography/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-typography/package.json b/packages/extension-typography/package.json index bf18196e4c..0bcf6931a9 100644 --- a/packages/extension-typography/package.json +++ b/packages/extension-typography/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-typography", "description": "typography extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-underline/CHANGELOG.md b/packages/extension-underline/CHANGELOG.md index 3f57b3f19b..4ba705697e 100644 --- a/packages/extension-underline/CHANGELOG.md +++ b/packages/extension-underline/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-underline/package.json b/packages/extension-underline/package.json index be813cc6e6..02435baea4 100644 --- a/packages/extension-underline/package.json +++ b/packages/extension-underline/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-underline", "description": "underline extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extension-youtube/CHANGELOG.md b/packages/extension-youtube/CHANGELOG.md index 4e710a5881..d9e2af350d 100644 --- a/packages/extension-youtube/CHANGELOG.md +++ b/packages/extension-youtube/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/extension-youtube/package.json b/packages/extension-youtube/package.json index dac2f07368..f39a252aa5 100644 --- a/packages/extension-youtube/package.json +++ b/packages/extension-youtube/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extension-youtube", "description": "a youtube embed extension for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,7 +31,7 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1" diff --git a/packages/extensions/CHANGELOG.md b/packages/extensions/CHANGELOG.md index 9046551e86..fcc18b5e01 100644 --- a/packages/extensions/CHANGELOG.md +++ b/packages/extensions/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ### Major Changes diff --git a/packages/extensions/package.json b/packages/extensions/package.json index 661cd068c8..fc4b9ac3b2 100644 --- a/packages/extensions/package.json +++ b/packages/extensions/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/extensions", "description": "various extensions for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -95,8 +95,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.3", diff --git a/packages/html/CHANGELOG.md b/packages/html/CHANGELOG.md index cf1851c1c6..9e281461d7 100644 --- a/packages/html/CHANGELOG.md +++ b/packages/html/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ### Major Changes diff --git a/packages/html/package.json b/packages/html/package.json index bc36981aa6..d7b15ee487 100644 --- a/packages/html/package.json +++ b/packages/html/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/html", "description": "utility package to render tiptap JSON as HTML", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,8 +31,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1", diff --git a/packages/pm/CHANGELOG.md b/packages/pm/CHANGELOG.md index 33a0ce5364..b93f4e7b18 100644 --- a/packages/pm/CHANGELOG.md +++ b/packages/pm/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/pm/package.json b/packages/pm/package.json index 1014706b5f..88fb0cf836 100644 --- a/packages/pm/package.json +++ b/packages/pm/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/pm", "description": "prosemirror wrapper package for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md index dac518578e..1659202100 100644 --- a/packages/react/CHANGELOG.md +++ b/packages/react/CHANGELOG.md @@ -1,5 +1,156 @@ # Change Log +## 3.0.0-next.5 + +### Minor Changes + +- 0e3207f: Add support for [markviews](https://prosemirror.net/docs/ref/#view.MarkView), which allow you to render custom views for marks within the editor. This is useful for rendering custom UI for marks, like a color picker for a text color mark or a link editor for a link mark. + + Here is a plain JS markview example: + + ```ts + Mark.create({ + // Other options... + addMarkView() { + return ({ mark, HTMLAttributes }) => { + const dom = document.createElement('b') + const contentDOM = document.createElement('span') + + dom.appendChild(contentDOM) + + return { + dom, + contentDOM, + } + } + }, + }) + ``` + + ## React binding + + To use a React component for a markview, you can use the `@tiptap/react` package: + + ```ts + import { Mark } from '@tiptap/core' + import { ReactMarkViewRenderer } from '@tiptap/react' + + import Component from './Component.jsx' + + export default Mark.create({ + name: 'reactComponent', + + parseHTML() { + return [ + { + tag: 'react-component', + }, + ] + }, + + renderHTML({ HTMLAttributes }) { + return ['react-component', HTMLAttributes] + }, + + addMarkView() { + return ReactMarkViewRenderer(Component) + }, + }) + ``` + + And here is an example of a React component: + + ```tsx + import { MarkViewContent, MarkViewRendererProps } from '@tiptap/react' + import React from 'react' + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + export default (props: MarkViewRendererProps) => { + const [count, setCount] = React.useState(0) + + return ( + + + + + ) + } + ``` + + ## Vue 3 binding + + To use a Vue 3 component for a markview, you can use the `@tiptap/vue-3` package: + + ```ts + import { Mark } from '@tiptap/core' + import { VueMarkViewRenderer } from '@tiptap/vue-3' + + import Component from './Component.vue' + + export default Mark.create({ + name: 'vueComponent', + + parseHTML() { + return [ + { + tag: 'vue-component', + }, + ] + }, + + renderHTML({ HTMLAttributes }) { + return ['vue-component', HTMLAttributes] + }, + + addMarkView() { + return VueMarkViewRenderer(Component) + }, + }) + ``` + + And here is an example of a Vue 3 component: + + ```vue + + + + ``` + ## 3.0.0-next.4 ### Patch Changes diff --git a/packages/react/package.json b/packages/react/package.json index 798a98906a..0dd4ab089b 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/react", "description": "React components for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -44,16 +44,16 @@ "use-sync-external-store": "^1.4.0" }, "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4", + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5", "@types/react": "^18.3.18", "@types/react-dom": "^18.3.5", "react": "^18.3.1", "react-dom": "^18.3.1" }, "optionalDependencies": { - "@tiptap/extension-bubble-menu": "^3.0.0-next.4", - "@tiptap/extension-floating-menu": "^3.0.0-next.4" + "@tiptap/extension-bubble-menu": "^3.0.0-next.5", + "@tiptap/extension-floating-menu": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.4", diff --git a/packages/starter-kit/CHANGELOG.md b/packages/starter-kit/CHANGELOG.md index a40de8b139..e08afca7c3 100644 --- a/packages/starter-kit/CHANGELOG.md +++ b/packages/starter-kit/CHANGELOG.md @@ -1,5 +1,44 @@ # Change Log +## 3.0.0-next.5 + +### Patch Changes + +- Updated dependencies [0e3207f] +- Updated dependencies [28c5418] +- Updated dependencies [32958d6] +- Updated dependencies [062afaf] +- Updated dependencies [704f462] +- Updated dependencies [2c911d2] +- Updated dependencies [32958d6] +- Updated dependencies [062afaf] +- Updated dependencies [32958d6] +- Updated dependencies [32958d6] + - @tiptap/core@3.0.0-next.5 + - @tiptap/extension-ordered-list@3.0.0-next.5 + - @tiptap/extension-bullet-list@3.0.0-next.5 + - @tiptap/extension-list-keymap@3.0.0-next.5 + - @tiptap/extension-list-item@3.0.0-next.5 + - @tiptap/extension-blockquote@3.0.0-next.5 + - @tiptap/extension-bold@3.0.0-next.5 + - @tiptap/extension-code@3.0.0-next.5 + - @tiptap/extension-code-block@3.0.0-next.5 + - @tiptap/extension-document@3.0.0-next.5 + - @tiptap/extension-dropcursor@3.0.0-next.5 + - @tiptap/extension-gapcursor@3.0.0-next.5 + - @tiptap/extension-hard-break@3.0.0-next.5 + - @tiptap/extension-heading@3.0.0-next.5 + - @tiptap/extension-history@3.0.0-next.5 + - @tiptap/extension-horizontal-rule@3.0.0-next.5 + - @tiptap/extension-italic@3.0.0-next.5 + - @tiptap/extension-link@3.0.0-next.5 + - @tiptap/extension-paragraph@3.0.0-next.5 + - @tiptap/extension-strike@3.0.0-next.5 + - @tiptap/extension-text@3.0.0-next.5 + - @tiptap/extension-underline@3.0.0-next.5 + - @tiptap/extensions@3.0.0-next.5 + - @tiptap/pm@3.0.0-next.5 + ## 3.0.0-next.4 ### Patch Changes diff --git a/packages/starter-kit/package.json b/packages/starter-kit/package.json index 22b774b024..1e9bd4337d 100644 --- a/packages/starter-kit/package.json +++ b/packages/starter-kit/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/starter-kit", "description": "starter kit for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,30 +31,30 @@ "dist" ], "dependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/extension-blockquote": "^3.0.0-next.4", - "@tiptap/extension-bold": "^3.0.0-next.4", - "@tiptap/extension-bullet-list": "^3.0.0-next.4", - "@tiptap/extension-code": "^3.0.0-next.4", - "@tiptap/extension-code-block": "^3.0.0-next.4", - "@tiptap/extension-document": "^3.0.0-next.4", - "@tiptap/extension-dropcursor": "^3.0.0-next.4", - "@tiptap/extension-gapcursor": "^3.0.0-next.4", - "@tiptap/extension-hard-break": "^3.0.0-next.4", - "@tiptap/extension-heading": "^3.0.0-next.4", - "@tiptap/extension-history": "^3.0.0-next.4", - "@tiptap/extension-horizontal-rule": "^3.0.0-next.4", - "@tiptap/extension-italic": "^3.0.0-next.4", - "@tiptap/extension-link": "^3.0.0-next.4", - "@tiptap/extension-list-item": "^3.0.0-next.4", - "@tiptap/extension-list-keymap": "^3.0.0-next.4", - "@tiptap/extension-ordered-list": "^3.0.0-next.4", - "@tiptap/extension-paragraph": "^3.0.0-next.4", - "@tiptap/extension-strike": "^3.0.0-next.4", - "@tiptap/extension-text": "^3.0.0-next.4", - "@tiptap/extension-underline": "^3.0.0-next.4", - "@tiptap/extensions": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/extension-blockquote": "^3.0.0-next.5", + "@tiptap/extension-bold": "^3.0.0-next.5", + "@tiptap/extension-bullet-list": "^3.0.0-next.5", + "@tiptap/extension-code": "^3.0.0-next.5", + "@tiptap/extension-code-block": "^3.0.0-next.5", + "@tiptap/extension-document": "^3.0.0-next.5", + "@tiptap/extension-dropcursor": "^3.0.0-next.5", + "@tiptap/extension-gapcursor": "^3.0.0-next.5", + "@tiptap/extension-hard-break": "^3.0.0-next.5", + "@tiptap/extension-heading": "^3.0.0-next.5", + "@tiptap/extension-history": "^3.0.0-next.5", + "@tiptap/extension-horizontal-rule": "^3.0.0-next.5", + "@tiptap/extension-italic": "^3.0.0-next.5", + "@tiptap/extension-link": "^3.0.0-next.5", + "@tiptap/extension-list-item": "^3.0.0-next.5", + "@tiptap/extension-list-keymap": "^3.0.0-next.5", + "@tiptap/extension-ordered-list": "^3.0.0-next.5", + "@tiptap/extension-paragraph": "^3.0.0-next.5", + "@tiptap/extension-strike": "^3.0.0-next.5", + "@tiptap/extension-text": "^3.0.0-next.5", + "@tiptap/extension-underline": "^3.0.0-next.5", + "@tiptap/extensions": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "repository": { "type": "git", diff --git a/packages/static-renderer/CHANGELOG.md b/packages/static-renderer/CHANGELOG.md index db2ee867f4..9ff8520e8a 100644 --- a/packages/static-renderer/CHANGELOG.md +++ b/packages/static-renderer/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ### Major Changes diff --git a/packages/static-renderer/package.json b/packages/static-renderer/package.json index d3978a7a89..bdb3c52f15 100644 --- a/packages/static-renderer/package.json +++ b/packages/static-renderer/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/static-renderer", "description": "statically render Tiptap JSON", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -72,8 +72,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4", + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5", "@types/react": "^18.2.14", "@types/react-dom": "^18.2.6", "react": "^17.0.0 || ^18.0.0 || ^19.0.0", diff --git a/packages/suggestion/CHANGELOG.md b/packages/suggestion/CHANGELOG.md index 7be761173c..6d04b0faa0 100644 --- a/packages/suggestion/CHANGELOG.md +++ b/packages/suggestion/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ## 3.0.0-next.3 diff --git a/packages/suggestion/package.json b/packages/suggestion/package.json index 04ef376c73..f82e1fe6b5 100644 --- a/packages/suggestion/package.json +++ b/packages/suggestion/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/suggestion", "description": "suggestion plugin for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -31,8 +31,8 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4" + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.1", diff --git a/packages/vue-2/CHANGELOG.md b/packages/vue-2/CHANGELOG.md index e8f899d433..e26dfe7120 100644 --- a/packages/vue-2/CHANGELOG.md +++ b/packages/vue-2/CHANGELOG.md @@ -1,5 +1,7 @@ # Change Log +## 3.0.0-next.5 + ## 3.0.0-next.4 ### Patch Changes diff --git a/packages/vue-2/package.json b/packages/vue-2/package.json index e6b1dd2654..97553d0f90 100644 --- a/packages/vue-2/package.json +++ b/packages/vue-2/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/vue-2", "description": "Vue components for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -42,13 +42,13 @@ "vue-ts-types": "1.6.2" }, "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4", + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5", "vue": "^2.7.16" }, "optionalDependencies": { - "@tiptap/extension-bubble-menu": "^3.0.0-next.4", - "@tiptap/extension-floating-menu": "^3.0.0-next.4" + "@tiptap/extension-bubble-menu": "^3.0.0-next.5", + "@tiptap/extension-floating-menu": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.4", diff --git a/packages/vue-3/CHANGELOG.md b/packages/vue-3/CHANGELOG.md index 645ba38e9e..96d3557b4e 100644 --- a/packages/vue-3/CHANGELOG.md +++ b/packages/vue-3/CHANGELOG.md @@ -1,5 +1,156 @@ # Change Log +## 3.0.0-next.5 + +### Minor Changes + +- 0e3207f: Add support for [markviews](https://prosemirror.net/docs/ref/#view.MarkView), which allow you to render custom views for marks within the editor. This is useful for rendering custom UI for marks, like a color picker for a text color mark or a link editor for a link mark. + + Here is a plain JS markview example: + + ```ts + Mark.create({ + // Other options... + addMarkView() { + return ({ mark, HTMLAttributes }) => { + const dom = document.createElement('b') + const contentDOM = document.createElement('span') + + dom.appendChild(contentDOM) + + return { + dom, + contentDOM, + } + } + }, + }) + ``` + + ## React binding + + To use a React component for a markview, you can use the `@tiptap/react` package: + + ```ts + import { Mark } from '@tiptap/core' + import { ReactMarkViewRenderer } from '@tiptap/react' + + import Component from './Component.jsx' + + export default Mark.create({ + name: 'reactComponent', + + parseHTML() { + return [ + { + tag: 'react-component', + }, + ] + }, + + renderHTML({ HTMLAttributes }) { + return ['react-component', HTMLAttributes] + }, + + addMarkView() { + return ReactMarkViewRenderer(Component) + }, + }) + ``` + + And here is an example of a React component: + + ```tsx + import { MarkViewContent, MarkViewRendererProps } from '@tiptap/react' + import React from 'react' + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + export default (props: MarkViewRendererProps) => { + const [count, setCount] = React.useState(0) + + return ( + + + + + ) + } + ``` + + ## Vue 3 binding + + To use a Vue 3 component for a markview, you can use the `@tiptap/vue-3` package: + + ```ts + import { Mark } from '@tiptap/core' + import { VueMarkViewRenderer } from '@tiptap/vue-3' + + import Component from './Component.vue' + + export default Mark.create({ + name: 'vueComponent', + + parseHTML() { + return [ + { + tag: 'vue-component', + }, + ] + }, + + renderHTML({ HTMLAttributes }) { + return ['vue-component', HTMLAttributes] + }, + + addMarkView() { + return VueMarkViewRenderer(Component) + }, + }) + ``` + + And here is an example of a Vue 3 component: + + ```vue + + + + ``` + ## 3.0.0-next.4 ### Patch Changes diff --git a/packages/vue-3/package.json b/packages/vue-3/package.json index 7a40e174ef..15f8d7de90 100644 --- a/packages/vue-3/package.json +++ b/packages/vue-3/package.json @@ -1,7 +1,7 @@ { "name": "@tiptap/vue-3", "description": "Vue components for tiptap", - "version": "3.0.0-next.4", + "version": "3.0.0-next.5", "homepage": "https://tiptap.dev", "keywords": [ "tiptap", @@ -39,13 +39,13 @@ "dist" ], "devDependencies": { - "@tiptap/core": "^3.0.0-next.4", - "@tiptap/pm": "^3.0.0-next.4", + "@tiptap/core": "^3.0.0-next.5", + "@tiptap/pm": "^3.0.0-next.5", "vue": "^3.5.13" }, "optionalDependencies": { - "@tiptap/extension-bubble-menu": "^3.0.0-next.4", - "@tiptap/extension-floating-menu": "^3.0.0-next.4" + "@tiptap/extension-bubble-menu": "^3.0.0-next.5", + "@tiptap/extension-floating-menu": "^3.0.0-next.5" }, "peerDependencies": { "@tiptap/core": "^3.0.0-next.4", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 9226ab8ebb..bb46d3137c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -301,19 +301,19 @@ importers: packages/core: devDependencies: '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-blockquote: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-bold: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-bubble-menu: @@ -323,37 +323,37 @@ importers: version: 1.6.13 devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-bullet-list: devDependencies: '@tiptap/extension-list': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-list packages/extension-character-count: devDependencies: '@tiptap/extensions': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extensions packages/extension-code: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-code-block: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-code-block-lowlight: @@ -363,13 +363,13 @@ importers: version: 11.11.1 devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/extension-code-block': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-code-block '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm lowlight: specifier: ^3.3.0 @@ -382,10 +382,10 @@ importers: version: 13.6.23 devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm '@tiptap/y-tiptap': specifier: ^1.0.0 @@ -394,10 +394,10 @@ importers: packages/extension-collaboration-cursor: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm '@tiptap/y-tiptap': specifier: ^1.0.0 @@ -406,19 +406,19 @@ importers: packages/extension-color: devDependencies: '@tiptap/extension-text-style': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-text-style packages/extension-document: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-dropcursor: devDependencies: '@tiptap/extensions': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extensions packages/extension-floating-menu: @@ -427,73 +427,73 @@ importers: specifier: ^1.6.12 version: 1.6.13 '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-focus: devDependencies: '@tiptap/extensions': - specifier: 3.0.0-next.4 + specifier: 3.0.0-next.5 version: link:../extensions packages/extension-font-family: devDependencies: '@tiptap/extension-text-style': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-text-style packages/extension-gapcursor: devDependencies: '@tiptap/extensions': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extensions packages/extension-hard-break: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-heading: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-highlight: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-history: devDependencies: '@tiptap/extensions': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extensions packages/extension-horizontal-rule: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-image: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-italic: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-link: @@ -503,169 +503,169 @@ importers: version: 4.2.0 devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-list: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-list-item: devDependencies: '@tiptap/extension-list': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-list packages/extension-list-keymap: devDependencies: '@tiptap/extension-list': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-list packages/extension-mention: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm '@tiptap/suggestion': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../suggestion packages/extension-ordered-list: devDependencies: '@tiptap/extension-list': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-list packages/extension-paragraph: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-placeholder: devDependencies: '@tiptap/extensions': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extensions packages/extension-strike: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-subscript: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-superscript: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-table: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/extension-table-cell: devDependencies: '@tiptap/extension-table': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-table packages/extension-table-header: devDependencies: '@tiptap/extension-table': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-table packages/extension-table-row: devDependencies: '@tiptap/extension-table': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-table packages/extension-task-item: devDependencies: '@tiptap/extension-list': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-list packages/extension-task-list: devDependencies: '@tiptap/extension-list': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-list packages/extension-text: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-text-align: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-text-style: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-typography: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-underline: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extension-youtube: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core packages/extensions: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/html: @@ -675,10 +675,10 @@ importers: version: 14.12.3 devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/pm: @@ -751,17 +751,17 @@ importers: version: 1.4.0(react@18.3.1) optionalDependencies: '@tiptap/extension-bubble-menu': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-bubble-menu '@tiptap/extension-floating-menu': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-floating-menu devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm '@types/react': specifier: ^18.3.18 @@ -779,76 +779,76 @@ importers: packages/starter-kit: dependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/extension-blockquote': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-blockquote '@tiptap/extension-bold': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-bold '@tiptap/extension-bullet-list': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-bullet-list '@tiptap/extension-code': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-code '@tiptap/extension-code-block': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-code-block '@tiptap/extension-document': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-document '@tiptap/extension-dropcursor': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-dropcursor '@tiptap/extension-gapcursor': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-gapcursor '@tiptap/extension-hard-break': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-hard-break '@tiptap/extension-heading': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-heading '@tiptap/extension-history': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-history '@tiptap/extension-horizontal-rule': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-horizontal-rule '@tiptap/extension-italic': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-italic '@tiptap/extension-link': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-link '@tiptap/extension-list-item': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-list-item '@tiptap/extension-list-keymap': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-list-keymap '@tiptap/extension-ordered-list': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-ordered-list '@tiptap/extension-paragraph': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-paragraph '@tiptap/extension-strike': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-strike '@tiptap/extension-text': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-text '@tiptap/extension-underline': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-underline '@tiptap/extensions': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extensions '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/static-renderer: @@ -867,19 +867,19 @@ importers: version: 18.3.1(react@18.3.1) devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/suggestion: devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm packages/vue-2: @@ -889,17 +889,17 @@ importers: version: 1.6.2(vue@2.7.16) optionalDependencies: '@tiptap/extension-bubble-menu': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-bubble-menu '@tiptap/extension-floating-menu': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-floating-menu devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm vue: specifier: ^2.7.16 @@ -912,17 +912,17 @@ importers: version: 1.6.13 optionalDependencies: '@tiptap/extension-bubble-menu': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-bubble-menu '@tiptap/extension-floating-menu': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../extension-floating-menu devDependencies: '@tiptap/core': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../core '@tiptap/pm': - specifier: ^3.0.0-next.4 + specifier: ^3.0.0-next.5 version: link:../pm vue: specifier: ^3.5.13