@tiptap/extension-table 2.5.0-beta.2 → 2.5.0-beta.3

package/dist/packages/extension-table/src/table.d.ts

@@ -1,194 +1,194 @@
-import { Node, ParentConfig } from '@tiptap/core';
-import { NodeView } from '@tiptap/pm/view';
-export interface TableOptions {
-    /**
-     * HTML attributes for the table element.
-     * @default {}
-     * @example { class: 'foo' }
-     */
-    HTMLAttributes: Record<string, any>;
-    /**
-     * Enables the resizing of tables.
-     * @default false
-     * @example true
-     */
-    resizable: boolean;
-    /**
-     * The width of the resize handle.
-     * @default 5
-     * @example 10
-     */
-    handleWidth: number;
-    /**
-     * The minimum width of a cell.
-     * @default 25
-     * @example 50
-     */
-    cellMinWidth: number;
-    /**
-     * The node view to render the table.
-     * @default TableView
-     */
-    View: NodeView;
-    /**
-     * Enables the resizing of the last column.
-     * @default true
-     * @example false
-     */
-    lastColumnResizable: boolean;
-    /**
-     * Allow table node selection.
-     * @default false
-     * @example true
-     */
-    allowTableNodeSelection: boolean;
-}
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        table: {
-            /**
-             * Insert a table
-             * @param options The table attributes
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.insertTable({ rows: 3, cols: 3, withHeaderRow: true })
-             */
-            insertTable: (options?: {
-                rows?: number;
-                cols?: number;
-                withHeaderRow?: boolean;
-            }) => ReturnType;
-            /**
-             * Add a column before the current column
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.addColumnBefore()
-            */
-            addColumnBefore: () => ReturnType;
-            /**
-             * Add a column after the current column
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.addColumnAfter()
-             */
-            addColumnAfter: () => ReturnType;
-            /**
-             * Delete the current column
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.deleteColumn()
-             */
-            deleteColumn: () => ReturnType;
-            /**
-             * Add a row before the current row
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.addRowBefore()
-             */
-            addRowBefore: () => ReturnType;
-            /**
-             * Add a row after the current row
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.addRowAfter()
-             */
-            addRowAfter: () => ReturnType;
-            /**
-             * Delete the current row
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.deleteRow()
-             */
-            deleteRow: () => ReturnType;
-            /**
-             * Delete the current table
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.deleteTable()
-             */
-            deleteTable: () => ReturnType;
-            /**
-             * Merge the currently selected cells
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.mergeCells()
-             */
-            mergeCells: () => ReturnType;
-            /**
-             * Split the currently selected cell
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.splitCell()
-             */
-            splitCell: () => ReturnType;
-            /**
-             * Toggle the header column
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.toggleHeaderColumn()
-             */
-            toggleHeaderColumn: () => ReturnType;
-            /**
-             * Toggle the header row
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.toggleHeaderRow()
-             */
-            toggleHeaderRow: () => ReturnType;
-            /**
-             * Toggle the header cell
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.toggleHeaderCell()
-             */
-            toggleHeaderCell: () => ReturnType;
-            /**
-             * Merge or split the currently selected cells
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.mergeOrSplit()
-             */
-            mergeOrSplit: () => ReturnType;
-            /**
-             * Set a cell attribute
-             * @param name The attribute name
-             * @param value The attribute value
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.setCellAttribute('align', 'right')
-             */
-            setCellAttribute: (name: string, value: any) => ReturnType;
-            /**
-             * Moves the selection to the next cell
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.goToNextCell()
-             */
-            goToNextCell: () => ReturnType;
-            /**
-             * Moves the selection to the previous cell
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.goToPreviousCell()
-             */
-            goToPreviousCell: () => ReturnType;
-            /**
-             * Try to fix the table structure if necessary
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.fixTables()
-             */
-            fixTables: () => ReturnType;
-            /**
-             * Set a cell selection inside the current table
-             * @param position The cell position
-             * @returns True if the command was successful, otherwise false
-             * @example editor.commands.setCellSelection({ anchorCell: 1, headCell: 2 })
-             */
-            setCellSelection: (position: {
-                anchorCell: number;
-                headCell?: number;
-            }) => ReturnType;
-        };
-    }
-    interface NodeConfig<Options, Storage> {
-        /**
-         * A string or function to determine the role of the table.
-         * @default 'table'
-         * @example () => 'table'
-         */
-        tableRole?: string | ((this: {
-            name: string;
-            options: Options;
-            storage: Storage;
-            parent: ParentConfig<NodeConfig<Options>>['tableRole'];
-        }) => string);
-    }
-}
-/**
- * This extension allows you to create tables.
- * @see https://www.tiptap.dev/api/nodes/table
- */
-export declare const Table: Node<TableOptions, any>;
+import { Node, ParentConfig } from '@tiptap/core';
+import { NodeView } from '@tiptap/pm/view';
+export interface TableOptions {
+    /**
+     * HTML attributes for the table element.
+     * @default {}
+     * @example { class: 'foo' }
+     */
+    HTMLAttributes: Record<string, any>;
+    /**
+     * Enables the resizing of tables.
+     * @default false
+     * @example true
+     */
+    resizable: boolean;
+    /**
+     * The width of the resize handle.
+     * @default 5
+     * @example 10
+     */
+    handleWidth: number;
+    /**
+     * The minimum width of a cell.
+     * @default 25
+     * @example 50
+     */
+    cellMinWidth: number;
+    /**
+     * The node view to render the table.
+     * @default TableView
+     */
+    View: NodeView;
+    /**
+     * Enables the resizing of the last column.
+     * @default true
+     * @example false
+     */
+    lastColumnResizable: boolean;
+    /**
+     * Allow table node selection.
+     * @default false
+     * @example true
+     */
+    allowTableNodeSelection: boolean;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        table: {
+            /**
+             * Insert a table
+             * @param options The table attributes
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.insertTable({ rows: 3, cols: 3, withHeaderRow: true })
+             */
+            insertTable: (options?: {
+                rows?: number;
+                cols?: number;
+                withHeaderRow?: boolean;
+            }) => ReturnType;
+            /**
+             * Add a column before the current column
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.addColumnBefore()
+            */
+            addColumnBefore: () => ReturnType;
+            /**
+             * Add a column after the current column
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.addColumnAfter()
+             */
+            addColumnAfter: () => ReturnType;
+            /**
+             * Delete the current column
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.deleteColumn()
+             */
+            deleteColumn: () => ReturnType;
+            /**
+             * Add a row before the current row
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.addRowBefore()
+             */
+            addRowBefore: () => ReturnType;
+            /**
+             * Add a row after the current row
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.addRowAfter()
+             */
+            addRowAfter: () => ReturnType;
+            /**
+             * Delete the current row
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.deleteRow()
+             */
+            deleteRow: () => ReturnType;
+            /**
+             * Delete the current table
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.deleteTable()
+             */
+            deleteTable: () => ReturnType;
+            /**
+             * Merge the currently selected cells
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.mergeCells()
+             */
+            mergeCells: () => ReturnType;
+            /**
+             * Split the currently selected cell
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.splitCell()
+             */
+            splitCell: () => ReturnType;
+            /**
+             * Toggle the header column
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.toggleHeaderColumn()
+             */
+            toggleHeaderColumn: () => ReturnType;
+            /**
+             * Toggle the header row
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.toggleHeaderRow()
+             */
+            toggleHeaderRow: () => ReturnType;
+            /**
+             * Toggle the header cell
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.toggleHeaderCell()
+             */
+            toggleHeaderCell: () => ReturnType;
+            /**
+             * Merge or split the currently selected cells
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.mergeOrSplit()
+             */
+            mergeOrSplit: () => ReturnType;
+            /**
+             * Set a cell attribute
+             * @param name The attribute name
+             * @param value The attribute value
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.setCellAttribute('align', 'right')
+             */
+            setCellAttribute: (name: string, value: any) => ReturnType;
+            /**
+             * Moves the selection to the next cell
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.goToNextCell()
+             */
+            goToNextCell: () => ReturnType;
+            /**
+             * Moves the selection to the previous cell
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.goToPreviousCell()
+             */
+            goToPreviousCell: () => ReturnType;
+            /**
+             * Try to fix the table structure if necessary
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.fixTables()
+             */
+            fixTables: () => ReturnType;
+            /**
+             * Set a cell selection inside the current table
+             * @param position The cell position
+             * @returns True if the command was successful, otherwise false
+             * @example editor.commands.setCellSelection({ anchorCell: 1, headCell: 2 })
+             */
+            setCellSelection: (position: {
+                anchorCell: number;
+                headCell?: number;
+            }) => ReturnType;
+        };
+    }
+    interface NodeConfig<Options, Storage> {
+        /**
+         * A string or function to determine the role of the table.
+         * @default 'table'
+         * @example () => 'table'
+         */
+        tableRole?: string | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<NodeConfig<Options>>['tableRole'];
+        }) => string);
+    }
+}
+/**
+ * This extension allows you to create tables.
+ * @see https://www.tiptap.dev/api/nodes/table
+ */
+export declare const Table: Node<TableOptions, any>;

