@krak-stack/registry 0.1.29 → 0.1.31

package/dist/components/ui/data-table.d.ts

@@ -13,7 +13,141 @@ export interface DataTableValueGetterParams<TData extends RowData> {
 export interface DataTableCellRendererParams<TData extends RowData> extends DataTableValueGetterParams<TData> {
     value: unknown;
 }
-export interface DataTableColDef<TData extends RowData> {
+export interface DataTableListItem {
+    icon?: ReactNode;
+    imageSrc?: string;
+    label: string;
+    value?: string;
+}
+export interface DataTableListOption extends DataTableListItem {
+    value: string;
+}
+export type DataTableItemAction<TItem> = DataTableRowAction<TItem> & {
+    closeOnClick?: boolean;
+    disabled?: (item: TItem) => boolean;
+};
+export interface DataTableListItemContext<TData> {
+    item: DataTableListItem;
+    row: TData;
+}
+export interface DataTableListOptions {
+    emptyLabel: ReactNode;
+    display?: "list" | "icon";
+    visibleCount?: number;
+}
+export type DataTableListColumn<TData> = DataTableListOptions & {
+    /** Includes items not loaded in the preview; the dropdown only shows supplied items. */
+    getTotalCount?: (row: TData) => number;
+    /** Actions open from an explicit roster button; list items remain passive. */
+    itemActions?: readonly DataTableItemAction<DataTableListItemContext<TData>>[];
+    actionsLabel?: string;
+} & ({
+    getItems: (row: TData) => readonly DataTableListItem[];
+    getOptions?: never;
+    manageLabel?: never;
+    onAdd?: never;
+    onRemove?: never;
+} | {
+    /** Editable lists require stable values for selected and available items. */
+    getItems: (row: TData) => readonly DataTableListOption[];
+    getOptions: (row: TData) => readonly DataTableListOption[];
+    manageLabel: string;
+    onAdd?: (input: {
+        value: string;
+        row: TData;
+    }) => void;
+    onRemove?: (input: {
+        value: string;
+        row: TData;
+    }) => void;
+});
+export interface DataTableListSummaryProps extends DataTableListOptions {
+    items: readonly (string | DataTableListItem)[];
+    totalCount?: number | undefined;
+}
+interface EditableDataTableListCellProps extends DataTableListOptions {
+    manageLabel: string;
+    onAdd?: ((value: string) => void) | undefined;
+    onRemove?: ((value: string) => void) | undefined;
+    options: readonly DataTableListOption[];
+    items: readonly DataTableListOption[];
+    totalCount?: number | undefined;
+}
+interface DataTableListCellActionsProps {
+    actionsLabel?: string;
+    itemActions?: readonly DataTableItemAction<DataTableListItem>[];
+}
+export type DataTableListCellProps = DataTableListCellActionsProps & (EditableDataTableListCellProps | (DataTableListSummaryProps & {
+    options?: never;
+    manageLabel?: never;
+    onAdd?: never;
+    onRemove?: never;
+}));
+export interface DataTableDateOptions {
+    /** Defaults to the current Paraglide locale. */
+    locale?: string;
+    /** Defaults to UTC. Calendar-only strings retain their date in every zone. */
+    timeZone?: string;
+    dateStyle?: Intl.DateTimeFormatOptions["dateStyle"];
+    emptyLabel?: ReactNode;
+    /** Placement of missing or invalid dates, independent of sort direction. */
+    nulls?: "first" | "last";
+    /** ISO by default; applies to both CSV and JSON exports. */
+    exportFormat?: "iso" | "formatted";
+}
+export interface DataTableDateTimeOptions extends DataTableDateOptions {
+    timeStyle?: Intl.DateTimeFormatOptions["timeStyle"];
+    hour12?: boolean;
+}
+type DataTableDateType = {
+    type: "date";
+    typeOptions?: DataTableDateOptions;
+} | {
+    type: "dateTime";
+    typeOptions?: DataTableDateTimeOptions;
+};
+export type DataTableNumberOptions = Omit<Intl.NumberFormatOptions, "style" | "currency"> & {
+    locale?: string;
+    emptyLabel?: ReactNode;
+    nulls?: "first" | "last";
+    exportFormat?: "raw" | "formatted";
+} & ({
+    style?: "decimal" | "percent";
+    currency?: never;
+} | {
+    style: "currency";
+    currency: string;
+});
+export interface DataTableBooleanOptions<TData> {
+    /** Optional localized labels for search and formatted exports. */
+    trueLabel?: string;
+    falseLabel?: string;
+    emptyLabel?: ReactNode;
+    nulls?: "first" | "last";
+    exportFormat?: "raw" | "formatted";
+    getAriaLabel?: (row: TData) => string;
+    /** Without a callback, the checkbox is read-only. Updates remain caller-owned. */
+    onChange?: (input: {
+        value: boolean;
+        row: TData;
+    }) => void;
+    disabled?: (row: TData) => boolean;
+}
+type DataTableColumnType<TData> = {
+    type?: undefined;
+    typeOptions?: never;
+} | DataTableDateType | {
+    type: "number";
+    typeOptions?: DataTableNumberOptions;
+} | {
+    type: "boolean";
+    typeOptions?: DataTableBooleanOptions<TData>;
+} | {
+    type: "list";
+    typeOptions: DataTableListColumn<TData>;
+};
+export type DataTableColDef<TData extends RowData> = DataTableBaseColDef<TData> & DataTableColumnType<TData>;
+export interface DataTableBaseColDef<TData extends RowData> {
     field?: keyof TData & string;
     colId?: string;
     headerName: ReactNode;
@@ -43,21 +177,8 @@ export type DataTableRowAction<TData> = {
     onClick: (data: TData) => void;
     visible?: (data: TData) => boolean;
 };
-export type DataTableBulkAction<TData> = {
-    id?: string;
-    name: string;
-    icon?: ReactNode;
-    variant?: "default" | "destructive";
-    onClick: (rows: TData[]) => void;
-    visible?: (rows: TData[]) => boolean;
-};
-export type DataTableGroupAction = {
-    name: string;
-    icon?: ReactNode;
-    variant?: "default" | "destructive";
-    onClick: (groupId: string) => void;
-    visible?: (groupId: string) => boolean;
-};
+export type DataTableBulkAction<TData> = DataTableRowAction<TData[]>;
+export type DataTableGroupAction = Omit<DataTableRowAction<string>, "id">;
 export interface DataTableGroupingField<TData> {
     id: string;
     label: string;
@@ -84,6 +205,10 @@ export type DataTablePaginationFeature = false | {
     pageSizes?: readonly number[];
 };
 export interface DataTableFeatures<TData> {
+    toolbar?: false | {
+        /** Additional `MenubarMenu` controls rendered at the start of the toolbar. */
+        items: ReactNode;
+    };
     search?: boolean;
     sorting?: boolean;
     pagination?: DataTablePaginationFeature;
@@ -121,6 +246,7 @@ export interface DataTableFeatures<TData> {
 }
 export type DataTableMessages = PaginationMessages & {
     actions: string;
+    addItem: string;
     empty: string;
     loading: string;
     filter: string;
@@ -139,10 +265,11 @@ export type DataTableMessages = PaginationMessages & {
     sortBy: string;
     hideColumn: string;
     reorder: string;
+    removeItem: string;
     moveUp: string;
     moveDown: string;
     resizeColumn: (column: string) => string;
-    listOthers: (count: number) => string;
+    listDetails: string;
     selectAllRows: string;
     selectRow: string;
     selected: string;
@@ -158,6 +285,7 @@ export declare const dataTableMessages: (overrides?: DataTableMessageOverrides)
     goToNextPage: string;
     goToLastPage: string;
     actions: string;
+    addItem: string;
     empty: string;
     loading: string;
     filter: string;
@@ -176,10 +304,11 @@ export declare const dataTableMessages: (overrides?: DataTableMessageOverrides)
     sortBy: string;
     hideColumn: string;
     reorder: string;
+    removeItem: string;
     moveUp: string;
     moveDown: string;
     resizeColumn: (column: string) => string;
-    listOthers: (count: number) => string;
+    listDetails: string;
     selectAllRows: string;
     selectRow: string;
     selected: string;
@@ -193,6 +322,7 @@ export declare const dataTableMessages: (overrides?: DataTableMessageOverrides)
     goToNextPage: string;
     goToLastPage: string;
     actions: string;
+    addItem: string;
     empty: string;
     loading: string;
     filter: string;
@@ -211,10 +341,11 @@ export declare const dataTableMessages: (overrides?: DataTableMessageOverrides)
     sortBy: string;
     hideColumn: string;
     reorder: string;
+    removeItem: string;
     moveUp: string;
     moveDown: string;
     resizeColumn: (column: string) => string;
-    listOthers: (count: number) => string;
+    listDetails: string;
     selectAllRows: string;
     selectRow: string;
     selected: string;
@@ -255,6 +386,7 @@ export interface DataTableModel<TData extends RowData> {
 export declare const normalizeDataTableColumns: <TData extends RowData>(columnDefs: readonly DataTableColDef<TData>[], columnSizing?: Readonly<Record<string, number>>) => DataTableColumn<TData>[];
 export declare const getDataTableWidth: <TData extends RowData>(columns: readonly DataTableColumn<TData>[], utilityColumns?: number) => number;
 export declare const buildDataTableRows: <TData extends RowData>(rowData: readonly TData[], columns: readonly DataTableColumn<TData>[], getRowId?: (row: TData) => string) => DataTableModelRow<TData>[];
+export declare const getDataTableExportValue: <TData extends RowData>(row: DataTableModelRow<TData>, column: DataTableColumn<TData>) => unknown;
 export declare const filterDataTableRows: <TData extends RowData>(rows: readonly DataTableModelRow<TData>[], columns: readonly DataTableColumn<TData>[], globalFilter: string) => DataTableModelRow<TData>[];
 export declare const sortDataTableRows: <TData extends RowData>(rows: readonly DataTableModelRow<TData>[], columns: readonly DataTableColumn<TData>[], sorting: NonNullable<QueryType["sort"]>) => DataTableModelRow<TData>[];
 export declare const paginateDataTableRows: <TData extends RowData>(rows: readonly DataTableModelRow<TData>[], pagination: Pick<QueryType, "page" | "pageSize">) => DataTableModelRow<TData>[];
@@ -278,30 +410,6 @@ export declare const DataTableRowActions: <TData>({ actions, row, title, }: {
     title?: string;
 }) => import("react").JSX.Element | null;
 export declare const DataTable: <TData extends RowData>(props: DataTableProps<TData>) => import("react").JSX.Element;
-export interface DataTableRelationshipOption {
-    icon?: ReactNode;
-    label: string;
-    value: string;
-}
-export declare const DataTableRelationshipCell: ({ emptyLabel, manageLabel, onAdd, onRemove, options, value, }: {
-    emptyLabel: string;
-    manageLabel: string;
-    onAdd?: (value: string) => void;
-    onRemove?: (value: string) => void;
-    options: readonly DataTableRelationshipOption[];
-    value: readonly DataTableRelationshipOption[];
-}) => import("react").JSX.Element;
-export declare const DataTableListSummary: ({ emptyLabel, expandable, items, overflowLabel, totalCount, variant, visibleCount, }: {
-    emptyLabel: ReactNode;
-    expandable?: boolean;
-    items: readonly (string | {
-        icon?: ReactNode;
-        label: string;
-        value?: string;
-    })[];
-    overflowLabel?: (remaining: number) => ReactNode;
-    totalCount?: number;
-    variant?: "icon" | "text";
-    visibleCount?: number;
-}) => import("react").JSX.Element;
+export declare const DataTableListCell: (props: DataTableListCellProps) => import("react").JSX.Element;
+export declare const DataTableListSummary: (props: DataTableListSummaryProps) => import("react").JSX.Element;
 export {};