TypeCellOS · nperez0111 · Sep 24, 2025 · Sep 22, 2025 · Sep 22, 2025 · Sep 22, 2025
diff --git a/docs/package.json b/docs/package.json
@@ -140,4 +140,4 @@
     "y-partykit": "^0.0.33",
     "yjs": "^13.6.27"
   }
-}
+}
diff --git a/examples/07-collaboration/04-electric-sql/.bnexample.json b/examples/07-collaboration/04-electric-sql/.bnexample.json
@@ -0,0 +1,6 @@
+{
+  "playground": true,
+  "docs": true,
+  "author": "matthewlipski",
+  "tags": ["Advanced", "Saving/Loading", "Collaboration"]
+}
diff --git a/examples/07-collaboration/04-electric-sql/README.md b/examples/07-collaboration/04-electric-sql/README.md
@@ -0,0 +1,11 @@
+# Collaborative Editing with ElectricSQL
+
+In this example, we use ElectricSQL to let multiple users collaborate on a single BlockNote document in real-time. The setup for this demo is more involved than the other collaboration examples, as it requires a running server and has a more fully-fledged UI. Therefore, the demo just uses an iframe element to show a hosted instance of the full ElectricSQL + BlockNote setup, which you can find the code for [here](https://github.com/TypeCellOS/blocknote-electric-example).
+
+**Try it out:** Open this page (or the [iframe url](https://blocknote-electric-example.vercel.app/)) in a new browser tab or window to see it in action!
+
+**Relevant Docs:**
+
+- [Editor Setup](/docs/getting-started/editor-setup)
+- [Real-time collaboration](/docs/features/collaboration)
+- [ElectricSQL](https://electric-sql.com/)
diff --git a/examples/07-collaboration/04-electric-sql/index.html b/examples/07-collaboration/04-electric-sql/index.html
@@ -0,0 +1,14 @@
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Collaborative Editing with ElectricSQL</title>
+    <script>
+      <!-- AUTO-GENERATED FILE, DO NOT EDIT DIRECTLY -->
+    </script>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="./main.tsx"></script>
+  </body>
+</html>
diff --git a/...les/07-collaboration/04-comments/main.tsx → ...07-collaboration/04-electric-sql/main.tsx b/...les/07-collaboration/04-comments/main.tsx → ...07-collaboration/04-electric-sql/main.tsx
diff --git a/examples/07-collaboration/04-electric-sql/package.json b/examples/07-collaboration/04-electric-sql/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "@blocknote/example-collaboration-electric-sql",
+  "description": "AUTO-GENERATED FILE, DO NOT EDIT DIRECTLY",
+  "private": true,
+  "version": "0.12.4",
+  "scripts": {
+    "start": "vite",
+    "dev": "vite",
+    "build:prod": "tsc && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@blocknote/core": "latest",
+    "@blocknote/react": "latest",
+    "@blocknote/ariakit": "latest",
+    "@blocknote/mantine": "latest",
+    "@blocknote/shadcn": "latest",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.1.0",
+    "@types/react-dom": "^19.1.0",
+    "@vitejs/plugin-react": "^4.3.1",
+    "vite": "^5.3.4"
+  }
+}
diff --git a/examples/07-collaboration/04-electric-sql/src/App.tsx b/examples/07-collaboration/04-electric-sql/src/App.tsx
@@ -0,0 +1,11 @@
+import "./style.css";
+
+export default function App() {
+  return (
+    <iframe
+      src="https://blocknote-electric-example.vercel.app/"
+      height="100%"
+      width="100%"
+    />
+  );
+}
diff --git a/examples/07-collaboration/04-electric-sql/src/style.css b/examples/07-collaboration/04-electric-sql/src/style.css
@@ -0,0 +1,3 @@
+iframe {
+  border: none;
+}
diff --git a/...7-collaboration/04-comments/tsconfig.json → ...llaboration/04-electric-sql/tsconfig.json b/...7-collaboration/04-comments/tsconfig.json → ...llaboration/04-electric-sql/tsconfig.json
diff --git a/...-collaboration/04-comments/vite.config.ts → ...laboration/04-electric-sql/vite.config.ts b/...-collaboration/04-comments/vite.config.ts → ...laboration/04-electric-sql/vite.config.ts
diff --git a/...collaboration/04-comments/.bnexample.json → ...collaboration/05-comments/.bnexample.json b/...collaboration/04-comments/.bnexample.json → ...collaboration/05-comments/.bnexample.json
diff --git a/...es/07-collaboration/04-comments/README.md → ...es/07-collaboration/05-comments/README.md b/...es/07-collaboration/04-comments/README.md → ...es/07-collaboration/05-comments/README.md
diff --git a/...s/07-collaboration/04-comments/index.html → ...s/07-collaboration/05-comments/index.html b/...s/07-collaboration/04-comments/index.html → ...s/07-collaboration/05-comments/index.html
diff --git a/...oration/05-comments-with-sidebar/main.tsx → ...les/07-collaboration/05-comments/main.tsx b/...oration/05-comments-with-sidebar/main.tsx → ...les/07-collaboration/05-comments/main.tsx
diff --git a/...07-collaboration/04-comments/package.json → ...07-collaboration/05-comments/package.json b/...07-collaboration/04-comments/package.json → ...07-collaboration/05-comments/package.json
diff --git a/.../07-collaboration/04-comments/src/App.tsx → .../07-collaboration/05-comments/src/App.tsx b/.../07-collaboration/04-comments/src/App.tsx → .../07-collaboration/05-comments/src/App.tsx
diff --git a/...ration/04-comments/src/SettingsSelect.tsx → ...ration/05-comments/src/SettingsSelect.tsx b/...ration/04-comments/src/SettingsSelect.tsx → ...ration/05-comments/src/SettingsSelect.tsx
diff --git a/...7-collaboration/04-comments/src/style.css → ...7-collaboration/05-comments/src/style.css b/...7-collaboration/04-comments/src/style.css → ...7-collaboration/05-comments/src/style.css
diff --git a/...collaboration/04-comments/src/userdata.ts → ...collaboration/05-comments/src/userdata.ts b/...collaboration/04-comments/src/userdata.ts → ...collaboration/05-comments/src/userdata.ts
diff --git a/...on/05-comments-with-sidebar/tsconfig.json → ...7-collaboration/05-comments/tsconfig.json b/...on/05-comments-with-sidebar/tsconfig.json → ...7-collaboration/05-comments/tsconfig.json
diff --git a/...n/05-comments-with-sidebar/vite.config.ts → ...-collaboration/05-comments/vite.config.ts b/...n/05-comments-with-sidebar/vite.config.ts → ...-collaboration/05-comments/vite.config.ts
diff --git a/.../05-comments-with-sidebar/.bnexample.json → .../06-comments-with-sidebar/.bnexample.json b/.../05-comments-with-sidebar/.bnexample.json → .../06-comments-with-sidebar/.bnexample.json
diff --git a/...ration/05-comments-with-sidebar/README.md → ...ration/06-comments-with-sidebar/README.md b/...ration/05-comments-with-sidebar/README.md → ...ration/06-comments-with-sidebar/README.md
diff --git a/...ation/05-comments-with-sidebar/index.html → ...ation/06-comments-with-sidebar/index.html b/...ation/05-comments-with-sidebar/index.html → ...ation/06-comments-with-sidebar/index.html
diff --git a/...07-collaboration/06-ghost-writer/main.tsx → ...oration/06-comments-with-sidebar/main.tsx b/...07-collaboration/06-ghost-writer/main.tsx → ...oration/06-comments-with-sidebar/main.tsx
diff --git a/...ion/05-comments-with-sidebar/package.json → ...ion/06-comments-with-sidebar/package.json b/...ion/05-comments-with-sidebar/package.json → ...ion/06-comments-with-sidebar/package.json
diff --git a/...tion/05-comments-with-sidebar/src/App.tsx → ...tion/06-comments-with-sidebar/src/App.tsx b/...tion/05-comments-with-sidebar/src/App.tsx → ...tion/06-comments-with-sidebar/src/App.tsx
diff --git a/...ments-with-sidebar/src/SettingsSelect.tsx → ...ments-with-sidebar/src/SettingsSelect.tsx b/...ments-with-sidebar/src/SettingsSelect.tsx → ...ments-with-sidebar/src/SettingsSelect.tsx
diff --git a/...on/05-comments-with-sidebar/src/style.css → ...on/06-comments-with-sidebar/src/style.css b/...on/05-comments-with-sidebar/src/style.css → ...on/06-comments-with-sidebar/src/style.css
diff --git a/.../05-comments-with-sidebar/src/userdata.ts → .../06-comments-with-sidebar/src/userdata.ts b/.../05-comments-with-sidebar/src/userdata.ts → .../06-comments-with-sidebar/src/userdata.ts
diff --git a/...llaboration/06-ghost-writer/tsconfig.json → ...on/06-comments-with-sidebar/tsconfig.json b/...llaboration/06-ghost-writer/tsconfig.json → ...on/06-comments-with-sidebar/tsconfig.json
diff --git a/...laboration/06-ghost-writer/vite.config.ts → ...n/06-comments-with-sidebar/vite.config.ts b/...laboration/06-ghost-writer/vite.config.ts → ...n/06-comments-with-sidebar/vite.config.ts
diff --git a/...aboration/06-ghost-writer/.bnexample.json → ...aboration/07-ghost-writer/.bnexample.json b/...aboration/06-ghost-writer/.bnexample.json → ...aboration/07-ghost-writer/.bnexample.json
diff --git a/...7-collaboration/06-ghost-writer/README.md → ...7-collaboration/07-ghost-writer/README.md b/...7-collaboration/06-ghost-writer/README.md → ...7-collaboration/07-ghost-writer/README.md
diff --git a/...-collaboration/06-ghost-writer/index.html → ...-collaboration/07-ghost-writer/index.html b/...-collaboration/06-ghost-writer/index.html → ...-collaboration/07-ghost-writer/index.html
diff --git a/...ples/07-collaboration/07-forking/main.tsx → ...07-collaboration/07-ghost-writer/main.tsx b/...ples/07-collaboration/07-forking/main.tsx → ...07-collaboration/07-ghost-writer/main.tsx
diff --git a/...ollaboration/06-ghost-writer/package.json → ...ollaboration/07-ghost-writer/package.json b/...ollaboration/06-ghost-writer/package.json → ...ollaboration/07-ghost-writer/package.json
diff --git a/...collaboration/06-ghost-writer/src/App.tsx → ...collaboration/07-ghost-writer/src/App.tsx b/...collaboration/06-ghost-writer/src/App.tsx → ...collaboration/07-ghost-writer/src/App.tsx
diff --git a/...laboration/06-ghost-writer/src/styles.css → ...laboration/07-ghost-writer/src/styles.css b/...laboration/06-ghost-writer/src/styles.css → ...laboration/07-ghost-writer/src/styles.css
diff --git a/...07-collaboration/07-forking/tsconfig.json → ...llaboration/07-ghost-writer/tsconfig.json b/...07-collaboration/07-forking/tsconfig.json → ...llaboration/07-ghost-writer/tsconfig.json
diff --git a/...7-collaboration/07-forking/vite.config.ts → ...laboration/07-ghost-writer/vite.config.ts b/...7-collaboration/07-forking/vite.config.ts → ...laboration/07-ghost-writer/vite.config.ts
diff --git a/...-collaboration/07-forking/.bnexample.json → ...-collaboration/08-forking/.bnexample.json b/...-collaboration/07-forking/.bnexample.json → ...-collaboration/08-forking/.bnexample.json
diff --git a/...les/07-collaboration/07-forking/README.md → ...les/07-collaboration/08-forking/README.md b/...les/07-collaboration/07-forking/README.md → ...les/07-collaboration/08-forking/README.md
diff --git a/...es/07-collaboration/07-forking/index.html → ...es/07-collaboration/08-forking/index.html b/...es/07-collaboration/07-forking/index.html → ...es/07-collaboration/08-forking/index.html
diff --git a/examples/07-collaboration/08-forking/main.tsx b/examples/07-collaboration/08-forking/main.tsx
@@ -0,0 +1,11 @@
+// AUTO-GENERATED FILE, DO NOT EDIT DIRECTLY
+import React from "react";
+import { createRoot } from "react-dom/client";
+import App from "./src/App.jsx";
+
+const root = createRoot(document.getElementById("root")!);
+root.render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>
+);
diff --git a/.../07-collaboration/07-forking/package.json → .../07-collaboration/08-forking/package.json b/.../07-collaboration/07-forking/package.json → .../07-collaboration/08-forking/package.json
diff --git a/...s/07-collaboration/07-forking/src/App.tsx → ...s/07-collaboration/08-forking/src/App.tsx b/...s/07-collaboration/07-forking/src/App.tsx → ...s/07-collaboration/08-forking/src/App.tsx
diff --git a/examples/07-collaboration/08-forking/tsconfig.json b/examples/07-collaboration/08-forking/tsconfig.json
@@ -0,0 +1,36 @@
+{
+  "__comment": "AUTO-GENERATED FILE, DO NOT EDIT DIRECTLY",
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "lib": [
+      "DOM",
+      "DOM.Iterable",
+      "ESNext"
+    ],
+    "allowJs": false,
+    "skipLibCheck": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+    "composite": true
+  },
+  "include": [
+    "."
+  ],
+  "__ADD_FOR_LOCAL_DEV_references": [
+    {
+      "path": "../../../packages/core/"
+    },
+    {
+      "path": "../../../packages/react/"
+    }
+  ]
+}
diff --git a/examples/07-collaboration/08-forking/vite.config.ts b/examples/07-collaboration/08-forking/vite.config.ts
@@ -0,0 +1,32 @@
+// AUTO-GENERATED FILE, DO NOT EDIT DIRECTLY
+import react from "@vitejs/plugin-react";
+import * as fs from "fs";
+import * as path from "path";
+import { defineConfig } from "vite";
+// import eslintPlugin from "vite-plugin-eslint";
+// https://vitejs.dev/config/
+export default defineConfig((conf) => ({
+  plugins: [react()],
+  optimizeDeps: {},
+  build: {
+    sourcemap: true,
+  },
+  resolve: {
+    alias:
+      conf.command === "build" ||
+      !fs.existsSync(path.resolve(__dirname, "../../packages/core/src"))
+        ? {}
+        : ({
+            // Comment out the lines below to load a built version of blocknote
+            // or, keep as is to load live from sources with live reload working
+            "@blocknote/core": path.resolve(
+              __dirname,
+              "../../packages/core/src/"
+            ),
+            "@blocknote/react": path.resolve(
+              __dirname,
+              "../../packages/react/src/"
+            ),
+          } as any),
+  },
+}));
diff --git a/playground/src/examples.gen.tsx b/playground/src/examples.gen.tsx
@@ -1427,10 +1427,31 @@
         },
         "readme": "In this example, we use Y-Sweet to let multiple users collaborate on a single BlockNote document in real-time.\n\n**Try it out:** Open the [Y-Sweet BlockNote demo](https://demos.y-sweet.dev/blocknote) in multiple browser tabs to see it in action!\n\n**Relevant Docs:**\n\n- [Editor Setup](/docs/getting-started/editor-setup)\n- [Real-time collaboration](/docs/features/collaboration)\n- [Y-Sweet on Jamsocket](https://docs.jamsocket.com/y-sweet/tutorials/blocknote)"
       },
