Search

Nuxt.js

toc

Introduction

The following guide describes how to integrate tiptap with your Nuxt.js project.

Requirements

  • Node installed on your machine
  • Experience with Vue

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 Nuxt.js project called tiptap-example. The following command sets up everything we need. It asks a lot of questions, but just use what floats your boat or use the defaults.

# create a project
npm init nuxt-app tiptap-example

# change directory
cd tiptap-example

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-2 package, with a few components, and @tiptap/starter-kit which has the most common extensions to get started quickly.

# install with npm
npm install @tiptap/vue-2 @tiptap/starter-kit

# install with Yarn
yarn add @tiptap/vue-2 @tiptap/starter-kit

If you followed step 1 and 2, you can now start your project with npm run serve or yarn serve, and open 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 src/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.

<template>
  <editor-content :editor="editor" />
</template>

<script>
import { Editor, EditorContent } from '@tiptap/vue-2'
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,
      ],
    })
  },

  beforeDestroy() {
    this.editor.destroy()
  },
}
</script>

4. Add it to your app

Now, let’s replace the content of pages/index.vue with the following example code to use our new Tiptap component in our app.

<template>
  <div id="app">
    <client-only>
      <tiptap />
    </client-only>
  </div>
</template>

Note that tiptap needs to run in the client, not on the server. It’s required to wrap the editor in a <client-only> tag. Read more about cient-only components.

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 bind your data with v-model in forms, that’s also possible with tiptap. Here is a working example component, that you can integrate in your project: