* chore:(core): migrate to tsup * chore: migrate blockquote and bold to tsup * chore: migrated bubble-menu and bullet-list to tsup * chore: migrated more packages to tsup * chore: migrate code and character extensions to tsup * chore: update package.json to simplify build for all packages * chore: move all packages to tsup as a build process * chore: change ci build task * feat(pm): add prosemirror meta package * rfix: resolve issues with build paths & export mappings * docs: update documentation to include notes for @tiptap/pm * chore(pm): update tsconfig * chore(packages): update packages * fix(pm): add package export infos & fix dependencies * chore(general): start moving to pm package as deps * chore: move to tiptap pm package internally * fix(demos): fix demos working with new pm package * fix(tables): fix tables package * fix(tables): fix tables package * chore(demos): pinned typescript version * chore: remove unnecessary tsconfig * chore: fix netlify build * fix(demos): fix package resolving for pm packages * fix(tests): fix package resolving for pm packages * fix(tests): fix package resolving for pm packages * chore(tests): fix tests not running correctly after pm package * chore(pm): add files to files array * chore: update build workflow * chore(tests): increase timeout time back to 12s * chore(docs): update docs * chore(docs): update installation guides & pm information to docs * chore(docs): add link to prosemirror docs * fix(vue-3): add missing build step * chore(docs): comment out cdn link * chore(docs): remove semicolons from docs * chore(docs): remove unnecessary installation note * chore(docs): remove unnecessary installation note
3.5 KiB
title | tableOfContents |
---|---|
Svelte WYSIWYG | true |
Svelte
Introduction
The following guide describes how to integrate Tiptap with your SvelteKit project.
Take a shortcut: Svelte REPL with Tiptap
If you just want to jump into it right-away, here is a Svelte REPL with Tiptap installed.
Requirements
1. Create a project (optional)
If you already have an existing SvelteKit 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 SvelteKit project called my-tiptap-project
. The following commands set up everything we need. It asks a lot of questions, but just use what floats your boat or use the defaults.
npm create svelte@latest my-tiptap-project
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 the @tiptap/core
package, with a few components, @tiptap/pm
and @tiptap/starter-kit
which has the most common extensions to get started quickly.
npm install @tiptap/core @tiptap/pm @tiptap/starter-kit
If you followed step 1 and 2, you can now start your project with npm run dev
, and open http://localhost:3000/ 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/lib/Tiptap.svelte
.
This is the fastest way to get Tiptap up and running with SvelteKit. It will give you a very basic version of Tiptap, without any buttons. No worries, you will be able to add more functionality soon.
<script>
import { onMount, onDestroy } from 'svelte'
import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
let element
let editor
onMount(() => {
editor = new Editor({
element: element,
extensions: [
StarterKit,
],
content: '<p>Hello World! 🌍️ </p>',
onTransaction: () => {
// force re-render so `editor.isActive` works as expected
editor = editor
},
})
})
onDestroy(() => {
if (editor) {
editor.destroy()
}
})
</script>
{#if editor}
<button
on:click={() => editor.chain().focus().toggleHeading({ level: 1}).run()}
class:active={editor.isActive('heading', { level: 1 })}
>
H1
</button>
<button
on:click={() => editor.chain().focus().toggleHeading({ level: 2 }).run()}
class:active={editor.isActive('heading', { level: 2 })}
>
H2
</button>
<button on:click={() => editor.chain().focus().setParagraph().run()} class:active={editor.isActive('paragraph')}>
P
</button>
{/if}
<div bind:this={element} />
<style>
button.active {
background: black;
color: white;
}
</style>
4. Add it to your app
Now, let’s replace the content of src/routes/+page.svelte
with the following example code to use our new Tiptap
component in our app.
<script>
import Tiptap from '$lib/Tiptap.svelte'
</script>
<main>
<Tiptap />
</main>
You should now see Tiptap in your browser. Time to give yourself a pat on the back! :)