tiptap/docs/installation/alpine.md

---
title: Alpine WYSIWYG
tableOfContents: true
---

# Alpine.js

## Introduction
The following guide describes how to integrate Tiptap with version 3 of [Alpine.js](https://github.com/alpinejs/alpine).

For the sake of this guide we’ll use [Vite](https://vitejs.dev/) to quickly set up a project, but you can use whatever you’re used to. Vite is just really fast and we love it.

## Requirements
* [Node](https://nodejs.org/en/download/) installed on your machine
* Experience with [Alpine.js](https://github.com/alpinejs/alpine)

## 1. Create a project (optional)
If you already have an existing Alpine.js 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 [Vite](https://vitejs.dev/) project called `my-tiptap-project`. Vite sets up everything we need, just select the Vanilla JavaScript template.

```bash
npm init vite@latest my-tiptap-project -- --template vanilla
cd my-tiptap-project
npm install
npm run dev
```

## 2. Install the dependencies

Okay, enough of the boring boilerplate work. Let’s finally install Tiptap! For the following example you’ll need `alpinejs`, the `@tiptap/core` package and the `@tiptap/starter-kit` which has the most common extensions to get started quickly.

```bash
npm install alpinejs @tiptap/core @tiptap/starter-kit
```

If you followed step 1, you can now start your project with `npm run dev`, and open [http://localhost:5173](http://localhost:5173) in your favorite browser. This might be different, if you’re working with an existing project.

## 3. Initialize the editor
To actually start using Tiptap, you’ll need to write a little bit of JavaScript. Let’s put the following example code in a file called `main.js`.

This is the fastest way to get Tiptap up and running with Alpine.js. It will give you a very basic version of Tiptap. No worries, you will be able to add more functionality soon.

```js
import Alpine from 'alpinejs'
import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'

document.addEventListener('alpine:init', () => {
  Alpine.data('editor', (content) => {
    let editor

    return {
      updatedAt: Date.now(), // force Alpine to rerender on selection change
      init() {
        const _this = this

        editor = new Editor({
          element: this.$refs.element,
          extensions: [
            StarterKit
          ],
          content: content,
          onCreate({ editor }) {
            _this.updatedAt = Date.now()
          },
          onUpdate({ editor }) {
            _this.updatedAt = Date.now()
          },
          onSelectionUpdate({ editor }) {
            _this.updatedAt = Date.now()
          }
        });
      },
      isLoaded() {
        return editor
      },
      isActive(type, opts = {}) {
        return editor.isActive(type, opts)
      },
      toggleHeading(opts) {
        editor.chain().toggleHeading(opts).focus().run()
      },
      toggleBold() {
        editor.chain().toggleBold().focus().run()
      },
      toggleItalic() {
        editor.chain().toggleItalic().focus().run()
      },
    };
  });
});

window.Alpine = Alpine
Alpine.start()
```

## 4. Add it to your app
Now, let’s replace the content of the `index.html` with the following example code to use the editor in our app.

```html
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
</head>
<body>
  <div x-data="editor('<p>Hello world! :-)</p>')">

    <template x-if="isLoaded()">
      <div class="menu">
        <button
          @click="toggleHeading({ level: 1 })"
          :class="{ 'is-active': isActive('heading', { level: 1 }, updatedAt) }"
        >
          H1
        </button>
        <button
          @click="toggleBold()"
          :class="{ 'is-active' : isActive('bold', updatedAt) }"
        >
          Bold
        </button>
        <button
          @click="toggleItalic()"
          :class="{ 'is-active' : isActive('italic', updatedAt) }"
        >
          Italic
        </button>
      </div>
    </template>

    <div x-ref="element"></div>
  </div>

  <script type="module" src="/main.js"></script>

  <style>
    body { margin: 2rem; font-family: sans-serif; }
    button.is-active { background: black; color: white; }
    .ProseMirror { padding: 0.5rem 1rem; margin: 1rem 0; border: 1px solid #ccc; }
  </style>
</body>
</html>
```

You should now see Tiptap in your browser. Time to give yourself a pat on the back! :)
-												docs: add better titles to the integration guides

											
										
										
											2021-04-07 06:08:50 +08:00
+								---
 								title: Alpine WYSIWYG
-												Update alpine.md
											
										
										
											2021-09-08 04:50:22 +08:00
+								tableOfContents: true
-												docs: add better titles to the integration guides

											
										
										
											2021-04-07 06:08:50 +08:00
+								---
-												add integration guide drafts for alpine & livewire

											
										
										
											2021-01-09 01:20:28 +08:00
+								# Alpine.js
-												docs: update the integration guides

											
										
										
											2021-01-30 05:05:47 +08:00
+								## Introduction
-												docs: update alpine installation (#3081)

* docs: update alpine installation

* update docs

Co-authored-by: Patrick Baber <patrick@p-squared.de>
											
										
										
											2022-08-12 20:30:28 +08:00
+								The following guide describes how to integrate Tiptap with version 3 of [Alpine.js](https://github.com/alpinejs/alpine).
-												docs: update the integration guides

											
										
										
											2021-01-30 05:05:47 +08:00
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								For the sake of this guide we’ll use [Vite](https://vitejs.dev/) to quickly set up a project, but you can use whatever you’re used to. Vite is just really fast and we love it.
 								## Requirements
 								* [Node](https://nodejs.org/en/download/) installed on your machine
 								* Experience with [Alpine.js](https://github.com/alpinejs/alpine)
 								## 1. Create a project (optional)
 								If you already have an existing Alpine.js project, that’s fine too. Just skip this step and proceed with the next step.
-												docs: remove Yarn instructions

											
										
										
											2021-11-09 18:56:27 +08:00
+								For the sake of this guide, let’s start with a fresh [Vite](https://vitejs.dev/) project called `my-tiptap-project`. Vite sets up everything we need, just select the Vanilla JavaScript template.
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
 								```bash
-												docs: remove Yarn instructions

											
										
										
											2021-11-09 18:56:27 +08:00
+								npm init vite@latest my-tiptap-project -- --template vanilla
 								cd my-tiptap-project
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								npm install
-												Update alpine docs (#1733)


											
										
										
											2021-08-17 02:57:45 +08:00
+								npm run dev
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								```
 								## 2. Install the dependencies
-												Update alpine docs (#1733)


											
										
										
											2021-08-17 02:57:45 +08:00
-												docs: use regular case for Tiptap

											
										
										
											2021-10-20 04:30:45 +08:00
+								Okay, enough of the boring boilerplate work. Let’s finally install Tiptap! For the following example you’ll need `alpinejs`, the `@tiptap/core` package and the `@tiptap/starter-kit` which has the most common extensions to get started quickly.
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
 								```bash
 								npm install alpinejs @tiptap/core @tiptap/starter-kit
 								```
-												docs: update alpine installation (#3081)

* docs: update alpine installation

* update docs

Co-authored-by: Patrick Baber <patrick@p-squared.de>
											
										
										
											2022-08-12 20:30:28 +08:00
+								If you followed step 1, you can now start your project with `npm run dev`, and open [http://localhost:5173](http://localhost:5173) in your favorite browser. This might be different, if you’re working with an existing project.
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
-												docs: update content

											
										
										
											2021-04-09 04:44:55 +08:00
+								## 3. Initialize the editor
-												docs: use regular case for Tiptap

											
										
										
											2021-10-20 04:30:45 +08:00
+								To actually start using Tiptap, you’ll need to write a little bit of JavaScript. Let’s put the following example code in a file called `main.js`.
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
-												docs: use regular case for Tiptap

											
										
										
											2021-10-20 04:30:45 +08:00
+								This is the fastest way to get Tiptap up and running with Alpine.js. It will give you a very basic version of Tiptap. No worries, you will be able to add more functionality soon.
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
 								```js
-												Update alpine docs (#1733)


											
										
										
											2021-08-17 02:57:45 +08:00
+								import Alpine from 'alpinejs'
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								import { Editor } from '@tiptap/core'
-												docs: update content

											
										
										
											2021-05-07 00:41:22 +08:00
+								import StarterKit from '@tiptap/starter-kit'
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
-												docs: update alpine installation (#3081)

* docs: update alpine installation

* update docs

Co-authored-by: Patrick Baber <patrick@p-squared.de>
											
										
										
											2022-08-12 20:30:28 +08:00
+								document.addEventListener('alpine:init', () => {
 								  Alpine.data('editor', (content) => {
 								    let editor
 								    return {
 								      updatedAt: Date.now(), // force Alpine to rerender on selection change
 								      init() {
 								        const _this = this
 								        editor = new Editor({
 								          element: this.$refs.element,
 								          extensions: [
 								            StarterKit
 								          ],
 								          content: content,
 								          onCreate({ editor }) {
 								            _this.updatedAt = Date.now()
 								          },
 								          onUpdate({ editor }) {
 								            _this.updatedAt = Date.now()
 								          },
 								          onSelectionUpdate({ editor }) {
 								            _this.updatedAt = Date.now()
 								          }
 								        });
 								      },
 								      isLoaded() {
 								        return editor
 								      },
 								      isActive(type, opts = {}) {
 								        return editor.isActive(type, opts)
 								      },
 								      toggleHeading(opts) {
 								        editor.chain().toggleHeading(opts).focus().run()
 								      },
 								      toggleBold() {
 								        editor.chain().toggleBold().focus().run()
 								      },
 								      toggleItalic() {
 								        editor.chain().toggleItalic().focus().run()
 								      },
 								    };
 								  });
 								});
-												Update alpine docs (#1733)


											
										
										
											2021-08-17 02:57:45 +08:00
 								window.Alpine = Alpine
 								Alpine.start()
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								```
 								## 4. Add it to your app
 								Now, let’s replace the content of the `index.html` with the following example code to use the editor in our app.
-												add integration guide drafts for alpine & livewire

											
										
										
											2021-01-09 01:20:28 +08:00
 								```html
 								<!DOCTYPE html>
-												docs: refactor alpine.js example

											
										
										
											2021-04-09 04:12:46 +08:00
+								<html lang="en">
 								<head>
 								  <meta charset="UTF-8">
 								</head>
 								<body>
-												docs: update alpine installation (#3081)

* docs: update alpine installation

* update docs

Co-authored-by: Patrick Baber <patrick@p-squared.de>
											
										
										
											2022-08-12 20:30:28 +08:00
+								  <div x-data="editor('<p>Hello world! :-)</p>')">
-												docs: refactor alpine.js example

											
										
										
											2021-04-09 04:12:46 +08:00
-												docs: update alpine installation (#3081)

* docs: update alpine installation

* update docs

Co-authored-by: Patrick Baber <patrick@p-squared.de>
											
										
										
											2022-08-12 20:30:28 +08:00
+								    <template x-if="isLoaded()">
-												docs: refactor alpine.js example

											
										
										
											2021-04-09 04:12:46 +08:00
+								      <div class="menu">
 								        <button
-												docs: update alpine installation (#3081)

* docs: update alpine installation

* update docs

Co-authored-by: Patrick Baber <patrick@p-squared.de>
											
										
										
											2022-08-12 20:30:28 +08:00
+								          @click="toggleHeading({ level: 1 })"
 								          :class="{ 'is-active': isActive('heading', { level: 1 }, updatedAt) }"
-												docs: refactor alpine.js example

											
										
										
											2021-04-09 04:12:46 +08:00
+								        >
 								          H1
 								        </button>
 								        <button
-												docs: update alpine installation (#3081)

* docs: update alpine installation

* update docs

Co-authored-by: Patrick Baber <patrick@p-squared.de>
											
										
										
											2022-08-12 20:30:28 +08:00
+								          @click="toggleBold()"
 								          :class="{ 'is-active' : isActive('bold', updatedAt) }"
-												docs: refactor alpine.js example

											
										
										
											2021-04-09 04:12:46 +08:00
+								        >
 								          Bold
 								        </button>
 								        <button
-												docs: update alpine installation (#3081)

* docs: update alpine installation

* update docs

Co-authored-by: Patrick Baber <patrick@p-squared.de>
											
										
										
											2022-08-12 20:30:28 +08:00
+								          @click="toggleItalic()"
 								          :class="{ 'is-active' : isActive('italic', updatedAt) }"
-												docs: refactor alpine.js example

											
										
										
											2021-04-09 04:12:46 +08:00
+								        >
 								          Italic
 								        </button>
 								      </div>
 								    </template>
-												add integration guide drafts for alpine & livewire

											
										
										
											2021-01-09 01:20:28 +08:00
-												docs: refactor alpine.js example

											
										
										
											2021-04-09 04:12:46 +08:00
+								    <div x-ref="element"></div>
 								  </div>
-												add integration guide drafts for alpine & livewire

											
										
										
											2021-01-09 01:20:28 +08:00
-												docs: refactor alpine.js example

											
										
										
											2021-04-09 04:12:46 +08:00
+								  <script type="module" src="/main.js"></script>
 								  <style>
 								    body { margin: 2rem; font-family: sans-serif; }
 								    button.is-active { background: black; color: white; }
 								    .ProseMirror { padding: 0.5rem 1rem; margin: 1rem 0; border: 1px solid #ccc; }
 								  </style>
 								</body>
-												add integration guide drafts for alpine & livewire

											
										
										
											2021-01-09 01:20:28 +08:00
+								</html>
 								```
-												docs: use regular case for Tiptap

											
										
										
											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! :)