@qualcomm-ui/core 1.0.0

package/dist/table/features/pagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../../src/table/features/pagination.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EACV,UAAU,EACV,OAAO,EACP,QAAQ,EACR,aAAa,EACb,OAAO,EACR,MAAM,UAAU,CAAA;AAGjB,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAA;CACtC;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE;IACtB,kBAAkB;IAClB,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,KACtB,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;IACxB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,CAAA;IAChD;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,kBAAkB,EAAE,UAAU,CAAC,eAAe,CAAC,CAAA;CAChD;AAED,MAAM,WAAW,kBAAkB,CAAC,KAAK,SAAS,OAAO;IACvD,gBAAgB;IAChB,mBAAmB,EAAE,MAAM,IAAI,CAAA;IAC/B,gBAAgB;IAChB,sBAAsB,CAAC,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC9C;;OAEG;IACH,cAAc,EAAE,MAAM,OAAO,CAAA;IAC7B;;OAEG;IACH,kBAAkB,EAAE,MAAM,OAAO,CAAA;IACjC;;;;;OAKG;IACH,YAAY,EAAE,MAAM,MAAM,CAAA;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,MAAM,EAAE,CAAA;IAC9B;;OAEG;IACH,qBAAqB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC5C;;OAEG;IACH,wBAAwB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAA;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,IAAI,CAAA;IACxB;;;OAGG;IACH,cAAc,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAChD;;;OAGG;IACH,aAAa,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAC/C;;;OAGG;IACH,eAAe,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IACjD;;OAEG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,CAAA;IAChD;;;OAGG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,CAAA;IAChD;;;OAGG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,CAAA;IAC/C;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,KAAK,IAAI,CAAA;CAC3D;AAUD,eAAO,MAAM,UAAU,EAAE,YAkMxB,CAAA"}

package/dist/table/features/pinning.d.ts

