@pluv/crdt-yjs NPM

Disclaimer: This package is currently in preview and may have breaking changes between versions. Please wait for a v1.0.0 stable release before using this in production.

`@pluv/crdt-yjs`

Yjs adapter for @pluv/client and @pluv/io.

👉 See full documentation on pluv.io. 👈

Installation

Note This package is already re-exported from @pluv/client, @pluv/react and @pluv/io as y, so you likely do not need to install this directly.

# npm
npm install @pluv/crdt-yjs yjs

# yarn
yarn add @pluv/crdt-yjs yjs

# pnpm
pnpm add @pluv/crdt-yjs yjs

Basic Example

import { createClient } from "@pluv/client";
import { yjs } from "@pluv/crdt-yjs";
import { z } from "zod";
// Import the PluvIO instance as a type from your server file
import { type io } from "./server";

const client = createClient<typeof io>({ /* client config here */ });

// Create a room to join
const room = client.createRoom("my-room", {
    initialStorage: yjs.doc(() => ({
        editor: yjs.xmlFragment({
            children: [
                yjs.xmlElement("paragraph", {
                  children: [yjs.xmlText("Hello World!")],
                }),
            ]
        }),
        groceryList: yjs.map([
            ["apricots", 2],
            ["bread", 3],
            ["cheese", 5],
        ]),
        messages: yjs.array([]),
    })),
    presence: z.object({}),
});