package/dist/packages/extension-table/src/utilities/createCell.d.ts

@@ -1,2 +1,2 @@
-import { Fragment, Node as ProsemirrorNode, NodeType } from '@tiptap/pm/model';
-export declare function createCell(cellType: NodeType, cellContent?: Fragment | ProsemirrorNode | Array<ProsemirrorNode>): ProsemirrorNode | null | undefined;
+import { Fragment, Node as ProsemirrorNode, NodeType } from '@tiptap/pm/model';
+export declare function createCell(cellType: NodeType, cellContent?: Fragment | ProsemirrorNode | Array<ProsemirrorNode>): ProsemirrorNode | null | undefined;

package/dist/packages/extension-table/src/utilities/createColGroup.d.ts

@@ -1,19 +1,19 @@
-import { Node as ProseMirrorNode } from '@tiptap/pm/model';
-/**
- * Creates a colgroup element for a table node in ProseMirror.
- *
- * @param node - The ProseMirror node representing the table.
- * @param cellMinWidth - The minimum width of a cell in the table.
- * @param overrideCol - (Optional) The index of the column to override the width of.
- * @param overrideValue - (Optional) The width value to use for the overridden column.
- * @returns An object containing the colgroup element, the total width of the table, and the minimum width of the table.
- */
-export declare function createColGroup(node: ProseMirrorNode, cellMinWidth: number, overrideCol?: number, overrideValue?: any): {
-    colgroup?: undefined;
-    tableWidth?: undefined;
-    tableMinWidth?: undefined;
-} | {
-    colgroup: readonly [string, ...any[]];
-    tableWidth: string;
-    tableMinWidth: string;
-};
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+/**
+ * Creates a colgroup element for a table node in ProseMirror.
+ *
+ * @param node - The ProseMirror node representing the table.
+ * @param cellMinWidth - The minimum width of a cell in the table.
+ * @param overrideCol - (Optional) The index of the column to override the width of.
+ * @param overrideValue - (Optional) The width value to use for the overridden column.
+ * @returns An object containing the colgroup element, the total width of the table, and the minimum width of the table.
+ */
+export declare function createColGroup(node: ProseMirrorNode, cellMinWidth: number, overrideCol?: number, overrideValue?: any): {
+    colgroup?: undefined;
+    tableWidth?: undefined;
+    tableMinWidth?: undefined;
+} | {
+    colgroup: readonly [string, ...any[]];
+    tableWidth: string;
+    tableMinWidth: string;
+};

