fix: Minor collaboration cursor & docs changes (#1381)

* Small collaboration cursor fixes * Slight edit to dot and label height offsets * Small fix * - Updated collaboration docs with `showCursorLabels` option - Changed `all-blocks` example to `default-blocks`
TypeCellOS · Jan 20, 2025 · f4e7732 · f4e7732
1 parent 800a1f0
commit f4e7732
Show file tree

Hide file tree

Showing 15 changed files with 24 additions and 23 deletions.
diff --git a/docs/next.config.mjs b/docs/next.config.mjs
@@ -118,6 +118,11 @@ const nextConfig = withAnalyzer(
         destination: "/docs/advanced/vanilla-js",
         permanent: true,
       },
+      {
+        source: "/examples/basic/all-blocks",
+        destination: "/examples/basic/default-blocks",
+        permanent: true,
+      },
     ],
     experimental: {
       externalDir: true,

diff --git a/docs/pages/docs/advanced/real-time-collaboration.mdx b/docs/pages/docs/advanced/real-time-collaboration.mdx
@@ -38,6 +38,9 @@ const editor = useCreateBlockNote({
       name: "My Username",
       color: "#ff0000",
     },
+    // When to show user labels on the collaboration cursor. Set by default to
+    // "activity" (show when the cursor moves), but can also be set to "always".
+    showCursorLabels: "activity"
   },
   // ...
 });

diff --git a/docs/pages/docs/editor-basics/default-schema.mdx b/docs/pages/docs/editor-basics/default-schema.mdx
@@ -14,7 +14,7 @@ BlockNote supports a number of built-in blocks, inline content types, and styles
 
 The demo below showcases each of BlockNote's built-in block and inline content types:
 
-<Example name="basic/all-blocks" />
+<Example name="basic/default-blocks" />
 
 ## Default Blocks
 

diff --git a/examples/01-basic/04-all-blocks/.bnexample.json b/examples/01-basic/04-all-blocks/.bnexample.json
diff --git a/examples/01-basic/04-default-blocks/.bnexample.json b/examples/01-basic/04-default-blocks/.bnexample.json
@@ -0,0 +1,6 @@
+{
+  "playground": true,
+  "docs": true,
+  "author": "yousefed",
+  "tags": ["Basic", "Blocks", "Inline Content"]
+}
diff --git a/examples/01-basic/04-all-blocks/App.tsx → examples/01-basic/04-default-blocks/App.tsx b/examples/01-basic/04-all-blocks/App.tsx → examples/01-basic/04-default-blocks/App.tsx
diff --git a/examples/01-basic/04-all-blocks/README.md → ...ples/01-basic/04-default-blocks/README.md b/examples/01-basic/04-all-blocks/README.md → ...ples/01-basic/04-default-blocks/README.md
diff --git a/examples/01-basic/04-all-blocks/index.html → ...les/01-basic/04-default-blocks/index.html b/examples/01-basic/04-all-blocks/index.html → ...les/01-basic/04-default-blocks/index.html
diff --git a/examples/01-basic/04-all-blocks/main.tsx → examples/01-basic/04-default-blocks/main.tsx b/examples/01-basic/04-all-blocks/main.tsx → examples/01-basic/04-default-blocks/main.tsx
diff --git a/examples/01-basic/04-all-blocks/package.json → ...s/01-basic/04-default-blocks/package.json b/examples/01-basic/04-all-blocks/package.json → ...s/01-basic/04-default-blocks/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@blocknote/example-all-blocks",
+  "name": "@blocknote/example-default-blocks",
   "description": "AUTO-GENERATED FILE, DO NOT EDIT DIRECTLY",
   "private": true,
   "version": "0.12.4",
@@ -17,8 +17,7 @@
     "@blocknote/mantine": "latest",
     "@blocknote/shadcn": "latest",
     "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "@blocknote/xl-multi-column": "latest"
+    "react-dom": "^18.3.1"
   },
   "devDependencies": {
     "@types/react": "^18.0.25",

diff --git a/...ples/01-basic/04-all-blocks/tsconfig.json → .../01-basic/04-default-blocks/tsconfig.json b/...ples/01-basic/04-all-blocks/tsconfig.json → .../01-basic/04-default-blocks/tsconfig.json
diff --git a/...les/01-basic/04-all-blocks/vite.config.ts → ...01-basic/04-default-blocks/vite.config.ts b/...les/01-basic/04-all-blocks/vite.config.ts → ...01-basic/04-default-blocks/vite.config.ts
diff --git a/packages/core/src/editor/BlockNoteExtensions.ts b/packages/core/src/editor/BlockNoteExtensions.ts
@@ -298,7 +298,7 @@ const getTipTapExtensions = <
 
         cursorElement.classList.add("collaboration-cursor__caret");
         cursorElement.setAttribute("style", `border-color: ${color}`);
-        if (opts.collaboration?.showCursorLabels !== "always") {
+        if (opts.collaboration?.showCursorLabels === "always") {
           cursorElement.setAttribute("data-active", "");
         }
 

diff --git a/packages/core/src/editor/editor.css b/packages/core/src/editor/editor.css
@@ -104,7 +104,7 @@ Tippy popups that are appended to document.body directly
   max-height: 4px;
   max-width: 4px;
   padding: 0;
-  transform: translateY(3px);
+  top: 0;
 
   transition: all 0.2s;
 
@@ -115,7 +115,7 @@ Tippy popups that are appended to document.body directly
   max-height: 1.1rem;
   max-width: 20rem;
   padding: 0.1rem 0.3rem;
-  transform: translateY(-14px);
+  top: -14px;
 
   transition: all 0.2s;
 }

diff --git a/playground/src/examples.gen.tsx b/playground/src/examples.gen.tsx
@@ -65,9 +65,9 @@
         }
       },
       {
-        "projectSlug": "all-blocks",
-        "fullSlug": "basic/all-blocks",
-        "pathFromRoot": "examples/01-basic/04-all-blocks",
+        "projectSlug": "default-blocks",
+        "fullSlug": "basic/default-blocks",
+        "pathFromRoot": "examples/01-basic/04-default-blocks",
         "config": {
           "playground": true,
           "docs": true,
@@ -76,10 +76,7 @@
             "Basic",
             "Blocks",
             "Inline Content"
-          ],
-          "dependencies": {
-            "@blocknote/xl-multi-column": "latest"
-          } as any
+          ]
         },
         "title": "Default Schema Showcase",
         "group": {