@blocknote/core 0.13.2 → 0.13.4

package/src/api/exporters/markdown/util/addSpacesToCheckboxesRehypePlugin.ts

@@ -0,0 +1,42 @@
+import { Element as HASTElement, Parent as HASTParent } from "hast";
+import { fromDom } from "hast-util-from-dom";
+
+/**
+ * Rehype plugin which adds a space after each checkbox input element. This is
+ * because remark doesn't add any spaces between the checkbox input and the text
+ * itself, but these are needed for correct Markdown syntax.
+ */
+export function addSpacesToCheckboxes() {
+  const helper = (tree: HASTParent) => {
+    if (tree.children && "length" in tree.children && tree.children.length) {
+      for (let i = tree.children.length - 1; i >= 0; i--) {
+        const child = tree.children[i];
+        const nextChild =
+          i + 1 < tree.children.length ? tree.children[i + 1] : undefined;
+
+        // Checks for paragraph element after checkbox input element.
+        if (
+          child.type === "element" &&
+          child.tagName === "input" &&
+          child.properties?.type === "checkbox" &&
+          nextChild?.type === "element" &&
+          nextChild.tagName === "p"
+        ) {
+          // Converts paragraph to span, otherwise remark will think it needs to
+          // be on a new line.
+          nextChild.tagName = "span";
+          // Adds a space after the checkbox input element.
+          nextChild.children.splice(
+            0,
+            0,
+            fromDom(document.createTextNode(" ")) as HASTElement
+          );
+        } else {
+          helper(child as HASTParent);
+        }
+      }
+    }
+  };
+
+  return helper;
+}

package/src/api/nodeConversions/__snapshots__/nodeConversions.test.ts.snap

