tiptap/docs/installation/vue2.md

111 lines
3.1 KiB
Markdown
Raw Normal View History

---
title: Vue.js 2 WYSIWYG
tableOfContents: true
---
2021-02-07 06:20:13 +08:00
# Vue.js 2
## Introduction
2021-10-20 04:30:45 +08:00
The following guide describes how to integrate Tiptap with your [Vue](https://vuejs.org/) CLI project.
2021-02-07 06:20:13 +08:00
## 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://vuejs.org/v2/guide/#Getting-Started)
## 1. Create a project (optional)
If you already have an existing Vue project, thats fine too. Just skip this step and proceed with the next step.
For the sake of this guide, lets start with a fresh Vue project called `tiptap-example`. The Vue CLI sets up everything we need, just select the default Vue 2 template.
```bash
# create a project
2021-10-20 04:30:45 +08:00
vue create Tiptap-example
2021-02-07 06:20:13 +08:00
# change directory
2021-10-20 04:30:45 +08:00
cd Tiptap-example
2021-02-07 06:20:13 +08:00
```
## 2. Install the dependencies
2021-10-20 04:30:45 +08:00
Okay, enough of the boring boilerplate work. Lets finally install Tiptap! For the following example youll need the `@tiptap/vue-2` package, with a few components, and `@tiptap/starter-kit` which has the most common extensions to get started quickly.
2021-02-07 06:20:13 +08:00
```bash
# install with npm
2021-03-04 04:26:08 +08:00
npm install @tiptap/vue-2 @tiptap/starter-kit
2021-02-07 06:20:13 +08:00
# install with Yarn
2021-03-04 04:26:08 +08:00
yarn add @tiptap/vue-2 @tiptap/starter-kit
2021-02-07 06:20:13 +08:00
```
If you followed step 1 and 2, you can now start your project with `npm run dev` or `yarn dev`, and open [http://localhost:8080](http://localhost:8080) in your favorite browser. This might be different, if youre working with an existing project.
2021-02-07 06:20:13 +08:00
## 3. Create a new component
2021-10-20 04:30:45 +08:00
To actually start using Tiptap, youll need to add a new component to your app. Lets call it `Tiptap` and put the following example code in `components/Tiptap.vue`.
2021-02-07 06:20:13 +08:00
2021-10-20 04:30:45 +08:00
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.
2021-02-07 06:20:13 +08:00
```html
<template>
<editor-content :editor="editor" />
</template>
<script>
import { Editor, EditorContent } from '@tiptap/vue-2'
2021-05-07 00:41:22 +08:00
import StarterKit from '@tiptap/starter-kit'
2021-02-07 06:20:13 +08:00
export default {
components: {
EditorContent,
},
data() {
return {
editor: null,
}
},
mounted() {
this.editor = new Editor({
2021-10-20 04:30:45 +08:00
content: '<p>Im running Tiptap with Vue.js. 🎉</p>',
2021-05-07 00:41:22 +08:00
extensions: [
StarterKit,
],
2021-02-07 06:20:13 +08:00
})
},
beforeDestroy() {
this.editor.destroy()
},
}
</script>
```
## 4. Add it to your app
Now, lets 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>
```
2021-10-20 04:30:45 +08:00
You should now see Tiptap in your browser. Time to give yourself a pat on the back! :)
2021-02-07 06:20:13 +08:00
## 5. Use v-model (optional)
2021-10-20 04:30:45 +08:00
Youre probably used to bind your data with `v-model` in forms, thats also possible with Tiptap. Here is a working example component, that you can integrate in your project:
2021-02-07 06:20:13 +08:00
2021-10-19 00:01:47 +08:00
https://embed.tiptap.dev/preview/GuideGettingStarted/VModel