@sondor-technology/sondor-components 1.0.9 → 1.0.10

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

@@ -1,45 +1,133 @@
 import { LitElement, PropertyValues } from "lit";
-export interface DataTableColumn {
-    header: string;
-    key: string;
-    sortable?: boolean;
-    hidden?: boolean;
-}
-export interface SortConfig {
-    key: string;
-    direction: "asc" | "desc";
-}
+import "../icon/icon.js";
+import "../skeleton/skeleton.js";
+import "../pagination/pagination.js";
+import "../context-menu/context-menu.js";
+import type { MenuItem } from "../context-menu/context-menu.js";
+import { type DataFilter, type DataTableColumn, type SortConfig } from "./data-table.utils.js";
+export type { DataFilter, DataTableColumn, FilterOperator, FilterType, SortConfig } from "./data-table.utils.js";
+export type { MenuItem } from "../context-menu/context-menu.js";
+export type RowActions = MenuItem[] | ((row: any) => MenuItem[]);
+/**
+ * Data table with search, multi-column filtering, multi-column sorting, pagination, column
+ * visibility and ordering, and per-row action menus.
+ *
+ * Data handling: by default the table filters, sorts and pages `data` itself. Set `server-side`
+ * (or `total-rows`) to handle that on a server instead: the table then shows `data` as given
+ * and reports every change through `st-data-change`.
+ *
+ * Events (bubble, composed):
+ * - `st-data-change`  `{ page, pageSize, search, sort, filters }` on any user change.
+ * - `st-row-click`    the row object, when `clickable-rows` is set.
+ * - `st-row-action`   `{ value, item, row }` when a row menu item is chosen.
+ */
 export declare class StDataTable extends LitElement {
     columns: DataTableColumn[];
     data: Record<string, any>[];
+    /** Total rows on the server. Implies server-side handling. */
     totalRows: number;
+    serverSide: boolean;
     page: number;
     pageSize: number;
+    pageSizeOptions: number[];
+    /** Free-text search across searchable columns. */
+    search: string;
+    sort: SortConfig[];
+    filters: DataFilter[];
+    /** Sort by several columns with Shift+click (on by default). */
     multiSort: boolean;
+    singleSort: boolean;
     loading: boolean;
+    clickableRows: boolean;
+    dense: boolean;
+    striped: boolean;
+    stickyHeader: boolean;
+    /**
+     * Reserves space for this many rows so the footer never moves between pages. Pages with fewer
+     * rows are padded with blank space; pages with more (a larger page size) scroll inside the
+     * table while the header and footer stay put. Cells stay on one line (long text is truncated).
+     */
+    fixedRows: number;
+    caption: string;
+    emptyText: string;
+    searchPlaceholder: string;
+    hideSearch: boolean;
+    hideColumnMenu: boolean;
+    fixedColumns: boolean;
+    /** Menu items per row: an array, or a function returning items for a given row. */
+    rowActions?: RowActions;
+    /** Column used to name a row in assistive text, e.g. "Actions for Ada". Defaults to the first. */
+    rowLabelKey: string;
     private internalColumns;
-    private sortState;
-    private searchQuery;
-    private showColumnMenu;
-    private searchTimeout?;
-    private draggedColumnKey;
+    private searchDraft;
+    private filtersOpen;
+    private announcement;
+    private menuOpenFor;
+    private menu;
+    private view;
+    private menuMode;
+    private debounce?;
+    private draggedKey;
+    private announceNext;
     static styles: import("lit").CSSResult[];
-    willUpdate(changedProperties: PropertyValues): void;
+    protected willUpdate(changed: PropertyValues): void;
+    protected updated(): void;
     connectedCallback(): void;
+    /**
+     * Caps the scroll area at the header plus `fixedRows` real rows. Measuring (rather than
+     * calculating) keeps it exact whatever the font, density or borders.
+     */
+    private applyFixedHeight;
+    private resizeObserver?;
     disconnectedCallback(): void;
-    private handleOutsideClick;
+    private get isServer();
+    private get canMultiSort();
+    private get visibleColumns();
+    private get filterColumns();
+    private get activeFilters();
+    private get hasQuery();
+    private computeView;
+    private optionsFor;
     private emitChange;
-    private handleSearchInput;
-    private handleSort;
-    private get totalPages();
-    private prevPage;
-    private nextPage;
-    private toggleColumnVisibility;
-    private handleDragStart;
-    private handleDragOver;
-    private handleDragLeave;
-    private handleDrop;
+    private emitDebounced;
+    private onSearchInput;
+    private clearSearch;
+    private onSort;
+    private removeSort;
+    private goToPage;
+    private onPageSize;
+    private clearAll;
+    private addFilter;
+    private updateFilter;
+    private onFilterColumn;
+    private onFilterOperator;
+    private removeFilter;
+    private columnItems;
+    private openColumnMenu;
+    private toggleColumn;
+    private moveColumn;
+    private onHeaderKeydown;
+    private onDragStart;
+    private onDragOver;
+    private onDrop;
+    private itemsFor;
+    private rowLabel;
+    private openRowMenu;
+    private onRowContextMenu;
+    private onMenuSelect;
+    private onRowClick;
+    private onRowKeydown;
+    private renderToolbar;
+    private renderFilterPanel;
+    private renderChips;
     private renderSortIcon;
+    private sortLabel;
+    private renderHeader;
+    private renderBody;
+    /** Blank rows that pad a short page up to `fixedRows` so the footer stays put. */
+    private renderSpacers;
+    private renderRows;
+    private renderFooter;
     render(): import("lit-html").TemplateResult<1>;
 }
 declare global {

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

@@ -1 +1 @@
-{"version":3,"file":"data-table.d.ts","sourceRoot":"","sources":["../../../src/components/table/data-table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAa,cAAc,EAAC,MAAM,KAAK,CAAC;AAM1D,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC;CAC3B;AAED,qBACa,WAAY,SAAQ,UAAU;IAChB,OAAO,EAAE,eAAe,EAAE,CAAM;IAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAM;IACP,SAAS,SAAK;IACvC,IAAI,SAAK;IACe,QAAQ,SAAM;IACZ,SAAS,UAAS;IAC5B,OAAO,UAAS;IAEjD,OAAO,CAAC,eAAe,CAAyB;IAChD,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,WAAW,CAAM;IACzB,OAAO,CAAC,cAAc,CAAS;IAExC,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,gBAAgB,CAAuB;IAE/C,MAAM,CAAC,MAAM,4BA+LX;IAEO,UAAU,CAAC,iBAAiB,EAAE,cAAc,QAQpD;IAED,iBAAiB,SAGhB;IAED,oBAAoB,SAGnB;IAED,OAAO,CAAC,kBAAkB,CASxB;IAEF,OAAO,CAAC,UAAU;IAelB,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,UAAU;IAmClB,OAAO,KAAK,UAAU,GAErB;IAED,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,sBAAsB;IAM9B,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,UAAU;IAkBlB,OAAO,CAAC,cAAc;IAmDtB,MAAM,yCAyLL;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,eAAe,EAAE,WAAW,CAAC;KAC9B;CACF"}
+{"version":3,"file":"data-table.d.ts","sourceRoot":"","sources":["../../../src/components/table/data-table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAsB,cAAc,EAAC,MAAM,KAAK,CAAC;AAKnE,OAAO,iBAAiB,CAAC;AACzB,OAAO,yBAAyB,CAAC;AACjC,OAAO,6BAA6B,CAAC;AACrC,OAAO,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAC,QAAQ,EAAgB,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAYL,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,UAAU,EAChB,MAAM,uBAAuB,CAAC;AAE/B,YAAY,EAAC,UAAU,EAAE,eAAe,EAAE,cAAc,EAAE,UAAU,EAAE,UAAU,EAAC,MAAM,uBAAuB,CAAC;AAC/G,YAAY,EAAC,QAAQ,EAAC,MAAM,iCAAiC,CAAC;AAC9D,MAAM,MAAM,UAAU,GAAG,QAAQ,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,QAAQ,EAAE,CAAC,CAAC;AAcjE;;;;;;;;;;;;GAYG;AACH,qBACa,WAAY,SAAQ,UAAU;IAChB,OAAO,EAAE,eAAe,EAAE,CAAM;IAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAM;IAC1D,8DAA8D;IACX,SAAS,SAAK;IACZ,UAAU,UAAS;IAC/B,IAAI,SAAK;IACA,QAAQ,SAAM;IACrB,eAAe,EAAE,MAAM,EAAE,CAAqB;IAEzF,kDAAkD;IACxB,MAAM,SAAM;IACK,IAAI,EAAE,UAAU,EAAE,CAAM;IACxB,OAAO,EAAE,UAAU,EAAE,CAAM;IAEtE,gEAAgE;IACZ,SAAS,UAAQ;IAChB,UAAU,UAAS;IAE9B,OAAO,UAAS;IACF,aAAa,UAAS;IACpC,KAAK,UAAS;IACd,OAAO,UAAS;IACY,YAAY,UAAS;IAC3F;;;;OAIG;IACgD,SAAS,SAAK;IACvC,OAAO,SAAM;IACY,SAAS,SAAwB;IACzB,iBAAiB,SAAa;IACpC,UAAU,UAAS;IACd,cAAc,UAAS;IAC1B,YAAY,UAAS;IAE5E,mFAAmF;IACrD,UAAU,CAAC,EAAE,UAAU,CAAC;IACtD,kGAAkG;IAC5C,WAAW,SAAM;IAE9D,OAAO,CAAC,eAAe,CAAyB;IAChD,OAAO,CAAC,WAAW,CAAM;IACzB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,WAAW,CAAiB;IAEnB,OAAO,CAAC,IAAI,CAAiB;IAEvD,OAAO,CAAC,IAAI,CAAsE;IAClF,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,UAAU,CAAuB;IACzC,OAAO,CAAC,YAAY,CAAS;IAE7B,MAAM,CAAC,MAAM,4BAmXX;IAIF,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,cAAc,QAoB3C;IAED,SAAS,CAAC,OAAO,SAOhB;IAED,iBAAiB,SAIhB;IAED;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAkBxB,OAAO,CAAC,cAAc,CAAC,CAAiB;IAExC,oBAAoB,SAInB;IAID,OAAO,KAAK,QAAQ,GAEnB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,KAAK,cAAc,GAEzB;IAED,OAAO,KAAK,aAAa,GAExB;IAED,OAAO,KAAK,aAAa,GAExB;IAED,OAAO,KAAK,QAAQ,GAEnB;IAED,OAAO,CAAC,WAAW;IAqBnB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,UAAU;IAiBlB,OAAO,CAAC,aAAa;IAKrB,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,MAAM;IAOd,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,QAAQ;IAMhB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,UAAU;IAWlB,OAAO,CAAC,eAAe;IAcvB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,MAAM;IASd,OAAO,CAAC,QAAQ;IAKhB,OAAO,CAAC,QAAQ;IAMhB,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,aAAa;IA4DrB,OAAO,CAAC,iBAAiB;IA8EzB,OAAO,CAAC,WAAW;IA4CnB,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,YAAY;IAuCpB,OAAO,CAAC,UAAU;IAwBlB,kFAAkF;IAClF,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,UAAU;IA0ClB,OAAO,CAAC,YAAY;IA4BpB,MAAM,yCAoBL;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,eAAe,EAAE,WAAW,CAAC;KAC9B;CACF"}