@astryxdesign/core 0.3.0 → 0.4.0-canary.058f476

package/dist/Table/plugins/rowExpansion/useTableRowExpansion.d.ts

@@ -1,105 +1,70 @@
+/**
+ * @file useTableRowExpansion.tsx
+ * @input React, StyleX, Icon, Table types, i18n (useTranslator)
+ * @output Exports useTableRowExpansion hook + config type
+ * @position Row-expansion plugin (detail panel); consumed by Table via plugins prop
+ *
+ * Expands a full-width detail panel below a row, rendered by the consumer's
+ * `renderExpanded(item)`. For hierarchical/tree tables (child rows that reuse
+ * the parent columns) use `useTableTreeData` + `useTableTreeState` instead.
+ *
+ * SYNC: When modified, update these files to stay in sync:
+ * - /packages/core/src/Table/index.ts (exports)
+ * - /packages/core/src/Table/useTableRowExpansion.doc.mjs
+ */
+import { type ReactNode } from 'react';
 import type { TablePlugin } from '../../types';
 /**
- * Configuration for useTableRowExpansion (inherited-columns mode).
+ * Configuration for useTableRowExpansion (detail-panel mode).
  *
- * Child rows use the same columns as their parents, with indentation on the
- * first content column. The consumer provides a **flat** data array (use
- * {@link useTableRowExpansionState} to flatten a tree) and a `getDepth`
- * function so the plugin knows each row's nesting level.
+ * The consumer owns expansion state; the plugin provides the chevron UI, the
+ * full-width detail panel rendered below an expanded row, and a right-click
+ * "Expand/Collapse row" action.
  */
 export interface UseTableRowExpansionConfig<T extends Record<string, unknown>> {
     /** Set of currently-expanded row keys. */
     expandedKeys: Set<string>;
-    /** Called when a row's expansion is toggled. */
+    /** Called with a row key when its expansion is toggled. */
     onToggle: (key: string) => void;
     /** Derive a stable unique key from a row item. */
     getRowKey: (item: T) => string;
-    /** Return the children of a row (used to determine expandability). */
-    getChildren: (item: T) => T[];
-    /** Return the depth of a row in the hierarchy (0 = top-level). */
-    getDepth?: (item: T) => number;
-    /** Optionally control which rows are expandable. @default checks getChildren length */
-    getIsItemExpandable?: (item: T) => boolean;
     /**
-     * When true, clicking anywhere on the row toggles expansion (in addition to
-     * the chevron button). @default false — only the chevron triggers expansion.
+     * Render the detail content shown in a full-width panel below the row when
+     * it is expanded. Receives the row's item.
      */
-    hasRowClickExpansion?: boolean;
+    renderExpanded: (item: T) => ReactNode;
     /**
-     * State of the expand-all toggle in the header. `true` = all expanded,
-     * `false` = all collapsed, `'indeterminate'` = mixed. When provided
-     * (together with `onToggleExpandAll`), the header cell shows a toggle button.
-     */
-    isAllExpanded?: boolean | 'indeterminate';
-    /** Called when the expand-all header toggle is clicked. */
-    onToggleExpandAll?: (expand: boolean) => void;
-}
-/**
- * Configuration for {@link useTableRowExpansionState}.
- *
- * Mirrors the shape of {@link useTableSelectionState}: you own the
- * `expandedKeys` set (via `useState`), and the hook derives everything the
- * plugin needs — the flattened `data`, per-row depth, expand/collapse
- * handlers, and the expand-all toggle state.
- */
-export interface UseTableRowExpansionStateConfig<T extends Record<string, unknown>> {
-    /** The full, un-flattened tree. */
-    baseData: T[];
-    /** Return the children of a row. Leaf rows return an empty array. */
-    getChildren: (item: T) => T[];
-    /** Derive a stable unique key from a row item. */
-    getRowKey: (item: T) => string;
-    /**
-     * Should this row be expandable? Rows that return `false` never show a
-     * chevron and are skipped by expand-all. @default rows with children
+     * Control which rows are expandable. Non-expandable rows show no chevron, no
+     * context-menu action, and never render a panel. @default all rows expandable
      */
     getIsItemExpandable?: (item: T) => boolean;
-    /** Controlled set of currently-expanded row keys. */
-    expandedKeys: Set<string>;
-    /** Setter for the controlled expanded keys. */
-    setExpandedKeys: React.Dispatch<React.SetStateAction<Set<string>>>;
-}
-export interface UseTableRowExpansionStateResult<T extends Record<string, unknown>> {
-    /** The flattened, currently-visible rows. Pass to `<Table data>`. */
-    data: T[];
-    /** Ready-to-use config for {@link useTableRowExpansion}. */
-    expansionConfig: UseTableRowExpansionConfig<T>;
 }
 /**
- * Manages row-expansion state and derives the config for
- * {@link useTableRowExpansion}.
+ * Returns a TablePlugin that expands a full-width detail panel below a row.
+ *
+ * The consumer owns the `expandedKeys` set (via `useState`); the plugin adds
+ * a leading chevron column, a right-click expand/collapse action, and renders
+ * `renderExpanded(item)` in a full-width panel below each expanded row.
  *
- * @deprecated Use `useTableTreeState` (with `useTableTreeData`) instead. The
- * tree plugin covers the same affordances (expand-all header control,
- * whole-row click) with a cycle guard and per-row fine-grained re-render. See
- * the migration guide on `useTableRowExpansion` (`astryx component
- * useTableRowExpansion --detail full`) for the before/after and config
- * mapping.
+ * For hierarchical data (child rows sharing the parent columns) use
+ * `useTableTreeData` + `useTableTreeState` instead.
  *
  * @example
  * ```
  * const [expandedKeys, setExpandedKeys] = useState<Set<string>>(new Set());
- * const {data, expansionConfig} = useTableRowExpansionState({
- *   baseData: tree,
- *   getChildren: item => item.children ?? [],
- *   getRowKey: item => item.id,
+ * const expansion = useTableRowExpansion({
  *   expandedKeys,
- *   setExpandedKeys,
+ *   onToggle: key =>
+ *     setExpandedKeys(prev => {
+ *       const next = new Set(prev);
+ *       next.has(key) ? next.delete(key) : next.add(key);
+ *       return next;
+ *     }),
+ *   getRowKey: item => item.id,
+ *   renderExpanded: item => <OrderDetails order={item} />,
  * });
- * const expansion = useTableRowExpansion(expansionConfig);
  * <Table data={data} columns={columns} idKey="id" plugins={{expansion}} />;
  * ```
  */