@@ -217,6 +217,134 @@ exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert
 }
 `;
 
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert file/basic to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "caption": "Caption",
+        "name": "example",
+        "url": "exampleURL",
+      },
+      "type": "file",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert file/button to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "caption": "",
+        "name": "",
+        "url": "",
+      },
+      "type": "file",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert file/nested to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "caption": "Caption",
+        "name": "example",
+        "url": "exampleURL",
+      },
+      "type": "file",
+    },
+    {
+      "content": [
+        {
+          "attrs": {
+            "backgroundColor": "default",
+            "id": "2",
+            "textColor": "default",
+          },
+          "content": [
+            {
+              "attrs": {
+                "caption": "Caption",
+                "name": "example",
+                "url": "exampleURL",
+              },
+              "type": "file",
+            },
+          ],
+          "type": "blockContainer",
+        },
+      ],
+      "type": "blockGroup",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert file/noCaption to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "caption": "",
+        "name": "example",
+        "url": "exampleURL",
+      },
+      "type": "file",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert file/noName to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "caption": "Caption",
+        "name": "",
+        "url": "exampleURL",
+      },
+      "type": "file",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
 exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert hardbreak/basic to/from prosemirror 1`] = `
 {
   "attrs": {
@@ -524,9 +652,11 @@ exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert
     {
       "attrs": {
         "caption": "Caption",
+        "name": "example",
+        "previewWidth": 256,
+        "showPreview": true,
         "textAlignment": "left",
         "url": "exampleURL",
-        "width": 256,
       },
       "type": "image",
     },
@@ -546,9 +676,11 @@ exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert
     {
       "attrs": {
         "caption": "",
+        "name": "",
+        "previewWidth": 512,
+        "showPreview": true,
         "textAlignment": "left",
         "url": "",
-        "width": 512,
       },
       "type": "image",
     },
@@ -568,9 +700,11 @@ exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert
     {
       "attrs": {
         "caption": "Caption",
+        "name": "",
+        "previewWidth": 256,
+        "showPreview": true,
         "textAlignment": "left",
         "url": "exampleURL",
-        "width": 256,
       },
       "type": "image",
     },
@@ -586,9 +720,11 @@ exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert
             {
               "attrs": {
                 "caption": "Caption",
+                "name": "",
+                "previewWidth": 256,
+                "showPreview": true,
                 "textAlignment": "left",
                 "url": "exampleURL",
-                "width": 256,
               },
               "type": "image",
             },
@@ -603,6 +739,78 @@ exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert
 }
 `;
 
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert image/noCaption to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "caption": "",
+        "name": "example",
+        "previewWidth": 256,
+        "showPreview": true,
+        "textAlignment": "left",
+        "url": "exampleURL",
+      },
+      "type": "image",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert image/noName to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "caption": "Caption",
+        "name": "",
+        "previewWidth": 256,
+        "showPreview": true,
+        "textAlignment": "left",
+        "url": "exampleURL",
+      },
+      "type": "image",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert image/noPreview to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "caption": "Caption",
+        "name": "example",
+        "previewWidth": 256,
+        "showPreview": false,
+        "textAlignment": "left",
+        "url": "exampleURL",
+      },
+      "type": "image",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
 exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert link/adjacent to/from prosemirror 1`] = `
 {
   "attrs": {
@@ -744,6 +952,56 @@ exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert
 }
 `;
 
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert lists/basic to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "textAlignment": "left",
+      },
+      "content": [
+        {
+          "text": "Bullet List Item 1",
+          "type": "text",
+        },
+      ],
+      "type": "bulletListItem",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
+exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert lists/nested to/from prosemirror 1`] = `
+{
+  "attrs": {
+    "backgroundColor": "default",
+    "id": "1",
+    "textColor": "default",
+  },
+  "content": [
+    {
+      "attrs": {
+        "textAlignment": "left",
+      },
+      "content": [
+        {
+          "text": "Bullet List Item 1",
+          "type": "text",
+        },
+      ],
+      "type": "bulletListItem",
+    },
+  ],
+  "type": "blockContainer",
+}
+`;
+
 exports[`Test BlockNote-Prosemirror conversion > Case: default schema > Convert paragraph/basic to/from prosemirror 1`] = `
 {
   "attrs": {

package/src/api/parsers/html/__snapshots__/paste/list-test.json

@@ -52,6 +52,42 @@
   },
   {
     "id": "4",
+    "type": "checkListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "checked": false
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Fourth",
+        "styles": {}
+      }
+    ],
+    "children": []
+  },
+  {
+    "id": "5",
+    "type": "checkListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "checked": false
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Fifth",
+        "styles": {}
+      }
+    ],
+    "children": []
+  },
+  {
+    "id": "6",
     "type": "bulletListItem",
     "props": {
       "textColor": "default",
@@ -67,7 +103,7 @@
     ],
     "children": [
       {
-        "id": "5",
+        "id": "7",
         "type": "bulletListItem",
         "props": {
           "textColor": "default",
@@ -84,7 +120,7 @@
         "children": []
       },
       {
-        "id": "6",
+        "id": "8",
         "type": "bulletListItem",
         "props": {
           "textColor": "default",
@@ -99,6 +135,42 @@
           }
         ],
         "children": []
+      },
+      {
+        "id": "9",
+        "type": "checkListItem",
+        "props": {
+          "textColor": "default",
+          "backgroundColor": "default",
+          "textAlignment": "left",
+          "checked": false
+        },
+        "content": [
+          {
+            "type": "text",
+            "text": "Child 3",
+            "styles": {}
+          }
+        ],
+        "children": []
+      },
+      {
+        "id": "10",
+        "type": "checkListItem",
+        "props": {
+          "textColor": "default",
+          "backgroundColor": "default",
+          "textAlignment": "left",
+          "checked": false
+        },
+        "content": [
+          {
+            "type": "text",
+            "text": "Child 4",
+            "styles": {}
+          }
+        ],
+        "children": []
       }
     ]
   }

package/src/api/parsers/html/__snapshots__/paste/parse-basic-block-types.json

@@ -76,9 +76,11 @@
     "props": {
       "backgroundColor": "default",
       "textAlignment": "left",
+      "name": "",
       "url": "exampleURL",
       "caption": "Image Caption",
-      "width": 512
+      "showPreview": true,
+      "previewWidth": 512
     },
     "children": []
   },

package/src/api/parsers/html/__snapshots__/paste/parse-fake-image-caption.json

@@ -5,9 +5,11 @@
     "props": {
       "backgroundColor": "default",
       "textAlignment": "left",
+      "name": "",
       "url": "exampleURL",
       "caption": "",
-      "width": 512
+      "showPreview": true,
+      "previewWidth": 512
     },
     "children": []
   },

package/src/api/parsers/html/__snapshots__/paste/parse-mixed-nested-lists.json

@@ -14,9 +14,26 @@
         "styles": {}
       }
     ],
+    "children": []
+  },
+  {
+    "id": "2",
+    "type": "bulletListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left"
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Bullet List Item",
+        "styles": {}
+      }
+    ],
     "children": [
       {
-        "id": "2",
+        "id": "3",
         "type": "numberedListItem",
         "props": {
           "textColor": "default",
@@ -33,7 +50,7 @@
         "children": []
       },
       {
-        "id": "3",
+        "id": "4",
         "type": "numberedListItem",
         "props": {
           "textColor": "default",
@@ -52,7 +69,7 @@
     ]
   },
   {
-    "id": "4",
+    "id": "5",
     "type": "bulletListItem",
     "props": {
       "textColor": "default",
@@ -69,7 +86,78 @@
     "children": []
   },
   {
-    "id": "5",
+    "id": "6",
+    "type": "numberedListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left"
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Numbered List Item",
+        "styles": {}
+      }
+    ],
+    "children": []
+  },
+  {
+    "id": "7",
+    "type": "numberedListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left"
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Numbered List Item",
+        "styles": {}
+      }
+    ],
+    "children": [
+      {
+        "id": "8",
+        "type": "checkListItem",
+        "props": {
+          "textColor": "default",
+          "backgroundColor": "default",
+          "textAlignment": "left",
+          "checked": true
+        },
+        "content": [
+          {
+            "type": "text",
+            "text": "Nested Check List Item",
+            "styles": {}
+          }
+        ],
+        "children": []
+      },
+      {
+        "id": "9",
+        "type": "checkListItem",
+        "props": {
+          "textColor": "default",
+          "backgroundColor": "default",
+          "textAlignment": "left",
+          "checked": false
+        },
+        "content": [
+          {
+            "type": "text",
+            "text": "Nested Check List Item",
+            "styles": {}
+          }
+        ],
+        "children": []
+      }
+    ]
+  },
+  {
+    "id": "10",
     "type": "numberedListItem",
     "props": {
       "textColor": "default",
@@ -83,9 +171,45 @@
         "styles": {}
       }
     ],
+    "children": []
+  },
+  {
+    "id": "11",
+    "type": "checkListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "checked": true
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Check List Item",
+        "styles": {}
+      }
+    ],
+    "children": []
+  },
+  {
+    "id": "12",
+    "type": "checkListItem",
+    "props": {
+      "textColor": "default",
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "checked": false
+    },
+    "content": [
+      {
+        "type": "text",
+        "text": "Check List Item",
+        "styles": {}
+      }
+    ],
     "children": [
       {
-        "id": "6",
+        "id": "13",
         "type": "bulletListItem",
         "props": {
           "textColor": "default",
@@ -102,7 +226,7 @@
         "children": []
       },
       {
-        "id": "7",
+        "id": "14",
         "type": "bulletListItem",
         "props": {
           "textColor": "default",
@@ -121,17 +245,18 @@
     ]
   },
   {
-    "id": "8",
-    "type": "numberedListItem",
+    "id": "15",
+    "type": "checkListItem",
     "props": {
       "textColor": "default",
       "backgroundColor": "default",
-      "textAlignment": "left"
+      "textAlignment": "left",
+      "checked": true
     },
     "content": [
       {
         "type": "text",
-        "text": "Numbered List Item",
+        "text": "Nested Check List Item",
         "styles": {}
       }
     ],