@@ -0,0 +1,227 @@
+import type { TableFeature } from "../core/table";
+import type { Cell, Column, OnChangeFn, Row, RowData, Updater } from "../types";
+export type ColumnPinningPosition = false | "left" | "right";
+export type RowPinningPosition = false | "top" | "bottom";
+export interface ColumnPinningState {
+    left?: string[];
+    right?: string[];
+}
+export interface RowPinningState {
+    bottom?: string[];
+    includeLeafRows?: boolean;
+    includeParentRows?: boolean;
+    top?: string[];
+}
+export interface ColumnPinningTableState {
+    columnPinning: ColumnPinningState;
+}
+export interface RowPinningTableState {
+    rowPinning: RowPinningState;
+}
+export interface ColumnPinningOptions {
+    /**
+     * Enables/disables column pinning for the table. Defaults to `true`.
+     */
+    enableColumnPinning?: boolean;
+    /**
+     * Enables/disables all pinning for the table. Defaults to `true`.
+     */
+    enablePinning?: boolean;
+    /**
+     * If provided, this function will be called with an `updaterFn` when
+     * `state.columnPinning` changes. This overrides the default internal state
+     * management, so you will also need to supply `state.columnPinning` from your own
+     * managed state.
+     */
+    onColumnPinningChange?: OnChangeFn<ColumnPinningState>;
+}
+export interface RowPinningOptions<TData extends RowData> {
+    /**
+     * Enables/disables row pinning for the table. Defaults to `true`.
+     */
+    enableRowPinning?: boolean | ((
+    /** @inheritDoc */
+    row: Row<TData>) => boolean);
+    /**
+     * Include child rows when pinning parent.
+     */
+    includeLeafRows?: boolean;
+    /**
+     * Include parent rows when pinning child.
+     */
+    includeParentRows?: boolean;
+    /**
+     * When `false`, pinned rows will not be visible if they are filtered or paginated
+     * out of the table. When `true`, pinned rows will always be visible regardless of
+     * filtering or pagination. Defaults to `true`.
+     */
+    keepPinnedRows?: boolean;
+    /**
+     * If provided, this function will be called with an `updaterFn` when
+     * `state.rowPinning` changes. This overrides the default internal state
+     * management, so you will also need to supply `state.rowPinning` from your own
+     * managed state.
+     */
+    onRowPinningChange?: OnChangeFn<RowPinningState>;
+}
+export interface ColumnPinningDefaultOptions {
+    onColumnPinningChange: OnChangeFn<ColumnPinningState>;
+}
+export interface RowPinningDefaultOptions {
+    onRowPinningChange: OnChangeFn<RowPinningState>;
+}
+export interface ColumnPinningColumnDef {
+    /**
+     * Enables/disables column pinning for this column. Defaults to `true`.
+     */
+    enablePinning?: boolean;
+}
+export interface ColumnPinningColumn {
+    /**
+     * Returns whether the column can be pinned.
+     */
+    getCanPin: () => boolean;
+    /**
+     * Returns the pinned position of the column. (`'left'`, `'right'` or `false`)
+     */
+    getIsPinned: () => ColumnPinningPosition;
+    /**
+     * Returns whether the column is pinned to the left.
+     */
+    getIsPinnedLeft: () => boolean;
+    /**
+     * Returns whether the column is pinned to the right.
+     */
+    getIsPinnedRight: () => boolean;
+    /**
+     * Returns the numeric pinned index of the column within a pinned column group.
+     */
+    getPinnedIndex: () => number;
+    /**
+     * Pins a column to the `'left'` or `'right'`, or unpins the column to the center
+     * if `false` is passed.
+     */
+    pin: (position: ColumnPinningPosition) => void;
+}
+export interface ColumnPinningRow<TData extends RowData> {
+    /**
+     * Returns all center pinned (unpinned) leaf cells in the row.
+     *
+     * @inheritDoc
+     */
+    getCenterVisibleCells: () => Cell<TData, unknown>[];
+    /**
+     * Returns all left pinned leaf cells in the row.
+     *
+     * @inheritDoc
+     */
+    getLeftVisibleCells: () => Cell<TData, unknown>[];
+    /**
+     * Returns all right pinned leaf cells in the row.
+     *
+     * @inheritDoc
+     */
+    getRightVisibleCells: () => Cell<TData, unknown>[];
+}
+export interface RowPinningRow {
+    /**
+     * Returns whether the row can be pinned.
+     */
+    getCanPin: () => boolean;
+    /**
+     * Returns the pinned position of the row. (`'top'`, `'bottom'` or `false`)
+     */
+    getIsPinned: () => RowPinningPosition;
+    /**
+     * Returns whether the row is pinned to the bottom.
+     */
+    getIsPinnedBottom: () => boolean;
+    /**
+     * Returns whether the row is pinned to the top.
+     */
+    getIsPinnedTop: () => boolean;
+    /**
+     * Returns the numeric pinned index of the row within a pinned row group.
+     */
+    getPinnedIndex: () => number;
+    /**
+     * Pins a row to the `top` or `bottom` or unpins the row to the center if `false`
+     * is passed.
+     */
+    pin: (position: RowPinningPosition, includeLeafRows?: boolean, includeParentRows?: boolean) => void;
+}
+export interface ColumnPinningInstance<TData extends RowData> {
+    /**
+     * Returns all center pinned (unpinned) leaf columns.
+     *
+     * @inheritDoc
+     */
+    getCenterLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Returns whether any columns are pinned. Optionally specify to only check
+     * for pinned columns in either the `left` or `right` position.
+     */
+    getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean;
+    /**
+     * Returns all left pinned leaf columns.
+     *
+     * @inheritDoc
+     */
+    getLeftLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Returns all right pinned leaf columns.
+     *
+     * @inheritDoc
+     */
+    getRightLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Resets the `columnPinning` state to `initialState.columnPinning`, or `true`
+     * can be passed to force a default blank state reset to `{ left: [], right: [],
+     * }`.
+     */
+    resetColumnPinning: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.columnPinning` state.
+     *
+     * @inheritDoc
+     */
+    setColumnPinning: (updater: Updater<ColumnPinningState>) => void;
+}
+export interface RowPinningInstance<TData extends RowData> {
+    /** @internal */
+    _getPinnedRows: (position: "top" | "bottom") => Row<TData>[];
+    /**
+     * Returns all bottom pinned rows.
+     *
+     * @inheritDoc
+     */
+    getBottomRows: () => Row<TData>[];
+    /**
+     * Returns all rows that are not pinned to the top or bottom.
+     *
+     * @inheritDoc
+     */
+    getCenterRows: () => Row<TData>[];
+    /**
+     * Returns whether any rows are pinned. Optionally specify to only check
+     * for pinned rows in either the `top` or `bottom` position.
+     */
+    getIsSomeRowsPinned: (position?: RowPinningPosition) => boolean;
+    /**
+     * Returns all top pinned rows.
+     *
+     * @inheritDoc
+     */
+    getTopRows: () => Row<TData>[];
+    /**
+     * Resets the `rowPinning` state to `initialState.rowPinning`, or `true` can be
+     * passed to force a default blank state reset to `{ top: [], bottom: [], }`.
+     */
+    resetRowPinning: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.rowPinning` state.
+     */
+    setRowPinning: (updater: Updater<RowPinningState>) => void;
+}
+export declare const Pinning: TableFeature;
+//# sourceMappingURL=pinning.d.ts.map