+      {
+        "projectSlug": "electric-sql",
+        "fullSlug": "collaboration/electric-sql",
+        "pathFromRoot": "examples/07-collaboration/04-electric-sql",
+        "config": {
+          "playground": true,
+          "docs": true,
+          "author": "matthewlipski",
+          "tags": [
+            "Advanced",
+            "Saving/Loading",
+            "Collaboration"
+          ]
+        },
+        "title": "Collaborative Editing with ElectricSQL",
+        "group": {
+          "pathFromRoot": "examples/07-collaboration",
+          "slug": "collaboration"
+        },
+        "readme": "In this example, we use ElectricSQL to let multiple users collaborate on a single BlockNote document in real-time. The setup for this demo is more involved than the other collaboration examples, as it requires a running server and has a more fully-fledged UI. Therefore, the demo just uses an iframe element to show a hosted instance of the full ElectricSQL + BlockNote setup, which you can find the code for [here](https://github.com/TypeCellOS/blocknote-electric-example).\n\n**Try it out:** Open this page (or the [iframe url](https://blocknote-electric-example.vercel.app/)) in a new browser tab or window to see it in action!\n\n**Relevant Docs:**\n\n- [Editor Setup](/docs/getting-started/editor-setup)\n- [Real-time collaboration](/docs/features/collaboration)\n- [ElectricSQL](https://electric-sql.com/)"
+      },
       {
         "projectSlug": "comments",
         "fullSlug": "collaboration/comments",
-        "pathFromRoot": "examples/07-collaboration/04-comments",
+        "pathFromRoot": "examples/07-collaboration/05-comments",
         "config": {
           "playground": true,
           "docs": true,
@@ -1455,7 +1476,7 @@
       {
         "projectSlug": "comments-with-sidebar",
         "fullSlug": "collaboration/comments-with-sidebar",
-        "pathFromRoot": "examples/07-collaboration/05-comments-with-sidebar",
+        "pathFromRoot": "examples/07-collaboration/06-comments-with-sidebar",
         "config": {
           "playground": true,
           "docs": true,
@@ -1480,7 +1501,7 @@
       {
         "projectSlug": "ghost-writer",
         "fullSlug": "collaboration/ghost-writer",
-        "pathFromRoot": "examples/07-collaboration/06-ghost-writer",
+        "pathFromRoot": "examples/07-collaboration/07-ghost-writer",
         "config": {
           "playground": true,
           "docs": false,
@@ -1505,7 +1526,7 @@
       {
         "projectSlug": "forking",
         "fullSlug": "collaboration/forking",
-        "pathFromRoot": "examples/07-collaboration/07-forking",
+        "pathFromRoot": "examples/07-collaboration/08-forking",
         "config": {
           "playground": true,
           "docs": false,

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
-Original file line number
+Diff line change
@@ Expand Up / @@ -140,4 +140,4 @@ @@
         "y-partykit": "^0.0.33",
         "yjs": "^13.6.27"
       }
-    }
+    }