VueRenderer documentation with version 3

ueberdosis · Jun 22, 2021 · 6faf2fe · 6faf2fe
1 parent b6e276f
commit 6faf2fe
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/docs/src/docPages/api/nodes/mention.md b/docs/src/docPages/api/nodes/mention.md
@@ -36,6 +36,21 @@ npm install @tiptap/vue-2
 # with Yarn
 yarn add @tiptap/vue-2
 ```
+If you are using `vue-3` then the `VueRenderer` requires different input:
+```js
+new VueRenderer(MentionList, {
+  props: props,
+  editor: this.editor,
+})
+```
+and not
+```js
+new VueRenderer(MentionList, {
+  parent: this,
+  propsData: props,
+})
+```
+
 
 And yes, we plan to support React, too. Meanwhile, you can roll your own `ReactRenderer`, but don’t forget to share it with the community.