package/dist/table/features/pinning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pinning.d.ts","sourceRoot":"","sources":["../../../src/table/features/pinning.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EACV,IAAI,EACJ,MAAM,EAEN,UAAU,EACV,GAAG,EACH,OAAO,EAEP,OAAO,EACR,MAAM,UAAU,CAAA;AAGjB,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAA;AAC5D,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAA;AAEzD,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,kBAAkB,CAAA;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAA;CACvD;AAED,MAAM,WAAW,iBAAiB,CAAC,KAAK,SAAS,OAAO;IACtD;;OAEG;IACH,gBAAgB,CAAC,EACb,OAAO,GACP,CAAC;IACC,kBAAkB;IAClB,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,KACZ,OAAO,CAAC,CAAA;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,CAAA;CACjD;AAED,MAAM,WAAW,2BAA2B;IAC1C,qBAAqB,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAA;CACtD;AAED,MAAM,WAAW,wBAAwB;IACvC,kBAAkB,EAAE,UAAU,CAAC,eAAe,CAAC,CAAA;CAChD;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,OAAO,CAAA;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,qBAAqB,CAAA;IACxC;;OAEG;IACH,eAAe,EAAE,MAAM,OAAO,CAAA;IAC9B;;OAEG;IACH,gBAAgB,EAAE,MAAM,OAAO,CAAA;IAC/B;;OAEG;IACH,cAAc,EAAE,MAAM,MAAM,CAAA;IAC5B;;;OAGG;IACH,GAAG,EAAE,CAAC,QAAQ,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC/C;AAED,MAAM,WAAW,gBAAgB,CAAC,KAAK,SAAS,OAAO;IACrD;;;;OAIG;IACH,qBAAqB,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;IACnD;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;IACjD;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;CACnD;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,OAAO,CAAA;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,kBAAkB,CAAA;IACrC;;OAEG;IACH,iBAAiB,EAAE,MAAM,OAAO,CAAA;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,OAAO,CAAA;IAC7B;;OAEG;IACH,cAAc,EAAE,MAAM,MAAM,CAAA;IAC5B;;;OAGG;IACH,GAAG,EAAE,CACH,QAAQ,EAAE,kBAAkB,EAC5B,eAAe,CAAC,EAAE,OAAO,EACzB,iBAAiB,CAAC,EAAE,OAAO,KACxB,IAAI,CAAA;CACV;AAED,MAAM,WAAW,qBAAqB,CAAC,KAAK,SAAS,OAAO;IAC1D;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;IACpD;;;OAGG;IACH,sBAAsB,EAAE,CAAC,QAAQ,CAAC,EAAE,qBAAqB,KAAK,OAAO,CAAA;IACrE;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;IAClD;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;IACnD;;;;OAIG;IACH,kBAAkB,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IACpD;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAA;CACjE;AAED,MAAM,WAAW,kBAAkB,CAAC,KAAK,SAAS,OAAO;IACvD,gBAAgB;IAChB,cAAc,EAAE,CAAC,QAAQ,EAAE,KAAK,GAAG,QAAQ,KAAK,GAAG,CAAC,KAAK,CAAC,EAAE,CAAA;IAC5D;;;;OAIG;IACH,aAAa,EAAE,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAA;IACjC;;;;OAIG;IACH,aAAa,EAAE,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAA;IACjC;;;OAGG;IACH,mBAAmB,EAAE,CAAC,QAAQ,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAA;IAC/D;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAA;IAC9B;;;OAGG;IACH,eAAe,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IACjD;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,KAAK,IAAI,CAAA;CAC3D;AAcD,eAAO,MAAM,OAAO,EAAE,YA4VrB,CAAA"}

