tiptap/docs/installation/alpine.md

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

# Alpine.js

## Introduction
The following guide describes how to integrate tiptap with your [Alpine.js](https://github.com/alpinejs/alpine) project.

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 `tiptap-example`. Vite sets up everything we need, just select the Vanilla JavaScript template.

```bash
npm init vite@latest tiptap-example -- --template vanilla
cd tiptap-example
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
# install with npm
npm install alpinejs @tiptap/core @tiptap/starter-kit

# install with Yarn
yarn add alpinejs @tiptap/core @tiptap/starter-kit
```

If you followed step 1, you can now start your project with `npm run dev` or `yarn dev`, and open [http://localhost:3000](http://localhost:3000) 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'

window.setupEditor = function(content) {
  return {
    editor: null,
    content: content,
    updatedAt: Date.now(), // force Alpine to rerender on selection change
    init(element) {
      this.editor = new Editor({
        element: element,
        extensions: [
          StarterKit,
        ],
        content: this.content,
        onUpdate: ({ editor }) => {
          this.content = editor.getHTML()
        },
        onSelectionUpdate: () => {
          this.updatedAt = Date.now()
        },
      })
    },
  }
}

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
<!-- index.html -->
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
</head>
<body>
  <div x-data="setupEditor('<p>Hello World! :-)</p>')" x-init="() => init($refs.element)">

    <template x-if="editor">
      <div class="menu">
        <button
          @click="editor.chain().toggleHeading({ level: 1 }).focus().run()"
          :class="{ 'is-active': editor.isActive('heading', { level: 1 }) }"
        >
          H1
        </button>
        <button
          @click="editor.chain().toggleBold().focus().run()"
          :class="{ 'is-active': editor.isActive('bold') }"
        >
          Bold
        </button>
        <button
          @click="editor.chain().toggleItalic().focus().run()"
          :class="{ 'is-active': editor.isActive('italic') }"
        >
          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
 								The following guide describes how to integrate tiptap with your [Alpine.js](https://github.com/alpinejs/alpine) project.
-												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.
 								For the sake of this guide, let’s start with a fresh [Vite](https://vitejs.dev/) project called `tiptap-example`. Vite sets up everything we need, just select the Vanilla JavaScript template.
 								```bash
-												Update alpine docs (#1733)


											
										
										
											2021-08-17 02:57:45 +08:00
+								npm init vite@latest tiptap-example -- --template vanilla
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								cd tiptap-example
 								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: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +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.
 								```bash
 								# install with npm
 								npm install alpinejs @tiptap/core @tiptap/starter-kit
 								# install with Yarn
 								yarn add alpinejs @tiptap/core @tiptap/starter-kit
 								```
 								If you followed step 1, you can now start your project with `npm run dev` or `yarn dev`, and open [http://localhost:3000](http://localhost:3000) in your favorite browser. This might be different, if you’re working with an existing project.
-												docs: update content

											
										
										
											2021-04-09 04:44:55 +08:00
+								## 3. Initialize the editor
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +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`.
 								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
-												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
 								window.setupEditor = function(content) {
 								  return {
 								    editor: null,
 								    content: content,
-												docs: force Alpine to rerender when the selection updates

											
										
										
											2021-05-12 01:23:36 +08:00
+								    updatedAt: Date.now(), // force Alpine to rerender on selection change
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								    init(element) {
 								      this.editor = new Editor({
 								        element: element,
-												docs: update content

											
										
										
											2021-05-07 00:41:22 +08:00
+								        extensions: [
 								          StarterKit,
 								        ],
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								        content: this.content,
 								        onUpdate: ({ editor }) => {
 								          this.content = editor.getHTML()
 								        },
-												docs: force Alpine to rerender when the selection updates

											
										
										
											2021-05-12 01:23:36 +08:00
+								        onSelectionUpdate: () => {
 								          this.updatedAt = Date.now()
 								        },
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								      })
 								    },
 								  }
 								}
-												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
-												docs: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								<!-- index.html -->
-												add integration guide drafts for alpine & livewire

											
										
										
											2021-01-09 01:20:28 +08:00
+								<!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>
 								  <div x-data="setupEditor('<p>Hello World! :-)</p>')" x-init="() => init($refs.element)">
 								    <template x-if="editor">
 								      <div class="menu">
 								        <button
 								          @click="editor.chain().toggleHeading({ level: 1 }).focus().run()"
 								          :class="{ 'is-active': editor.isActive('heading', { level: 1 }) }"
 								        >
 								          H1
 								        </button>
 								        <button
 								          @click="editor.chain().toggleBold().focus().run()"
 								          :class="{ 'is-active': editor.isActive('bold') }"
 								        >
 								          Bold
 								        </button>
 								        <button
 								          @click="editor.chain().toggleItalic().focus().run()"
 								          :class="{ 'is-active': editor.isActive('italic') }"
 								        >
 								          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: update content, improve the Alpine.js guide

											
										
										
											2021-04-09 04:42:18 +08:00
+								You should now see tiptap in your browser. Time to give yourself a pat on the back! :)