@timlassiter11/yatl 1.0.13 → 1.0.15

package/dist/index.d.mts

@@ -13,6 +13,15 @@ type UnspecifiedRecord = Record<string, any>;
  * Record that maps a column's field to arbitrary data.
  */
 type ColumnPropertyRecord<TData, TProp> = Partial<Record<NestedKeyOf<TData>, TProp>>;
+type RowId = string | number;
+type RowIdCallback<T> = (row: T, index: number) => RowId;
+/**
+ * The method used for selecting rows.
+ * * single - Only a single row can be selected at a time
+ * * multi - Multiple rows can be selected at a time
+ * * null - Disable row selection
+ */
+type RowSelectionMethod = 'single' | 'multi' | null;
 /**
  * Defines the possible sorting orders for columns.
  */
@@ -278,12 +287,13 @@ declare class YatlEvent<T = unknown> extends CustomEvent<T> {
 }
 declare class YatlRowClickEvent<T> extends YatlEvent<{
     row: T;
+    id: RowId;
     index: number;
     field: NestedKeyOf<T>;
     originalEvent: MouseEvent;
 }> {
     static readonly EVENT_NAME = "yatl-row-click";
-    constructor(row: T, index: number, field: NestedKeyOf<T>, originalEvent: MouseEvent);
+    constructor(row: T, id: RowId, index: number, field: NestedKeyOf<T>, originalEvent: MouseEvent);
 }
 declare class YatlChangeEvent<T> extends YatlEvent<{
     data: T[];
@@ -326,6 +336,13 @@ declare class YatlSearchEvent extends YatlEvent<{
     static readonly EVENT_NAME = "yatl-search";
     constructor(query: string);
 }
+declare class YatlRowSelectEvent<T> extends YatlEvent<{
+    row: T;
+    selectedIds: RowId[];
+}> {
+    static readonly EVENT_NAME = "yatl-row-select";
+    constructor(row: T, selectedIds: RowId[]);
+}
 declare class YatlStateChangeEvent<T> extends YatlEvent<{
     state: TableState<T>;
     triggers: string[];
@@ -355,14 +372,16 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private tableElement;
     private virtualizer?;
     private headerElement;
-    private scrollerElement;
     private _enableSearchTokenization;
     private _enableSearchScoring;
     private _columns;
     private _columnDefinitionMap;
     private _columnStateMap;
     private _columnOrder;
+    private _rowSelectionMethod;
+    private _selectedRowIds;
     private _storageOptions;
+    private _rowIdCallback;
     private _data;
     private _searchQuery;
     private _searchTokenizer;
@@ -374,6 +393,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private sortDirty;
     private dataLastUpdate;
     private rowMetadata;
+    private idToRowMap;
     private queryTokens;
     private resizeState;
     private dragColumn;
@@ -427,6 +447,10 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      * @default true
      */
     enableColumnReorder: boolean;
+    /**
+     * Shows a column to the left of each row with its row number.
+     */
+    enableRowNumberColumn: boolean;
     /**
      * Shows the built-in footer row which displays the current record count.
      * The footer content can be customized using the `slot="footer"` element.
@@ -518,12 +542,29 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      * A callback function to conditionally apply CSS parts to table rows.
      */
     rowParts: RowPartsCallback<T> | null;
+    /**
+     * The row selection method to use.
+     * * single - Only a single row can be selected at a time
+     * * multi - Multiple rows can be selected at a time
+     * * null - Disable row selection
+     */
+    get rowSelectionMethod(): RowSelectionMethod;
+    set rowSelectionMethod(selection: RowSelectionMethod);
+    /**
+     * List of currently selected row indexes.
+     * * **NOTE**: These indexes are based off the of
+     * the original data array index, *not* the filtered data.
+     */
+    get selectedRowIds(): RowId[];
+    set selectedRowIds(rows: RowId[]);
     /**
      * Configuration options for automatically saving and restoring table state
      * (column width, order, visibility, etc.) to browser storage.
      */
     get storageOptions(): StorageOptions | null;
     set storageOptions(options: StorageOptions | null);
+    get rowIdCallback(): RowIdCallback<T>;
+    set rowIdCallback(callback: RowIdCallback<T>);
     /**
      * The array of data objects to be displayed.
      * Objects must satisfy the `WeakKey` constraint (objects only, no primitives).
@@ -586,11 +627,17 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     scrollToFilteredIndex(index: number): Promise<void>;
     scrollToPx(px: number): Promise<void>;
     /**
-     * Finds the first row
-     * @param field
-     * @param value
+     * Gets the row associated with the provided ID.
+     * @param id - The ID of the row to get
      * @returns
      */
+    getRow(id: RowId): T | undefined;
+    /**
+     * Finds the first row where {@link field} matches {@link value}
+     * @param field - The field name within the row data to search.
+     * @param value - The value to match against the field's content.
+     * @returns The found row, or undefined if no match is found.
+     */
     findRow(field: NestedKeyOf<T>, value: unknown): T | undefined;
     /**
      * Finds the original index of the first row where the specified field matches the given value.
@@ -607,6 +654,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      * ```
      */
     findRowIndex(field: NestedKeyOf<T>, value: unknown): number;
+    updateRow(rowId: RowId, data: Partial<T>): void;
     /**
      * Updates the data of a row at a specific original index.
      * @param index - The original index of the row to update.
@@ -620,19 +668,28 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      * }
      * ```
      */
-    updateRow(index: number, data: Partial<T>): void;
+    updateRowAtIndex(index: number, data: Partial<T>): void;
+    /**
+     * Deletes the row with the matching ID.
+     * @param id - The ID of the row to delete
+     */
+    deleteRow(rowId: RowId): void;
     /**
      * Deletes a row at a specific original index from the table.
      * @param index - The original index of the row to delete.
      */
-    deleteRow(index: number): void;
+    deleteRowAtIndex(index: number): void;
     protected renderColumnSortIcon(column: DisplayColumnOptions<T>, state: ColumnState<T>): TemplateResult<1> | typeof nothing;
     protected renderColumnResizer(column: DisplayColumnOptions<T>, _state: ColumnState<T>): TemplateResult<1> | typeof nothing;
     protected renderHeaderCell(field: NestedKeyOf<T>): TemplateResult<1> | typeof nothing;
+    protected renderColumnIndexHeader(): TemplateResult<1>;
+    protected renderSelectionHeader(): TemplateResult<1>;
     protected renderHeader(): TemplateResult<1>;
     protected renderCellContents(value: unknown, column: DisplayColumnOptions<T>, row: T): unknown;
     protected renderCell(field: NestedKeyOf<T>, row: T): TemplateResult<1> | typeof nothing | undefined;
-    protected renderRow(row: T, index: number): TemplateResult<1>;
+    protected renderRowSelectorCell(row: T, selected: boolean): TemplateResult<1>;
+    protected renderRowNumberCell(rowNumber: number): TemplateResult<1>;
+    protected renderRow(row: T, renderIndex: number): TemplateResult<1>;
     protected renderBodyContents(): TemplateResult<1>;
     protected renderFooter(): TemplateResult<1> | typeof nothing;
     protected render(): TemplateResult<1>;
@@ -687,6 +744,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private handleDragColumnOver;
     private handleDragColumnDrop;
     private handleDragColumnEnd;
+    private handleRowSelectionClicked;
     addEventListener<K extends keyof EventMap<T>>(type: K, listener: (this: EventMap<T>, ev: EventMap<T>[K]) => void, options?: boolean | AddEventListenerOptions): void;
     addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
     removeEventListener<K extends keyof EventMap<T>>(type: K, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
@@ -703,6 +761,7 @@ interface EventMap<T> {
     'yatl-column-resize': YatlColumnResizeEvent<T>;
     'yatl-column-reorder': YatlColumnReorderEvent<T>;
     'yatl-search': YatlSearchEvent;
+    'yatl-row-select': YatlRowSelectEvent<T>;
     'yatl-state-change': YatlStateChangeEvent<T>;
 }
 declare global {
@@ -711,4 +770,4 @@ declare global {
     }
 }
 
-export { type BaseColumnOptions, type CellPartsCallback, type CellRenderCallback, type ColumnFilterCallback, type ColumnInitOptions, type ColumnOptions, type ColumnPropertyRecord, type ColumnRole, type ColumnState, type ComparatorCallback, type Compareable, type DisplayColumnOptions, type FilterCallback, type Filters, type InternalColumnOptions, type NestedKeyOf, type QueryToken, type RestorableColumnState, type RestorableTableState, type RowPartsCallback, type SortOrder, type SortState, type SortValueCallback, type StorageOptions, type TableState, type TokenizerCallback, type UnspecifiedRecord, type ValueFormatterCallback, YatlChangeEvent, YatlColumnReorderEvent, YatlColumnResizeEvent, YatlColumnToggleEvent, YatlEvent, YatlRowClickEvent, YatlSearchEvent, YatlSortEvent, YatlStateChangeEvent, YatlTable, createRegexTokenizer, isDisplayColumn, isInternalColumn, whitespaceTokenizer };
+export { type BaseColumnOptions, type CellPartsCallback, type CellRenderCallback, type ColumnFilterCallback, type ColumnInitOptions, type ColumnOptions, type ColumnPropertyRecord, type ColumnRole, type ColumnState, type ComparatorCallback, type Compareable, type DisplayColumnOptions, type FilterCallback, type Filters, type InternalColumnOptions, type NestedKeyOf, type QueryToken, type RestorableColumnState, type RestorableTableState, type RowId, type RowIdCallback, type RowPartsCallback, type RowSelectionMethod, type SortOrder, type SortState, type SortValueCallback, type StorageOptions, type TableState, type TokenizerCallback, type UnspecifiedRecord, type ValueFormatterCallback, YatlChangeEvent, YatlColumnReorderEvent, YatlColumnResizeEvent, YatlColumnToggleEvent, YatlEvent, YatlRowClickEvent, YatlRowSelectEvent, YatlSearchEvent, YatlSortEvent, YatlStateChangeEvent, YatlTable, createRegexTokenizer, isDisplayColumn, isInternalColumn, whitespaceTokenizer };

package/dist/index.d.ts

@@ -13,6 +13,15 @@ type UnspecifiedRecord = Record<string, any>;
  * Record that maps a column's field to arbitrary data.
  */
 type ColumnPropertyRecord<TData, TProp> = Partial<Record<NestedKeyOf<TData>, TProp>>;
+type RowId = string | number;
+type RowIdCallback<T> = (row: T, index: number) => RowId;
+/**
+ * The method used for selecting rows.
+ * * single - Only a single row can be selected at a time
+ * * multi - Multiple rows can be selected at a time
+ * * null - Disable row selection
+ */
+type RowSelectionMethod = 'single' | 'multi' | null;
 /**
  * Defines the possible sorting orders for columns.
  */
@@ -278,12 +287,13 @@ declare class YatlEvent<T = unknown> extends CustomEvent<T> {
 }
 declare class YatlRowClickEvent<T> extends YatlEvent<{
     row: T;
+    id: RowId;
     index: number;
     field: NestedKeyOf<T>;
     originalEvent: MouseEvent;
 }> {
     static readonly EVENT_NAME = "yatl-row-click";
-    constructor(row: T, index: number, field: NestedKeyOf<T>, originalEvent: MouseEvent);
+    constructor(row: T, id: RowId, index: number, field: NestedKeyOf<T>, originalEvent: MouseEvent);
 }
 declare class YatlChangeEvent<T> extends YatlEvent<{
     data: T[];
@@ -326,6 +336,13 @@ declare class YatlSearchEvent extends YatlEvent<{
     static readonly EVENT_NAME = "yatl-search";
     constructor(query: string);
 }
+declare class YatlRowSelectEvent<T> extends YatlEvent<{
+    row: T;
+    selectedIds: RowId[];
+}> {
+    static readonly EVENT_NAME = "yatl-row-select";
+    constructor(row: T, selectedIds: RowId[]);
+}
 declare class YatlStateChangeEvent<T> extends YatlEvent<{
     state: TableState<T>;
     triggers: string[];
@@ -355,14 +372,16 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private tableElement;
     private virtualizer?;
     private headerElement;
-    private scrollerElement;
     private _enableSearchTokenization;
     private _enableSearchScoring;
     private _columns;
     private _columnDefinitionMap;
     private _columnStateMap;
     private _columnOrder;
+    private _rowSelectionMethod;
+    private _selectedRowIds;
     private _storageOptions;
+    private _rowIdCallback;
     private _data;
     private _searchQuery;
     private _searchTokenizer;
@@ -374,6 +393,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private sortDirty;
     private dataLastUpdate;
     private rowMetadata;
+    private idToRowMap;
     private queryTokens;
     private resizeState;
     private dragColumn;
@@ -427,6 +447,10 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      * @default true
      */
     enableColumnReorder: boolean;
+    /**
+     * Shows a column to the left of each row with its row number.
+     */
+    enableRowNumberColumn: boolean;
     /**
      * Shows the built-in footer row which displays the current record count.
      * The footer content can be customized using the `slot="footer"` element.
@@ -518,12 +542,29 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      * A callback function to conditionally apply CSS parts to table rows.
      */
     rowParts: RowPartsCallback<T> | null;
+    /**
+     * The row selection method to use.
+     * * single - Only a single row can be selected at a time
+     * * multi - Multiple rows can be selected at a time
+     * * null - Disable row selection
+     */
+    get rowSelectionMethod(): RowSelectionMethod;
+    set rowSelectionMethod(selection: RowSelectionMethod);
+    /**
+     * List of currently selected row indexes.
+     * * **NOTE**: These indexes are based off the of
+     * the original data array index, *not* the filtered data.
+     */
+    get selectedRowIds(): RowId[];
+    set selectedRowIds(rows: RowId[]);
     /**
      * Configuration options for automatically saving and restoring table state
      * (column width, order, visibility, etc.) to browser storage.
      */
     get storageOptions(): StorageOptions | null;
     set storageOptions(options: StorageOptions | null);
+    get rowIdCallback(): RowIdCallback<T>;
+    set rowIdCallback(callback: RowIdCallback<T>);
     /**
      * The array of data objects to be displayed.
      * Objects must satisfy the `WeakKey` constraint (objects only, no primitives).
@@ -586,11 +627,17 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     scrollToFilteredIndex(index: number): Promise<void>;
     scrollToPx(px: number): Promise<void>;
     /**
-     * Finds the first row
-     * @param field
-     * @param value
+     * Gets the row associated with the provided ID.
+     * @param id - The ID of the row to get
      * @returns
      */
+    getRow(id: RowId): T | undefined;
+    /**
+     * Finds the first row where {@link field} matches {@link value}
+     * @param field - The field name within the row data to search.
+     * @param value - The value to match against the field's content.
+     * @returns The found row, or undefined if no match is found.
+     */
     findRow(field: NestedKeyOf<T>, value: unknown): T | undefined;
     /**
      * Finds the original index of the first row where the specified field matches the given value.
@@ -607,6 +654,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      * ```
      */
     findRowIndex(field: NestedKeyOf<T>, value: unknown): number;
+    updateRow(rowId: RowId, data: Partial<T>): void;
     /**
      * Updates the data of a row at a specific original index.
      * @param index - The original index of the row to update.
@@ -620,19 +668,28 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      * }
      * ```
      */
-    updateRow(index: number, data: Partial<T>): void;
+    updateRowAtIndex(index: number, data: Partial<T>): void;
+    /**
+     * Deletes the row with the matching ID.
+     * @param id - The ID of the row to delete
+     */
+    deleteRow(rowId: RowId): void;
     /**
      * Deletes a row at a specific original index from the table.
      * @param index - The original index of the row to delete.
      */
-    deleteRow(index: number): void;
+    deleteRowAtIndex(index: number): void;
     protected renderColumnSortIcon(column: DisplayColumnOptions<T>, state: ColumnState<T>): TemplateResult<1> | typeof nothing;
     protected renderColumnResizer(column: DisplayColumnOptions<T>, _state: ColumnState<T>): TemplateResult<1> | typeof nothing;
     protected renderHeaderCell(field: NestedKeyOf<T>): TemplateResult<1> | typeof nothing;
+    protected renderColumnIndexHeader(): TemplateResult<1>;
+    protected renderSelectionHeader(): TemplateResult<1>;
     protected renderHeader(): TemplateResult<1>;
     protected renderCellContents(value: unknown, column: DisplayColumnOptions<T>, row: T): unknown;
     protected renderCell(field: NestedKeyOf<T>, row: T): TemplateResult<1> | typeof nothing | undefined;
-    protected renderRow(row: T, index: number): TemplateResult<1>;
+    protected renderRowSelectorCell(row: T, selected: boolean): TemplateResult<1>;
+    protected renderRowNumberCell(rowNumber: number): TemplateResult<1>;
+    protected renderRow(row: T, renderIndex: number): TemplateResult<1>;
     protected renderBodyContents(): TemplateResult<1>;
     protected renderFooter(): TemplateResult<1> | typeof nothing;
     protected render(): TemplateResult<1>;
@@ -687,6 +744,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private handleDragColumnOver;
     private handleDragColumnDrop;
     private handleDragColumnEnd;
+    private handleRowSelectionClicked;
     addEventListener<K extends keyof EventMap<T>>(type: K, listener: (this: EventMap<T>, ev: EventMap<T>[K]) => void, options?: boolean | AddEventListenerOptions): void;
     addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
     removeEventListener<K extends keyof EventMap<T>>(type: K, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
@@ -703,6 +761,7 @@ interface EventMap<T> {
     'yatl-column-resize': YatlColumnResizeEvent<T>;
     'yatl-column-reorder': YatlColumnReorderEvent<T>;
     'yatl-search': YatlSearchEvent;
+    'yatl-row-select': YatlRowSelectEvent<T>;
     'yatl-state-change': YatlStateChangeEvent<T>;
 }
 declare global {
@@ -711,4 +770,4 @@ declare global {
     }
 }
 
-export { type BaseColumnOptions, type CellPartsCallback, type CellRenderCallback, type ColumnFilterCallback, type ColumnInitOptions, type ColumnOptions, type ColumnPropertyRecord, type ColumnRole, type ColumnState, type ComparatorCallback, type Compareable, type DisplayColumnOptions, type FilterCallback, type Filters, type InternalColumnOptions, type NestedKeyOf, type QueryToken, type RestorableColumnState, type RestorableTableState, type RowPartsCallback, type SortOrder, type SortState, type SortValueCallback, type StorageOptions, type TableState, type TokenizerCallback, type UnspecifiedRecord, type ValueFormatterCallback, YatlChangeEvent, YatlColumnReorderEvent, YatlColumnResizeEvent, YatlColumnToggleEvent, YatlEvent, YatlRowClickEvent, YatlSearchEvent, YatlSortEvent, YatlStateChangeEvent, YatlTable, createRegexTokenizer, isDisplayColumn, isInternalColumn, whitespaceTokenizer };
+export { type BaseColumnOptions, type CellPartsCallback, type CellRenderCallback, type ColumnFilterCallback, type ColumnInitOptions, type ColumnOptions, type ColumnPropertyRecord, type ColumnRole, type ColumnState, type ComparatorCallback, type Compareable, type DisplayColumnOptions, type FilterCallback, type Filters, type InternalColumnOptions, type NestedKeyOf, type QueryToken, type RestorableColumnState, type RestorableTableState, type RowId, type RowIdCallback, type RowPartsCallback, type RowSelectionMethod, type SortOrder, type SortState, type SortValueCallback, type StorageOptions, type TableState, type TokenizerCallback, type UnspecifiedRecord, type ValueFormatterCallback, YatlChangeEvent, YatlColumnReorderEvent, YatlColumnResizeEvent, YatlColumnToggleEvent, YatlEvent, YatlRowClickEvent, YatlRowSelectEvent, YatlSearchEvent, YatlSortEvent, YatlStateChangeEvent, YatlTable, createRegexTokenizer, isDisplayColumn, isInternalColumn, whitespaceTokenizer };