Get started - Get started with Liveblocks, Quill, Yjs, and JavaScript

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

Quickstart

  1. Install Liveblocks, Yjs, and Quill

    $npm install @liveblocks/client @liveblocks/yjs yjs quill quill-cursors y-quill
  2. Create an HTML element

    <div id="editor"></div>
  3. Set up your collaborative Quill text editor

    app.js
    import { createClient } from "@liveblocks/client";import LiveblocksProvider from "@liveblocks/yjs";import * as Y from "yjs";import Quill from "quill";import { QuillBinding } from "y-quill";import QuillCursors from "quill-cursors";
    // Set up Liveblocks clientconst client = createClient({ publicApiKey: "",});
    // Enter a multiplayer roomconst { room, leave } = client.enterRoom("my-room", { initialPresence: {},});
    // Set up Yjs document, shared text, and Liveblocks Yjs providerconst yDoc = new Y.Doc();const yText = yDoc.getText("quill");const yProvider = new LiveblocksProvider(room, yDoc);
    // Attach cursors pluginQuill.register("modules/cursors", QuillCursors);
    // Set up Quill editor and modulesconst parent = document.querySelector("#editor");const quill = new Quill(parent, { placeholder: "Start collaborating…", theme: "snow", modules: { cursors: true, toolbar: [ [{ header: [1, 2, false] }], ["bold", "italic", "underline"], ["code-block"], ], history: { // Local undo shouldn’t undo changes made by other users userOnly: true, }, },});
    // Attach Yjs to Quillconst binding = new QuillBinding(yText, quill, provider.awareness);
  4. 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 Quill text editor inside your JavaScript application.