mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-30 04:57:50 +08:00
157 lines
3.9 KiB
Markdown
157 lines
3.9 KiB
Markdown
---
|
||
title: Vue.js 3 WYSIWYG
|
||
tableOfContents: true
|
||
---
|
||
|
||
# Vue.js 3
|
||
|
||
## Introduction
|
||
The following guide describes how to integrate Tiptap with your [Vue](https://vuejs.org/) CLI project.
|
||
|
||
## Requirements
|
||
* [Node](https://nodejs.org/en/download/) installed on your machine
|
||
* [Vue CLI](https://cli.vuejs.org/) installed on your machine
|
||
* Experience with [Vue](https://v3.vuejs.org/guide/introduction.html)
|
||
|
||
## 1. Create a project (optional)
|
||
If you already have an existing Vue project, that’s fine too. Just skip this step and proceed with the next step.
|
||
|
||
For the sake of this guide, let’s start with a fresh Vue project called `my-tiptap-project`. The Vue CLI sets up everything we need, just select the Vue 3 template.
|
||
|
||
```bash
|
||
# create a project
|
||
vue create my-tiptap-project
|
||
|
||
# change directory
|
||
cd my-tiptap-project
|
||
```
|
||
|
||
## 2. Install the dependencies
|
||
Okay, enough of the boring boilerplate work. Let’s finally install Tiptap! For the following example you’ll need the `@tiptap/vue-3` package, `@tiptap/pm` (the ProseMirror library) and `@tiptap/starter-kit`, which includes the most common extensions to get started quickly.
|
||
|
||
```bash
|
||
npm install @tiptap/vue-3 @tiptap/pm @tiptap/starter-kit
|
||
```
|
||
|
||
If you followed step 1 and 2, you can now start your project with `npm run dev`, and open [http://localhost:8080](http://localhost:8080) in your favorite browser. This might be different, if you’re working with an existing project.
|
||
|
||
## 3. Create a new component
|
||
To actually start using Tiptap, you’ll need to add a new component to your app. Let’s call it `Tiptap` and put the following example code in `components/Tiptap.vue`.
|
||
|
||
This is the fastest way to get Tiptap up and running with Vue. It will give you a very basic version of Tiptap, without any buttons. No worries, you will be able to add more functionality soon.
|
||
|
||
```html
|
||
<template>
|
||
<editor-content :editor="editor" />
|
||
</template>
|
||
|
||
<script>
|
||
import { Editor, EditorContent } from '@tiptap/vue-3'
|
||
import StarterKit from '@tiptap/starter-kit'
|
||
|
||
export default {
|
||
components: {
|
||
EditorContent,
|
||
},
|
||
|
||
data() {
|
||
return {
|
||
editor: null,
|
||
}
|
||
},
|
||
|
||
mounted() {
|
||
this.editor = new Editor({
|
||
content: '<p>I’m running Tiptap with Vue.js. 🎉</p>',
|
||
extensions: [
|
||
StarterKit,
|
||
],
|
||
})
|
||
},
|
||
|
||
beforeUnmount() {
|
||
this.editor.destroy()
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
Alternatively, you can use the Composition API with the `useEditor` method.
|
||
|
||
```html
|
||
<template>
|
||
<editor-content :editor="editor" />
|
||
</template>
|
||
|
||
<script>
|
||
import { useEditor, EditorContent } from '@tiptap/vue-3'
|
||
import StarterKit from '@tiptap/starter-kit'
|
||
|
||
export default {
|
||
components: {
|
||
EditorContent,
|
||
},
|
||
|
||
setup() {
|
||
const editor = useEditor({
|
||
content: '<p>I’m running Tiptap with Vue.js. 🎉</p>',
|
||
extensions: [
|
||
StarterKit,
|
||
],
|
||
})
|
||
|
||
return { editor }
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
Or feel free to use the new [`<script setup>` syntax](https://v3.vuejs.org/api/sfc-script-setup.html).
|
||
|
||
```html
|
||
<template>
|
||
<editor-content :editor="editor" />
|
||
</template>
|
||
|
||
<script setup>
|
||
import { useEditor, EditorContent } from '@tiptap/vue-3'
|
||
import StarterKit from '@tiptap/starter-kit'
|
||
|
||
const editor = useEditor({
|
||
content: '<p>I’m running Tiptap with Vue.js. 🎉</p>',
|
||
extensions: [
|
||
StarterKit,
|
||
],
|
||
})
|
||
</script>
|
||
```
|
||
|
||
## 4. Add it to your app
|
||
Now, let’s replace the content of `src/App.vue` with the following example code to use our new `Tiptap` component in our app.
|
||
|
||
```html
|
||
<template>
|
||
<div id="app">
|
||
<tiptap />
|
||
</div>
|
||
</template>
|
||
|
||
<script>
|
||
import Tiptap from './components/Tiptap.vue'
|
||
|
||
export default {
|
||
name: 'App',
|
||
components: {
|
||
Tiptap
|
||
}
|
||
}
|
||
</script>
|
||
```
|
||
|
||
You should now see Tiptap in your browser. Time to give yourself a pat on the back! :)
|
||
|
||
## 5. Use v-model (optional)
|
||
You’re probably used to binding your data with `v-model` in forms, that’s also possible with Tiptap. Here is how that would work with Tiptap:
|
||
|
||
https://embed.tiptap.dev/preview/GuideGettingStarted/VModel
|