Get started - Get started with Liveblocks, Tiptap, Yjs, and Svelte

Liveblocks is a real-time collaboration infrastructure for building performant collaborative experiences. Follow the following steps to start adding collaboration to your Svelte application using the APIs from the @liveblocks/yjs package.

Quickstart

  1. Install Liveblocks, Yjs, and Tiptap

    $npm install @liveblocks/client @liveblocks/yjs yjs @tiptap/core @tiptap/pm @tiptap/starter-kit  @tiptap/extension-collaboration @tiptap/extension-collaboration-cursor

  2. Set up your collaborative Tiptap text editor

    Editor.svelte
    <script>import { onMount, onDestroy } from "svelte";import { createClient } from "@liveblocks/client";import LiveblocksProvider from "@liveblocks/yjs";import * as Y from "yjs";import { Editor } from "@tiptap/core";import StarterKit from "@tiptap/starter-kit";import Collaboration from "@tiptap/extension-collaboration";import CollaborationCursor from "@tiptap/extension-collaboration-cursor";
    let element;const roomId = "my-room";
    // Set up Liveblocks clientconst client = createClient({  publicApiKey: "pk_prod_xxxxxxxxxxxxxxxxxxxxxxxx",});
    onMount(() => {  // Enter a multiplayer room  const room = client.enter(roomId, {    initialPresence: {},  });
      // Set up Yjs document, shared text, and Liveblocks Yjs provider  const yDoc = new Y.Doc();  const yText = yDoc.getText("tiptap");  const yProvider = new LiveblocksProvider(room, yDoc);
      // Set up the Tiptap editor  editor = new Editor({    element,    extensions: [      StarterKit.configure({        // The Collaboration extension comes with its own history handling        history: false,      }),      // Register the Yjs document with Tiptap      Collaboration.configure({        document: yDoc,      }),      CollaborationCursor.configure({        provider: yProvider,      }),    ],    onTransaction: () => {      // Force re-render so `editor.isActive` works as expected      editor = editor    },  });
      return () => {    editor.destroy();  };});
    onDestroy(() => {  client.leave(roomId);});</script>
    <div bind:this={element}></div>

  3. Next: set up authentication

    By default, Liveblocks is configured to work without an authentication endpoint where everyone automatically has access to rooms. This approach is great for prototyping and marketing pages where setting up your own security isn’t always required. If you want to limit access to a room for certain users, you’ll need to set up an authentication endpoint to enable permissions.

    Set up authentication

What to read next

Congratulations! You now have set up the foundation for your collaborative Tiptap text editor inside your Svelte application.