package/dist/packages/extension-table/src/utilities/createTable.d.ts

@@ -1,2 +1,2 @@
-import { Fragment, Node as ProsemirrorNode, Schema } from '@tiptap/pm/model';
-export declare function createTable(schema: Schema, rowsCount: number, colsCount: number, withHeaderRow: boolean, cellContent?: Fragment | ProsemirrorNode | Array<ProsemirrorNode>): ProsemirrorNode;
+import { Fragment, Node as ProsemirrorNode, Schema } from '@tiptap/pm/model';
+export declare function createTable(schema: Schema, rowsCount: number, colsCount: number, withHeaderRow: boolean, cellContent?: Fragment | ProsemirrorNode | Array<ProsemirrorNode>): ProsemirrorNode;

package/dist/packages/extension-table/src/utilities/deleteTableWhenAllCellsSelected.d.ts

@@ -1,2 +1,2 @@
-import { KeyboardShortcutCommand } from '@tiptap/core';
-export declare const deleteTableWhenAllCellsSelected: KeyboardShortcutCommand;
+import { KeyboardShortcutCommand } from '@tiptap/core';
+export declare const deleteTableWhenAllCellsSelected: KeyboardShortcutCommand;

package/dist/packages/extension-table/src/utilities/getTableNodeTypes.d.ts

@@ -1,4 +1,4 @@
-import { NodeType, Schema } from '@tiptap/pm/model';
-export declare function getTableNodeTypes(schema: Schema): {
-    [key: string]: NodeType;
-};
+import { NodeType, Schema } from '@tiptap/pm/model';
+export declare function getTableNodeTypes(schema: Schema): {
+    [key: string]: NodeType;
+};

package/dist/packages/extension-table/src/utilities/isCellSelection.d.ts

@@ -1,2 +1,2 @@
-import { CellSelection } from '@tiptap/pm/tables';
-export declare function isCellSelection(value: unknown): value is CellSelection;
+import { CellSelection } from '@tiptap/pm/tables';
+export declare function isCellSelection(value: unknown): value is CellSelection;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/extension-table",
   "description": "table extension for tiptap",
-  "version": "2.5.0-beta.2",
+  "version": "2.5.0-beta.3",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -29,8 +29,8 @@
     "dist"
   ],
   "devDependencies": {
-    "@tiptap/core": "^2.5.0-beta.2",
-    "@tiptap/pm": "^2.5.0-beta.2"
+    "@tiptap/core": "^2.5.0-beta.3",
+    "@tiptap/pm": "^2.5.0-beta.3"
   },
   "peerDependencies": {
     "@tiptap/core": "^2.0.0",