diff --git a/docs/package.json b/docs/package.json index d456261e..3c850ae1 100644 --- a/docs/package.json +++ b/docs/package.json @@ -25,6 +25,7 @@ "remark-toc": "^7.0.0", "remixicon": "^2.5.0", "simplify-js": "^1.2.4", + "tippy.js": "^6.2.7", "vue-github-button": "^1.1.2", "vue-live": "^1.16.0", "y-indexeddb": "^9.0.6", diff --git a/docs/src/demos/Examples/Drawing/Paper.js b/docs/src/demos/Examples/Drawing/Paper.js index 71eab1c3..844459bf 100644 --- a/docs/src/demos/Examples/Drawing/Paper.js +++ b/docs/src/demos/Examples/Drawing/Paper.js @@ -1,5 +1,5 @@ import { Node, mergeAttributes } from '@tiptap/core' -import { VueRenderer } from '@tiptap/vue' +import { VueNodeViewRenderer } from '@tiptap/vue' import Component from './Component.vue' export default Node.create({ @@ -30,6 +30,6 @@ export default Node.create({ }, addNodeView() { - return VueRenderer(Component) + return VueNodeViewRenderer(Component) }, }) diff --git a/docs/src/demos/Guide/NodeViews/DragHandle/DraggableItem.js b/docs/src/demos/Guide/NodeViews/DragHandle/DraggableItem.js index 025cc9be..910c0b2d 100644 --- a/docs/src/demos/Guide/NodeViews/DragHandle/DraggableItem.js +++ b/docs/src/demos/Guide/NodeViews/DragHandle/DraggableItem.js @@ -1,5 +1,5 @@ import { Node, mergeAttributes } from '@tiptap/core' -import { VueRenderer } from '@tiptap/vue' +import { VueNodeViewRenderer } from '@tiptap/vue' import Component from './Component.vue' export default Node.create({ @@ -24,6 +24,6 @@ export default Node.create({ }, addNodeView() { - return VueRenderer(Component) + return VueNodeViewRenderer(Component) }, }) diff --git a/docs/src/demos/Guide/NodeViews/TableOfContents/TableOfContents.js b/docs/src/demos/Guide/NodeViews/TableOfContents/TableOfContents.js index a52a6571..7c0e6092 100644 --- a/docs/src/demos/Guide/NodeViews/TableOfContents/TableOfContents.js +++ b/docs/src/demos/Guide/NodeViews/TableOfContents/TableOfContents.js @@ -1,5 +1,5 @@ import { Node, mergeAttributes } from '@tiptap/core' -import { VueRenderer } from '@tiptap/vue' +import { VueNodeViewRenderer } from '@tiptap/vue' import Component from './Component.vue' export default Node.create({ @@ -22,6 +22,6 @@ export default Node.create({ }, addNodeView() { - return VueRenderer(Component) + return VueNodeViewRenderer(Component) }, }) diff --git a/docs/src/demos/Nodes/Mention/MentionList.vue b/docs/src/demos/Nodes/Mention/MentionList.vue new file mode 100644 index 00000000..ff08520e --- /dev/null +++ b/docs/src/demos/Nodes/Mention/MentionList.vue @@ -0,0 +1,112 @@ + + + + + diff --git a/docs/src/demos/Nodes/Mention/index.spec.js b/docs/src/demos/Nodes/Mention/index.spec.js new file mode 100644 index 00000000..773694f9 --- /dev/null +++ b/docs/src/demos/Nodes/Mention/index.spec.js @@ -0,0 +1,5 @@ +context('/api/nodes/mention', () => { + before(() => { + cy.visit('/api/nodes/mention') + }) +}) diff --git a/docs/src/demos/Nodes/Mention/index.vue b/docs/src/demos/Nodes/Mention/index.vue new file mode 100644 index 00000000..16bbf954 --- /dev/null +++ b/docs/src/demos/Nodes/Mention/index.vue @@ -0,0 +1,100 @@ + + + + + diff --git a/docs/src/docPages/api/commands.md b/docs/src/docPages/api/commands.md index 61131af4..4762e50a 100644 --- a/docs/src/docPages/api/commands.md +++ b/docs/src/docPages/api/commands.md @@ -147,6 +147,7 @@ Have a look at all of the core commands listed below. They should give you a goo | .lift() | Removes an existing wrap. | | .liftEmptyBlock() | Lift block if empty. | | .newlineInCode() | Add a newline character in code. | +| .replace() | Replaces text with a node within a range. | | .resetNodeAttributes() | Resets all node attributes to the default value. | | .selectParentNode() | Select the parent node. | | .setMark() | Add a mark with new attributes. | diff --git a/docs/src/docPages/api/extensions/suggestion.md b/docs/src/docPages/api/extensions/suggestion.md deleted file mode 100644 index 3539f167..00000000 --- a/docs/src/docPages/api/extensions/suggestion.md +++ /dev/null @@ -1,14 +0,0 @@ -# Suggestion - -:::pro Fund the development 💖 -We need your support to maintain, update, support and develop tiptap 2. If you’re waiting for this extension, [become a sponsor and fund open source](/sponsor). -::: - -TODO - -- mentions (as text or as/with user ID) -- hashtags (as text) -- emojis (input rule with an autocomplete popup) -- commands (can only be triggered at the beginning of a line, should trigger custom commands) -- snippets (should be able to insert multiple paragraphs) -- variables (should replaced when copied to external sources) diff --git a/docs/src/docPages/api/nodes/mention.md b/docs/src/docPages/api/nodes/mention.md index e74457ea..3d15ae56 100644 --- a/docs/src/docPages/api/nodes/mention.md +++ b/docs/src/docPages/api/nodes/mention.md @@ -1,7 +1,16 @@ # Mention -:::pro Fund the development 💖 -We need your support to maintain, update, support and develop tiptap 2. If you’re waiting for this extension, [become a sponsor and fund open source](/sponsor). -::: +## Installation +```bash +# with npm +npm install @tiptap/extension-mention -TODO +# with Yarn +yarn add @tiptap/extension-mention +``` + +## Source code +[packages/extension-mention/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-mention/) + +## Usage + diff --git a/docs/src/docPages/guide/node-views.md b/docs/src/docPages/guide/node-views.md index 0d6002c7..e6fb1ee1 100644 --- a/docs/src/docPages/guide/node-views.md +++ b/docs/src/docPages/guide/node-views.md @@ -7,7 +7,7 @@ Node views are the best thing since sliced bread, at least if you’re a fan of