-export declare function useTableRowExpansionState<T extends Record<string, unknown>>({ baseData, getChildren, getRowKey, getIsItemExpandable, expandedKeys, setExpandedKeys, }: UseTableRowExpansionStateConfig<T>): UseTableRowExpansionStateResult<T>;
-/**
- * Returns a TablePlugin implementing expandable rows with inherited columns.
- *
- * @deprecated Use `useTableTreeData` (with `useTableTreeState`) instead. The
- * tree plugin covers the same affordances (expand-all header control,
- * whole-row click) with a cycle guard and per-row fine-grained re-render. See
- * the migration guide on this hook's docs (`astryx component
- * useTableRowExpansion --detail full`) for the before/after and config
- * mapping.
- */
 export declare function useTableRowExpansion<T extends Record<string, unknown>>(config: UseTableRowExpansionConfig<T>): TablePlugin<T>;
 //# sourceMappingURL=useTableRowExpansion.d.ts.map

package/dist/Table/plugins/rowExpansion/useTableRowExpansion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTableRowExpansion.d.ts","sourceRoot":"","sources":["../../../../src/Table/plugins/rowExpansion/useTableRowExpansion.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EACV,WAAW,EAKZ,MAAM,aAAa,CAAC;AAMrB;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA0B,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3E,0CAA0C;IAC1C,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,gDAAgD;IAChD,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,kDAAkD;IAClD,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC/B,sEAAsE;IACtE,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;IAC9B,kEAAkE;IAClE,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC/B,uFAAuF;IACvF,mBAAmB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC;IAC3C;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,eAAe,CAAC;IAC1C,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;CAC/C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,+BAA+B,CAC9C,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEjC,mCAAmC;IACnC,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,qEAAqE;IACrE,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;IAC9B,kDAAkD;IAClD,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC/B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC;IAC3C,qDAAqD;IACrD,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,+CAA+C;IAC/C,eAAe,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,+BAA+B,CAC9C,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEjC,qEAAqE;IACrE,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,4DAA4D;IAC5D,eAAe,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC;CAChD;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAC3E,QAAQ,EACR,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,YAAY,EACZ,eAAe,GAChB,EAAE,+BAA+B,CAAC,CAAC,CAAC,GAAG,+BAA+B,CAAC,CAAC,CAAC,CA+IzE;AAyGD;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpE,MAAM,EAAE,0BAA0B,CAAC,CAAC,CAAC,GACpC,WAAW,CAAC,CAAC,CAAC,CAwPhB"}
+{"version":3,"file":"useTableRowExpansion.d.ts","sourceRoot":"","sources":["../../../../src/Table/plugins/rowExpansion/useTableRowExpansion.tsx"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAkB,KAAK,SAAS,EAAC,MAAM,OAAO,CAAC;AAMtD,OAAO,KAAK,EACV,WAAW,EAIZ,MAAM,aAAa,CAAC;AAMrB;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3E,0CAA0C;IAC1C,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,2DAA2D;IAC3D,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,kDAAkD;IAClD,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC;IACvC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC;CAC5C;AAoFD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpE,MAAM,EAAE,0BAA0B,CAAC,CAAC,CAAC,GACpC,WAAW,CAAC,CAAC,CAAC,CAqIhB"}