@kopexa/extension-table 17.0.46 → 17.1.0

package/dist/hooks/use-table-clear-row-column-content.d.mts

@@ -0,0 +1,103 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as _kopexa_icons from '@kopexa/icons';
+import { Editor } from '@tiptap/react';
+import { Orientation } from '../lib/table-utils.mjs';
+import '@tiptap/pm/model';
+import '@tiptap/pm/state';
+import '@tiptap/pm/tables';
+
+interface UseTableClearRowColumnContentConfig {
+    /**
+     * The Tiptap editor instance. If omitted, the hook will use
+     * the context/editor from `useTiptapEditor`.
+     */
+    editor?: Editor | null;
+    /**
+     * The index of the row or column to clear.
+     * If omitted, will clear the currently selected cells.
+     */
+    index?: number;
+    /**
+     * Whether you're clearing a row or a column.
+     * If omitted, will clear the currently selected cells.
+     */
+    orientation?: Orientation;
+    /**
+     * The position of the table in the document.
+     */
+    tablePos?: number;
+    /**
+     * Hide the button when clearing isn't currently possible.
+     * @default false
+     */
+    hideWhenUnavailable?: boolean;
+    /**
+     * Whether to reset cell attributes (backgroundColor, nodeVerticalAlign, nodeTextAlign) when clearing.
+     * @default false
+     */
+    resetAttrs?: boolean;
+    /**
+     * Callback function called after a successful clear.
+     */
+    onCleared?: () => void;
+}
+/**
+ * Custom hook that provides **table row/column content clearing**
+ * functionality for the Tiptap editor.
+ *
+ * @example
+ * ```tsx
+ * // Clear currently selected cells (no parameters needed)
+ * function ClearSelectedButton() {
+ *   const { isVisible, handleClear } = useTableClearRowColumnContent()
+ *
+ *   if (!isVisible) return null
+ *
+ *   return <button onClick={handleClear}>Clear Selection</button>
+ * }
+ *
+ * // Clear specific row with attribute reset
+ * function ClearRowButton({ rowIndex }: { rowIndex: number }) {
+ *   const { isVisible, handleClear, label, canClearRowColumnContent } = useTableClearRowColumnContent({
+ *     index: rowIndex,
+ *     orientation: "row",
+ *     resetAttrs: true,
+ *     hideWhenUnavailable: true,
+ *     onCleared: () => console.log("Row cleared and attributes reset!"),
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <button
+ *       onClick={handleClear}
+ *       disabled={!canClearRowColumnContent}
+ *       aria-label={label}
+ *     >
+ *       {label}
+ *     </button>
+ *   )
+ * }
+ *
+ * // Clear content based on current table selection (row/column/cells)
+ * function SmartClearButton() {
+ *   const { isVisible, handleClear, label } = useTableClearRowColumnContent({
+ *     resetAttrs: true,
+ *     hideWhenUnavailable: true
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return <button onClick={handleClear}>{label}</button>
+ * }
+ * ```
+ */
+declare function useTableClearRowColumnContent(config?: UseTableClearRowColumnContentConfig): {
+    isVisible: boolean;
+    canClearRowColumnContent: boolean;
+    handleClear: () => boolean;
+    label: string;
+    Icon: ({ size, ...props }: _kopexa_icons.IconSvgProps) => react_jsx_runtime.JSX.Element;
+};
+
+export { type UseTableClearRowColumnContentConfig, useTableClearRowColumnContent };

package/dist/hooks/use-table-clear-row-column-content.d.ts

@@ -0,0 +1,103 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as _kopexa_icons from '@kopexa/icons';
+import { Editor } from '@tiptap/react';
+import { Orientation } from '../lib/table-utils.js';
+import '@tiptap/pm/model';
+import '@tiptap/pm/state';
+import '@tiptap/pm/tables';
+
+interface UseTableClearRowColumnContentConfig {
+    /**
+     * The Tiptap editor instance. If omitted, the hook will use
+     * the context/editor from `useTiptapEditor`.
+     */
+    editor?: Editor | null;
+    /**
+     * The index of the row or column to clear.
+     * If omitted, will clear the currently selected cells.
+     */
+    index?: number;
+    /**
+     * Whether you're clearing a row or a column.
+     * If omitted, will clear the currently selected cells.
+     */
+    orientation?: Orientation;
+    /**
+     * The position of the table in the document.
+     */
+    tablePos?: number;
+    /**
+     * Hide the button when clearing isn't currently possible.
+     * @default false
+     */
+    hideWhenUnavailable?: boolean;
+    /**
+     * Whether to reset cell attributes (backgroundColor, nodeVerticalAlign, nodeTextAlign) when clearing.
+     * @default false
+     */
+    resetAttrs?: boolean;
+    /**
+     * Callback function called after a successful clear.
+     */
+    onCleared?: () => void;
+}
+/**
+ * Custom hook that provides **table row/column content clearing**
+ * functionality for the Tiptap editor.
+ *
+ * @example
+ * ```tsx
+ * // Clear currently selected cells (no parameters needed)
+ * function ClearSelectedButton() {
+ *   const { isVisible, handleClear } = useTableClearRowColumnContent()
+ *
+ *   if (!isVisible) return null
+ *
+ *   return <button onClick={handleClear}>Clear Selection</button>
+ * }
+ *
+ * // Clear specific row with attribute reset
+ * function ClearRowButton({ rowIndex }: { rowIndex: number }) {
+ *   const { isVisible, handleClear, label, canClearRowColumnContent } = useTableClearRowColumnContent({
+ *     index: rowIndex,
+ *     orientation: "row",
+ *     resetAttrs: true,
+ *     hideWhenUnavailable: true,
+ *     onCleared: () => console.log("Row cleared and attributes reset!"),
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <button
+ *       onClick={handleClear}
+ *       disabled={!canClearRowColumnContent}
+ *       aria-label={label}
+ *     >
+ *       {label}
+ *     </button>
+ *   )
+ * }
+ *
+ * // Clear content based on current table selection (row/column/cells)
+ * function SmartClearButton() {
+ *   const { isVisible, handleClear, label } = useTableClearRowColumnContent({
+ *     resetAttrs: true,
+ *     hideWhenUnavailable: true
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return <button onClick={handleClear}>{label}</button>
+ * }
+ * ```
+ */
+declare function useTableClearRowColumnContent(config?: UseTableClearRowColumnContentConfig): {
+    isVisible: boolean;
+    canClearRowColumnContent: boolean;
+    handleClear: () => boolean;
+    label: string;
+    Icon: ({ size, ...props }: _kopexa_icons.IconSvgProps) => react_jsx_runtime.JSX.Element;
+};
+
+export { type UseTableClearRowColumnContentConfig, useTableClearRowColumnContent };