package/dist/table/features/row-selection.d.ts

@@ -0,0 +1,148 @@
+import type { TableFeature } from "../core/table";
+import type { OnChangeFn, Row, RowData, RowModel, TableInstance, Updater } from "../types";
+export type RowSelectionState = Record<string, boolean>;
+export interface RowSelectionTableState {
+    rowSelection: RowSelectionState;
+}
+export interface RowSelectionOptions<TData extends RowData> {
+    /**
+     * - Enables/disables multiple row selection for all rows in the table OR
+     * - A function that given a row, returns whether to enable/disable multiple row
+     * selection for that row's children/grandchildren
+     */
+    enableMultiRowSelection?: boolean | ((
+    /**
+     * @inheritDoc
+     */
+    row: Row<TData>) => boolean);
+    /**
+     * - Enables/disables row selection for all rows in the table OR
+     * - A function that given a row, returns whether to enable/disable row selection
+     * for that row
+     */
+    enableRowSelection?: boolean | ((
+    /**
+     * @inheritDoc
+     */
+    row: Row<TData>) => boolean);
+    /**
+     * Enables/disables automatic sub-row selection when a parent row is selected, or
+     * a function that enables/disables automatic sub-row selection for each row. (Use
+     * in combination with expanding or grouping features)
+     */
+    enableSubRowSelection?: boolean | ((
+    /**
+     * @inheritDoc
+     */
+    row: Row<TData>) => boolean);
+    /**
+     * If provided, this function will be called with an `updaterFn` when
+     * `state.rowSelection` changes. This overrides the default internal state
+     * management, so you will need to persist the state change either fully or
+     * partially outside of the table.
+     */
+    onRowSelectionChange?: OnChangeFn<RowSelectionState>;
+}
+export interface RowSelectionRow {
+    /**
+     * Returns whether the row can multi-select.
+     */
+    getCanMultiSelect: () => boolean;
+    /**
+     * Returns whether the row can be selected.
+     */
+    getCanSelect: () => boolean;
+    /**
+     * Returns whether the row can select sub rows automatically when the
+     * parent row is selected.
+     */
+    getCanSelectSubRows: () => boolean;
+    /**
+     * Returns whether all of the row's sub rows are selected.
+     */
+    getIsAllSubRowsSelected: () => boolean;
+    /**
+     * Returns whether the row is selected.
+     */
+    getIsSelected: () => boolean;
+    /**
+     * Returns whether some of the row's sub rows are selected.
+     */
+    getIsSomeSelected: () => boolean;
+    /**
+     * Returns a handler that can be used to toggle the row.
+     */
+    getToggleSelectedHandler: () => (event: unknown) => void;
+    /**
+     * Selects/deselects the row.
+     */
+    toggleSelected: (value?: boolean, opts?: {
+        selectChildren?: boolean;
+    }) => void;
+}
+export interface RowSelectionInstance<TData extends RowData> {
+    /**
+     * Returns the row model of all rows that are selected after filtering has been
+     * applied.
+     */
+    getFilteredSelectedRowModel: () => RowModel<TData>;
+    /**
+     * Returns the row model of all rows that are selected after grouping has been
+     * applied.
+     */
+    getGroupedSelectedRowModel: () => RowModel<TData>;
+    /**
+     * Returns whether all rows on the current page are selected.
+     */
+    getIsAllPageRowsSelected: () => boolean;
+    /**
+     * Returns whether all rows in the table are selected.
+     */
+    getIsAllRowsSelected: () => boolean;
+    /**
+     * Returns whether any rows on the current page are selected.
+     */
+    getIsSomePageRowsSelected: () => boolean;
+    /**
+     * Returns whether any rows in the table are selected.
+     */
+    getIsSomeRowsSelected: () => boolean;
+    /**
+     * Returns the core row model of all rows before row selection has been applied.
+     */
+    getPreSelectedRowModel: () => RowModel<TData>;
+    /**
+     * Returns the row model of all rows that are selected.
+     */
+    getSelectedRowModel: () => RowModel<TData>;
+    /**
+     * Returns a handler that can be used to toggle all rows on the current page.
+     */
+    getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void;
+    /**
+     * Returns a handler that can be used to toggle all rows in the table.
+     */
+    getToggleAllRowsSelectedHandler: () => (event: unknown) => void;
+    /**
+     * Resets the `rowSelection` state to the `initialState.rowSelection`, or `true`
+     * can be passed to force a default blank state reset to `{}`.
+     */
+    resetRowSelection: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.rowSelection` state.
+     */
+    setRowSelection: (updater: Updater<RowSelectionState>) => void;
+    /**
+     * Selects/deselects all rows on the current page.
+     */
+    toggleAllPageRowsSelected: (value?: boolean) => void;
+    /**
+     * Selects/deselects all rows in the table.
+     */
+    toggleAllRowsSelected: (value?: boolean) => void;
+}
+export declare const RowSelection: TableFeature;
+export declare function selectRowsFn<TData extends RowData>(table: TableInstance<TData>, rowModel: RowModel<TData>): RowModel<TData>;
+export declare function isRowSelected<TData extends RowData>(row: Row<TData>, selection: RowSelectionState): boolean;
+export declare function isSubRowSelected<TData extends RowData>(row: Row<TData>, selection: RowSelectionState, table: TableInstance<TData>): boolean | "some" | "all";
+//# sourceMappingURL=row-selection.d.ts.map

package/dist/table/features/row-selection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"row-selection.d.ts","sourceRoot":"","sources":["../../../src/table/features/row-selection.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EACV,UAAU,EACV,GAAG,EACH,OAAO,EACP,QAAQ,EACR,aAAa,EACb,OAAO,EACR,MAAM,UAAU,CAAA;AAGjB,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEvD,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,iBAAiB,CAAA;CAChC;AAED,MAAM,WAAW,mBAAmB,CAAC,KAAK,SAAS,OAAO;IACxD;;;;OAIG;IACH,uBAAuB,CAAC,EACpB,OAAO,GACP,CAAC;IACC;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,KACZ,OAAO,CAAC,CAAA;IAEjB;;;;OAIG;IACH,kBAAkB,CAAC,EACf,OAAO,GACP,CAAC;IACC;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,KACZ,OAAO,CAAC,CAAA;IAEjB;;;;OAIG;IACH,qBAAqB,CAAC,EAClB,OAAO,GACP,CAAC;IACC;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,KACZ,OAAO,CAAC,CAAA;IAEjB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,iBAAiB,EAAE,MAAM,OAAO,CAAA;IAEhC;;OAEG;IACH,YAAY,EAAE,MAAM,OAAO,CAAA;IAE3B;;;OAGG;IACH,mBAAmB,EAAE,MAAM,OAAO,CAAA;IAElC;;OAEG;IACH,uBAAuB,EAAE,MAAM,OAAO,CAAA;IAEtC;;OAEG;IACH,aAAa,EAAE,MAAM,OAAO,CAAA;IAE5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,OAAO,CAAA;IAEhC;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;IAExD;;OAEG;IACH,cAAc,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE;QAAC,cAAc,CAAC,EAAE,OAAO,CAAA;KAAC,KAAK,IAAI,CAAA;CAC7E;AAED,MAAM,WAAW,oBAAoB,CAAC,KAAK,SAAS,OAAO;IACzD;;;OAGG;IACH,2BAA2B,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAElD;;;OAGG;IACH,0BAA0B,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAEjD;;OAEG;IACH,wBAAwB,EAAE,MAAM,OAAO,CAAA;IAEvC;;OAEG;IACH,oBAAoB,EAAE,MAAM,OAAO,CAAA;IAEnC;;OAEG;IACH,yBAAyB,EAAE,MAAM,OAAO,CAAA;IAExC;;OAEG;IACH,qBAAqB,EAAE,MAAM,OAAO,CAAA;IAEpC;;OAEG;IACH,sBAAsB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAE7C;;OAEG;IACH,mBAAmB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAE1C;;OAEG;IACH,mCAAmC,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;IAEnE;;OAEG;IACH,+BAA+B,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;IAE/D;;;OAGG;IACH,iBAAiB,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAEnD;;OAEG;IACH,eAAe,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAA;IAE9D;;OAEG;IACH,yBAAyB,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAEpD;;OAEG;IACH,qBAAqB,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;CACjD;AAED,eAAO,MAAM,YAAY,EAAE,YA2R1B,CAAA;AAmCD,wBAAgB,YAAY,CAAC,KAAK,SAAS,OAAO,EAChD,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,EAC3B,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,GACxB,QAAQ,CAAC,KAAK,CAAC,CAsCjB;AA+BD,wBAAgB,aAAa,CAAC,KAAK,SAAS,OAAO,EACjD,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,EACf,SAAS,EAAE,iBAAiB,GAC3B,OAAO,CAET;AAED,wBAAgB,gBAAgB,CAAC,KAAK,SAAS,OAAO,EACpD,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,EACf,SAAS,EAAE,iBAAiB,EAC5B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,GAC1B,OAAO,GAAG,MAAM,GAAG,KAAK,CAqC1B"}

package/dist/table/features/sorting.d.ts

@@ -0,0 +1,194 @@
+import type { RowModel } from "..";
+import type { TableFeature } from "../core/table";
+import { type BuiltInSortingFn } from "../sorting-fns";
+import type { OnChangeFn, Row, RowData, SortingFns, TableInstance, Updater } from "../types";
+export type SortDirection = "asc" | "desc";
+export interface ColumnSort {
+    desc: boolean;
+    id: string;
+}
+export type SortingState = ColumnSort[];
+export interface SortingTableState {
+    sorting: SortingState;
+}
+export interface SortingFn<TData extends RowData> {
+    (rowA: Row<TData>, rowB: Row<TData>, columnId: string): number;
+}
+export type CustomSortingFns<TData extends RowData> = Record<string, SortingFn<TData>>;
+export type SortingFnOption<TData extends RowData> = "auto" | BuiltInSortingFn | SortingFn<TData>;
+export interface SortingColumnDef<TData extends RowData> {
+    /**
+     * Enables/Disables multi-sorting for this column.
+     */
+    enableMultiSort?: boolean;
+    /**
+     * Enables/Disables sorting for this column.
+     */
+    enableSorting?: boolean;
+    /**
+     * Inverts the order of the sorting for this column. This is useful for values
+     * that have an inverted best/worst scale where lower numbers are better, e.g.,a
+     * ranking (1st, 2nd, 3rd) or golf-like scoring
+     */
+    invertSorting?: boolean;
+    /**
+     * Set to `true` for sorting toggles on this column to start in the descending
+     * direction.
+     */
+    sortDescFirst?: boolean;
+    /**
+     * The sorting function to use with this column.
+     * - A `string` referencing a built-in sorting function
+     * - A custom sorting function
+     */
+    sortingFn?: SortingFnOption<TData>;
+    /**
+     * Configure how undefined values are sorted for this column.
+     *
+     * @option `false`: Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies).
+     * @option `-1`: Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)
+     * @option `1`: Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)
+     */
+    sortUndefined?: false | -1 | 1;
+}
+export interface SortingColumn<TData extends RowData> {
+    /**
+     * Removes this column from the table's sorting state
+     */
+    clearSorting: () => void;
+    /**
+     * Returns a sort direction automatically inferred based on the columns values.
+     */
+    getAutoSortDir: () => SortDirection;
+    /**
+     * Returns a sorting function automatically inferred based on the columns values.
+     */
+    getAutoSortingFn: () => SortingFn<TData>;
+    /**
+     * Returns whether this column can be multi-sorted.
+     */
+    getCanMultiSort: () => boolean;
+    /**
+     * Returns whether this column can be sorted.
+     */
+    getCanSort: () => boolean;
+    /**
+     * Returns the first direction that should be used when sorting this column.
+     */
+    getFirstSortDir: () => SortDirection;
+    /**
+     * Returns the current sort direction of this column.
+     */
+    getIsSorted: () => false | SortDirection;
+    /**
+     * Returns the next sorting order.
+     */
+    getNextSortingOrder: () => SortDirection | false;
+    /**
+     * Returns the index position of this column's sorting within the sorting state
+     */
+    getSortIndex: () => number;
+    /**
+     * Returns the resolved sorting function to be used for this column
+     */
+    getSortingFn: () => SortingFn<TData>;
+    /**
+     * Returns a function that can be used to toggle this column's sorting state. This
+     * is useful for attaching a click handler to the column header.
+     */
+    getToggleSortingHandler: () => undefined | ((event: unknown) => void);
+    /**
+     * Toggles this columns sorting state. If `desc` is provided, it will force the
+     * sort direction to that value. If `isMulti` is provided, it will additivity
+     * multi-sort the column (or toggle it if it is already sorted).
+     */
+    toggleSorting: (desc?: boolean, isMulti?: boolean) => void;
+}
+interface SortingOptionsBase {
+    /**
+     * Enables/disables the ability to remove multi-sorts
+     */
+    enableMultiRemove?: boolean;
+    /**
+     * Enables/Disables multi-sorting for the table.
+     */
+    enableMultiSort?: boolean;
+    /**
+     * Enables/Disables sorting for the table.
+     */
+    enableSorting?: boolean;
+    /**
+     * Enables/Disables the ability to remove sorting for the table.
+     * - If `true` then changing sort order will circle like: 'none' -> 'desc' ->
+     * 'asc' -> 'none' -> ... - If `false` then changing sort order will circle like:
+     * 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ...
+     */
+    enableSortingRemoval?: boolean;
+    /**
+     * This function is used to retrieve the sorted row model. If using server-side
+     * sorting, this function is not required. To use client-side sorting, pass the
+     * exported `getSortedRowModel()` from your adapter to your table or implement
+     * your own.
+     */
+    getSortedRowModel?: (
+    /** @inheritDoc */
+    table: TableInstance<any>) => () => RowModel<any>;
+    /**
+     * Pass a custom function that will be used to determine if a multi-sort event
+     * should be triggered. It is passed the event from the sort toggle handler and
+     * should return `true` if the event should trigger a multi-sort.
+     */
+    isMultiSortEvent?: (e: unknown) => boolean;
+    /**
+     * Enables manual sorting for the table. If this is `true`, you will be expected
+     * to sort your data before it is passed to the table. This is useful if you are
+     * doing server-side sorting.
+     */
+    manualSorting?: boolean;
+    /**
+     * Set a maximum number of columns that can be multi-sorted.
+     */
+    maxMultiSortColCount?: number;
+    /**
+     * If provided, this function will be called with an `updaterFn` when
+     * `state.sorting` changes. This overrides the default internal state management,
+     * so you will need to persist the state change either fully or partially outside
+     * of the table.
+     */
+    onSortingChange?: OnChangeFn<SortingState>;
+    /**
+     * If `true`, all sorts will default to descending as their first toggle state.
+     */
+    sortDescFirst?: boolean;
+}
+type ResolvedSortingFns = keyof SortingFns extends never ? {
+    sortingFns?: Record<string, SortingFn<any>>;
+} : {
+    sortingFns: Record<keyof SortingFns, SortingFn<any>>;
+};
+export interface SortingOptions<_TData extends RowData> extends SortingOptionsBase, ResolvedSortingFns {
+}
+export interface SortingInstance<TData extends RowData> {
+    /** @internal */
+    _getSortedRowModel?: () => RowModel<TData>;
+    /**
+     * Returns the row model for the table before any sorting has been applied.
+     */
+    getPreSortedRowModel: () => RowModel<TData>;
+    /**
+     * Returns the row model for the table after sorting has been applied.
+     */
+    getSortedRowModel: () => RowModel<TData>;
+    /**
+     * Resets the `sorting` state to `initialState.sorting`, or `true` can be passed
+     * to force a default blank state reset to `[]`.
+     */
+    resetSorting: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.sorting` state.
+     */
+    setSorting: (updater: Updater<SortingState>) => void;
+}
+export declare const Sorting: TableFeature;
+export {};
+//# sourceMappingURL=sorting.d.ts.map

