@mantine-vue/tiptap 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# @mantine-vue/tiptap
|
|
2
|
+
|
|
3
|
+
Advanced rich text editor for Vue, built on top of [Tiptap](https://tiptap.dev/), equivalent to `@mantine/tiptap`.
|
|
4
|
+
|
|
5
|
+
> Mantine Vue is an independent community port of [Mantine](https://mantine.dev/) for Vue 3. It is not affiliated with or endorsed by the Mantine team.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
yarn add @mantine-vue/tiptap @mantine-vue/core @mantine-vue/hooks @tiptap/core @tiptap/vue-3 @tiptap/pm @tiptap/extension-link @floating-ui/dom
|
|
11
|
+
|
|
12
|
+
# or with npm
|
|
13
|
+
npm i @mantine-vue/tiptap @mantine-vue/core @mantine-vue/hooks @tiptap/core @tiptap/vue-3 @tiptap/pm @tiptap/extension-link @floating-ui/dom
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```vue
|
|
19
|
+
<script setup>
|
|
20
|
+
import { useEditor } from '@tiptap/vue-3'
|
|
21
|
+
import StarterKit from '@tiptap/starter-kit'
|
|
22
|
+
import { RichTextEditor } from '@mantine-vue/tiptap'
|
|
23
|
+
import '@mantine-vue/tiptap/styles.css'
|
|
24
|
+
|
|
25
|
+
const editor = useEditor({
|
|
26
|
+
extensions: [StarterKit],
|
|
27
|
+
content: '<p>Hello world!</p>',
|
|
28
|
+
})
|
|
29
|
+
</script>
|
|
30
|
+
|
|
31
|
+
<template>
|
|
32
|
+
<RichTextEditor :editor="editor">
|
|
33
|
+
<RichTextEditor.Toolbar>
|
|
34
|
+
<RichTextEditor.Bold />
|
|
35
|
+
<RichTextEditor.Italic />
|
|
36
|
+
</RichTextEditor.Toolbar>
|
|
37
|
+
<RichTextEditor.Content />
|
|
38
|
+
</RichTextEditor>
|
|
39
|
+
</template>
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Documentation
|
|
43
|
+
|
|
44
|
+
Full API and examples: [mantine-vue.dev/x/tiptap](https://mantine-vue.dev/x/tiptap)
|
|
45
|
+
|
|
46
|
+
## Peer dependencies
|
|
47
|
+
|
|
48
|
+
- `vue` ^3.5.0
|
|
49
|
+
- `@mantine-vue/core`
|
|
50
|
+
- `@mantine-vue/hooks`
|
|
51
|
+
- `@tiptap/core`, `@tiptap/vue-3`, `@tiptap/pm`, `@tiptap/extension-link` >=3.3.0
|
|
52
|
+
- `@floating-ui/dom` ^1.0.0
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mantine-vue/tiptap",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
4
4
|
"description": "Vue rich text editor based on tiptap, equivalent to @mantine/tiptap",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"files": [
|
|
@@ -45,8 +45,8 @@
|
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
47
|
"@floating-ui/dom": "^1.0.0",
|
|
48
|
-
"@mantine-vue/core": "1.1.
|
|
49
|
-
"@mantine-vue/hooks": "1.1.
|
|
48
|
+
"@mantine-vue/core": "1.1.3",
|
|
49
|
+
"@mantine-vue/hooks": "1.1.3",
|
|
50
50
|
"@tiptap/core": ">=3.3.0",
|
|
51
51
|
"@tiptap/extension-link": ">=3.3.0",
|
|
52
52
|
"@tiptap/pm": ">=3.3.0",
|