@godxjp/ui 19.6.0 → 20.1.0

package/dist/props/components/data-display.prop.d.ts

@@ -7,7 +7,9 @@ export type CodeBlockProp = {
     /** Soft-wrap long lines (default true). `false` scrolls horizontally instead. */
     wrap?: boolean;
     /** Scroll inside the block past this height. Default `none` (grows with the content). */
-    maxHeight?: "sm" | "md" | "lg" | "none";
+    maxHeight?: "sm" | "md" | "lg" | "none" | {
+        value: string;
+    };
     /** Type size. Default `sm`. */
     size?: Extract<SizeProp, "xs" | "sm">;
     /** Cosmetic: lands on `data-language`; no highlighter is bundled. */
@@ -26,7 +28,24 @@ export type ProseProp = {
     className?: ClassNameProp;
     children?: ChildrenProp;
 };
-import type { ActionProp, ClassNameProp, DescriptionProp, IconProp, TitleProp, ColumnDefProp, GetRowIdProp, OnRowClickProp, OnSelectChangeProp, OnSortChangeProp, OnTableDensityChangeProp, SelectedIdsProp, SortStateProp, TableDensityProp, TablePresetProp, BreakpointProp, DensityProp, ChildrenProp, ToneProp, AvatarShapeProp, HeadingLevelProp, HandlerProp, SizeProp, LabelProp, IdProp, DescriptionsLayoutProp } from "../vocabulary/index.js";
+import type { ActionProp, ClassNameProp, DescriptionProp, IconProp, TitleProp, ColumnDefProp, GetRowIdProp, OnRowClickProp, OnSelectChangeProp, OnSortChangeProp, OnTableDensityChangeProp, SelectedIdsProp, SortStateProp, TableDensityProp, TablePresetProp, BreakpointProp, DensityProp, ChildrenProp, ToneProp, AvatarShapeProp, HeadingLevelProp, HandlerProp, SizeProp, LabelProp, IdProp, DescriptionsLayoutProp, DescriptionsColumnProp, DescriptionsSpanProp, DescriptionsItemsProp, SortDirectionProp, OnColumnFilterChangeProp, OnRowProp, TableExpandableProp, TableRowSelectionProp, TableScrollProp, TableStickyProp, TableSummaryProp } from "../vocabulary/index.js";
+/**
+ * One key in a `Legend`: a tone, and the words that tone stands for.
+ *
+ * `label` is required and there is no way to omit it. That is the point of a key — colour alone
+ * never carries meaning (WCAG 1.4.1), and a legend whose entries could be wordless would be a
+ * component that lets a caller build the exact failure it exists to prevent.
+ */
+export type LegendItemProp = {
+    /** The tone this key explains — the SAME tone the marks it stands for are drawn in. */
+    tone: ToneProp;
+    label: LabelProp;
+};
+/** @see Legend — the key for a colour-coded surface: a breakdown bar, a chart, a status column. */
+export type LegendProp = Omit<React.HTMLAttributes<HTMLUListElement>, "children"> & {
+    items: LegendItemProp[];
+    className?: ClassNameProp;
+};
 /** @see EmptyState */
 /**
  * Semantic intent of the EmptyState icon medallion — a subset of the shared `ToneProp` vocabulary
@@ -60,18 +79,28 @@ export type EmptyStateProp = {
  */
 export type DescriptionsProp = {
     /** `Descriptions.Item` children — one label/value pair each. */
-    children: React.ReactNode;
-    columns?: 1 | 2 | 3;
+    children?: React.ReactNode;
+    /**
+     * Column count. `1 | 2 | 3` keeps this library's own mobile-first ladder; any other number, or
+     * antd's responsive `{ sm, md, lg, xl }` object, drives the token-published grid instead.
+     */
+    columns?: DescriptionsColumnProp;
     /** Label placement within each item. Default `vertical` (label over value). */
     layout?: DescriptionsLayoutProp;
     /** Label text alignment inside the label column. Applies only to `layout="horizontal"`. */
     labelAlign?: "start" | "end";
+    /** Draw the grid as a bordered table with shaded label cells (antd `bordered`). */
+    bordered?: boolean;
+    /** Declarative items (antd `items`) — the alternative to composing `Descriptions.Item`. */
+    items?: DescriptionsItemsProp;
     className?: ClassNameProp;
 };
 export type DescriptionsItemProp = {
     label: React.ReactNode;
     value: React.ReactNode;
     mono?: boolean;
+    /** Columns this item occupies — number | `"filled"` | responsive object (antd `span`). */
+    span?: DescriptionsSpanProp;
 };
 /**
  * @see Avatar
@@ -247,6 +276,26 @@ export type DataTableProp<T> = {
      * measures. Default `"sm"`.
      */
     collapseBelow?: BreakpointProp;
+    /** Full row-selection configuration (antd `rowSelection`). */
+    rowSelection?: TableRowSelectionProp<T>;
+    /** Expandable detail rows (antd `expandable`). */
+    expandable?: TableExpandableProp<T>;
+    /** Footer totals row, rendered in a real `<tfoot>` (antd `summary`). */
+    summary?: TableSummaryProp<T>;
+    /** Scroll envelope — `x` a minimum inline size, `y` a maximum body block size (antd `scroll`). */
+    scroll?: TableScrollProp;
+    /** Sticky header; the object form carries `offsetHeader` (antd `sticky`). */
+    sticky?: TableStickyProp;
+    /** Per-row DOM props merged onto the `<tr>` (antd `onRow`). */
+    onRow?: OnRowProp<T>;
+    /** Outer frame + vertical rules between columns (antd `bordered`). */
+    bordered?: boolean;
+    /** Explain the next sort step in a tooltip on sortable headers (antd `showSorterTooltip`). */
+    showSorterTooltip?: boolean;
+    /** Table-wide sort cycle; a column's own `sortDirections` wins (antd `sortDirections`). */
+    sortDirections?: SortDirectionProp[];
+    /** Column filters changed — pair with a column's `filteredValue` for server filtering. */
+    onFilterChange?: OnColumnFilterChangeProp;
     className?: ClassNameProp;
     children?: ChildrenProp;
 };
@@ -345,7 +394,26 @@ export type PermissionMatrixProp = {
  */
 export type ScrollAreaAnchorProp = "none" | "bottom";
 /** @see ScrollArea */
+/**
+ * @see ScrollArea — which AXES scroll. This is not decoration: Radix sets the viewport's
+ * `overflowX`/`overflowY` inline from which scrollbars are mounted, so an axis with no `ScrollBar`
+ * is `overflow: hidden` and its content is CLIPPED, not merely un-barred.
+ *
+ * `both` is a third value rather than an array or a pair of booleans because the axes are one
+ * decision — a pane scrolls down, across, or freely — and a closed union is what `check:prop-vocabulary`
+ * and the MCP catalog can carry.
+ */
+export type ScrollAreaOrientationProp = "vertical" | "horizontal" | "both";
 export type ScrollAreaProp = {
+    /**
+     * Axes that scroll, and therefore which scrollbars render. Default `vertical` — the previous
+     * behaviour, unchanged.
+     *
+     * Reach for `horizontal` for a strip of non-shrinking columns (a board, a lane of cards): the
+     * viewport keeps its tab stop, so the strip is scrollable from the keyboard, and the consumer
+     * writes no overflow styling of its own.
+     */
+    orientation?: ScrollAreaOrientationProp;
     /**
      * Ref to the element that actually SCROLLS — the Radix viewport — not the root. The root is
      * `overflow: hidden` and never scrolls, so the component's own `ref` cannot serve.