Vue3 Cli

Posted on  by admin
The following guide describes how to integrate Tiptap with your Vue CLI project.

Node installed on your machine. Vue CLI installed on your machine. Experience with Vue. If you already have an existing Vue project, that’s fine too. Just skip this step and proceed with the next step.

Nathaniel Ford
18.6k

The Vue CLI sets up everything we need, just select the Vue 3 template.

Okay, enough of the boring boilerplate work.

Let’s finally install Tiptap! For the following example you’ll need the @tiptap/vue-3 package, with a few components, and @tiptap/starter-kit which has the most common extensions to get started quickly.

If you followed step 1 and 2, you can now start your project with npm run serve, and open http://localhost:8080 in your favorite browser.

This might be different, if you’re working with an existing project.

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. Alternatively, you can use the Composition API with the useEditor method. Or feel free to use the new