package/dist/table/features/sorting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.d.ts","sourceRoot":"","sources":["../../../src/table/features/sorting.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,IAAI,CAAA;AAChC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,EACL,KAAK,gBAAgB,EAGtB,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAEV,UAAU,EACV,GAAG,EACH,OAAO,EACP,UAAU,EACV,aAAa,EACb,OAAO,EACR,MAAM,UAAU,CAAA;AAGjB,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,CAAA;AAE1C,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,EAAE,CAAA;AAEvC,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,YAAY,CAAA;CACtB;AAED,MAAM,WAAW,SAAS,CAAC,KAAK,SAAS,OAAO;IAC9C,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;CAC/D;AAED,MAAM,MAAM,gBAAgB,CAAC,KAAK,SAAS,OAAO,IAAI,MAAM,CAC1D,MAAM,EACN,SAAS,CAAC,KAAK,CAAC,CACjB,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,OAAO,IAC7C,MAAM,GACN,gBAAgB,GAChB,SAAS,CAAC,KAAK,CAAC,CAAA;AAEpB,MAAM,WAAW,gBAAgB,CAAC,KAAK,SAAS,OAAO;IACrD;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAElC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,aAAa,CAAC,KAAK,SAAS,OAAO;IAClD;;OAEG;IACH,YAAY,EAAE,MAAM,IAAI,CAAA;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,aAAa,CAAA;IACnC;;OAEG;IACH,gBAAgB,EAAE,MAAM,SAAS,CAAC,KAAK,CAAC,CAAA;IACxC;;OAEG;IACH,eAAe,EAAE,MAAM,OAAO,CAAA;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,OAAO,CAAA;IACzB;;OAEG;IACH,eAAe,EAAE,MAAM,aAAa,CAAA;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,KAAK,GAAG,aAAa,CAAA;IACxC;;OAEG;IACH,mBAAmB,EAAE,MAAM,aAAa,GAAG,KAAK,CAAA;IAChD;;OAEG;IACH,YAAY,EAAE,MAAM,MAAM,CAAA;IAC1B;;OAEG;IACH,YAAY,EAAE,MAAM,SAAS,CAAC,KAAK,CAAC,CAAA;IACpC;;;OAGG;IACH,uBAAuB,EAAE,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,CAAA;IACrE;;;;OAIG;IACH,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;CAC3D;AAED,UAAU,kBAAkB;IAC1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE;IAClB,kBAAkB;IAClB,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,KACtB,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;IACxB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;IAC1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IAC1C;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,KAAK,kBAAkB,GAAG,MAAM,UAAU,SAAS,KAAK,GACpD;IACE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;CAC5C,GACD;IACE,UAAU,EAAE,MAAM,CAAC,MAAM,UAAU,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;CACrD,CAAA;AAEL,MAAM,WAAW,cAAc,CAAC,MAAM,SAAS,OAAO,CACpD,SAAQ,kBAAkB,EACxB,kBAAkB;CAAG;AAEzB,MAAM,WAAW,eAAe,CAAC,KAAK,SAAS,OAAO;IACpD,gBAAgB;IAChB,kBAAkB,CAAC,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC1C;;OAEG;IACH,oBAAoB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC3C;;OAEG;IACH,iBAAiB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IACxC;;;OAGG;IACH,YAAY,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,IAAI,CAAA;CACrD;AAED,eAAO,MAAM,OAAO,EAAE,YAsQrB,CAAA"}