@leavepulse/ui 0.43.4 → 0.45.0

package/dist/components/LpTable.vue.d.ts

@@ -1,11 +1,22 @@
 import { type ContextMenuItemDef } from "./LpContextMenu.vue";
+import { type CsvOptions } from "./exportData";
 export interface TableColumn<Row> {
     key: string;
     label: string;
     align?: "left" | "right" | "center";
     width?: string;
+    /**
+     * Keep the cell on one line. For ids, codes, dates and amounts, which a
+     * narrow screen otherwise breaks at a hyphen or a space ("ORD-" / "1040");
+     * the table scrolls sideways instead.
+     */
+    nowrap?: boolean;
     /** Allow clicking the header to sort by this column. */
     sortable?: boolean;
+    /** The value this column sorts by, when the cell holds something else. */
+    sortValue?: (row: Row) => unknown;
+    /** Full control over the order; wins over `sortValue`. Ascending order. */
+    compare?: (a: Row, b: Row) => number;
     /**
      * Offer "show only these values" in the header's menu, built from the values
      * actually present in the rows. For a column that holds a small vocabulary —
@@ -18,10 +29,59 @@ export interface TableColumn<Row> {
      * vocabulary; the menu should say what the column itself says.
      */
     valueLabel?: (value: unknown) => string;
+    /** The value a CSV export writes for this column; the raw cell by default. */
+    exportValue?: (row: Row) => unknown;
     /** Keep this column out of the show/hide list — an actions column has no
      *  name to offer and nothing to gain from being hidden. */
     alwaysVisible?: boolean;
 }
+export interface TableLabels {
+    [key: string]: string;
+    loading: string;
+    error: string;
+    empty: string;
+    sortAsc: string;
+    sortDesc: string;
+    sortClear: string;
+    filter: string;
+    showAll: string;
+    columns: string;
+    exportCsv: string;
+    selectAll: string;
+    shortcutsGroup: string;
+    filterColumn: string;
+    filterSearch: string;
+    filterAll: string;
+    filterNone: string;
+    filterInvert: string;
+    filterOnly: string;
+    filterOnlyShown: string;
+    filterAddShown: string;
+    filterNoValues: string;
+    filterNothingShown: string;
+    clearFilter: string;
+    clearFilters: string;
+    noMatches: string;
+    resetFilters: string;
+    rowCount: string;
+    rowsTotal: string;
+    selectedCount: string;
+    clearSelection: string;
+    pageSelected: string;
+    selectAllMatching: string;
+    allMatchingSelected: string;
+}
+export interface TableExportOptions extends CsvOptions {
+    /**
+     * Which rows: every row in the current order, the rows the header filters
+     * leave, or the selected ones. With `load` only the loaded page is known.
+     */
+    scope?: "all" | "filtered" | "selected";
+    /** File name without extension. */
+    filename?: string;
+    /** Return the CSV without offering a download. */
+    download?: boolean;
+}
 export interface SortState {
     key: string;
     dir: "asc" | "desc";
@@ -67,12 +127,23 @@ declare const __VLS_export: <T extends Record<string, unknown>>(__VLS_props: Non
         debounce?: number;
         loadingLabel?: string;
         errorLabel?: string;
-        /** Stable id per row — required for selection; falls back to index otherwise. */
+        /**
+         * Stable id per row. Without it a row is keyed by its position in `rows`,
+         * which survives sorting and filtering but not a new array; set it whenever
+         * rows are replaced (`load`, polling) and selection must carry over.
+         */
         rowKey?: keyof T | ((row: T) => string | number);
         emptyLabel?: string;
         emptyIcon?: string;
-        /** Render a leading checkbox column; selection binds via v-model:selected. */
-        selectable?: boolean;
+        /**
+         * Rows can be selected (v-model:selected). `true` shows a tick column,
+         * where pressing a tick and sweeping ticks the run. `"hold"` keeps the
+         * column out of sight until it is needed: a long press on a row selects it
+         * (and the same press goes on selecting the rows it is dragged across), the
+         * column slides in, and while anything is selected a click on a row toggles
+         * it. Emptying the selection, or Escape, slides the column away again.
+         */
+        selectable?: boolean | "hold";
         /** Selected row keys (v-model:selected). */
         selected?: (string | number)[];
         /** Active sort (v-model:sort). When set, the parent owns ordering (server
@@ -92,15 +163,41 @@ declare const __VLS_export: <T extends Record<string, unknown>>(__VLS_props: Non
         filterLabel?: string;
         showAllLabel?: string;
         columnsLabel?: string;
+        /** Offer a CSV download in a toolbar above the table and in its menu. */
+        exportable?: boolean;
+        /** File name for that download, without extension. */
+        exportFilename?: string;
+        /** All of the wording above in one object, and the config-level scope "table". */
+        labels?: Partial<TableLabels>;
+        /** Row height: `compact` for dense data, `comfortable` (default) otherwise. */
+        density?: "comfortable" | "compact";
+        /**
+         * Always show the bar above the table with the row count. It shows on its
+         * own while filters are active or rows are selected.
+         */
+        summary?: boolean;
+        /**
+         * Remember sort, value filters and hidden columns across visits under this
+         * key (localStorage). Only plain filter values (text, numbers) are kept.
+         */
+        persist?: string;
+        /**
+         * With `load`: the user chose "select all N" beyond the loaded page
+         * (v-model:allMatching). The keys in `selected` are then only the loaded
+         * ones; acting on everything that matches is the consumer's to do.
+         */
+        allMatching?: boolean;
     } & {
         "onUpdate:selected"?: ((value: (string | number)[]) => any) | undefined;
         "onUpdate:sort"?: ((value: SortState | null) => any) | undefined;
+        "onUpdate:allMatching"?: ((value: boolean) => any) | undefined;
         onRowClick?: ((row: T) => any) | undefined;
     }> & (typeof globalThis extends {
         __VLS_PROPS_FALLBACK: infer P;
     } ? P : {});
     expose: (exposed: import("vue").ShallowUnwrapRef<{
         reload: () => void;
+        exportCsv: (options?: TableExportOptions) => string;
     }>) => void;
     attrs: any;
     slots: {
@@ -108,10 +205,17 @@ declare const __VLS_export: <T extends Record<string, unknown>>(__VLS_props: Non
             row: T;
             value: unknown;
         }) => any) | undefined;
+    } & {
+        bulk?: (props: {
+            selected: (string | number)[];
+            allMatching: boolean;
+            clear: () => void;
+        }) => any;
     };
     emit: {
         (e: "update:selected", value: (string | number)[]): void;
         (e: "update:sort", value: SortState | null): void;
+        (e: "update:allMatching", value: boolean): void;
         (e: "rowClick", row: T): void;
     };
 }>) => import("vue").VNode & {