@tanstack/table-core 9.0.0-alpha.10 → 9.0.0-alpha.11

package/dist/esm/features/row-pagination/rowPaginationFeature.types.d.ts

@@ -0,0 +1,119 @@
+import { RowModel } from '../../core/row-models/coreRowModelsFeature.types';
+import { Table } from '../../types/Table.js';
+import { OnChangeFn, RowData, Updater } from '../../types/type-utils.js';
+import { TableFeatures } from '../../types/TableFeatures.js';
+export interface PaginationState {
+    pageIndex: number;
+    pageSize: number;
+}
+export interface TableState_RowPagination {
+    pagination: PaginationState;
+}
+export interface TableOptions_RowPagination {
+    /**
+     * If set to `true`, pagination will be reset to the first page when page-altering state changes eg. `data` is updated, filters change, grouping changes, etc.
+     */
+    autoResetPageIndex?: boolean;
+    /**
+     * Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginatedRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.
+     */
+    manualPagination?: boolean;
+    /**
+     * If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.pagination` option.
+     */
+    onPaginationChange?: OnChangeFn<PaginationState>;
+    /**
+     * When manually controlling pagination, you can supply a total `pageCount` value to the table if you know it (Or supply a `rowCount` and `pageCount` will be calculated). If you do not know how many pages there are, you can set this to `-1`.
+     */
+    pageCount?: number;
+    /**
+     * When manually controlling pagination, you can supply a total `rowCount` value to the table if you know it. The `pageCount` can be calculated from this value and the `pageSize`.
+     */
+    rowCount?: number;
+}
+export interface PaginationDefaultOptions {
+    onPaginationChange: OnChangeFn<PaginationState>;
+}
+export interface Table_RowPagination<TFeatures extends TableFeatures, TData extends RowData> {
+    _autoResetPageIndex: () => void;
+    /**
+     * Returns whether the table can go to the next page.
+     */
+    getCanNextPage: () => boolean;
+    /**
+     * Returns whether the table can go to the previous page.
+     */
+    getCanPreviousPage: () => boolean;
+    /**
+     * Returns the page count. If manually paginating or controlling the pagination state, this will come directly from the `options.pageCount` table option, otherwise it will be calculated from the table data using the total row count and current page size.
+     */
+    getPageCount: () => number;
+    /**
+     * Returns the row count. If manually paginating or controlling the pagination state, this will come directly from the `options.rowCount` table option, otherwise it will be calculated from the table data.
+     */
+    getRowCount: () => number;
+    /**
+     * Returns an array of page options (zero-index-based) for the current page size.
+     */
+    getPageOptions: () => Array<number>;
+    /**
+     * Increments the page index by one, if possible.
+     */
+    nextPage: () => void;
+    /**
+     * Decrements the page index by one, if possible.
+     */
+    previousPage: () => void;
+    /**
+     * Sets the page index to `0`.
+     */
+    firstPage: () => void;
+    /**
+     * Sets the page index to the last page.
+     */
+    lastPage: () => void;
+    /**
+     * Resets the page index to its initial state. If `defaultState` is `true`, the page index will be reset to `0` regardless of initial state.
+     */
+    resetPageIndex: (defaultState?: boolean) => void;
+    /**
+     * Resets the page size to its initial state. If `defaultState` is `true`, the page size will be reset to `10` regardless of initial state.
+     */
+    resetPageSize: (defaultState?: boolean) => void;
+    /**
+     * Resets the **pagination** state to `initialState.pagination`, or `true` can be passed to force a default blank state reset to `[]`.
+     */
+    resetPagination: (defaultState?: boolean) => void;
+    /**
+     * Updates the page index using the provided function or value in the `state.pagination.pageIndex` state.
+     */
+    setPageIndex: (updater: Updater<number>) => void;
+    /**
+     * Updates the page size using the provided function or value in the `state.pagination.pageSize` state.
+     */
+    setPageSize: (updater: Updater<number>) => void;
+    /**
+     * Sets or updates the `state.pagination` state.
+     */
+    setPagination: (updater: Updater<PaginationState>) => void;
+}
+export interface Table_RowModels_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+    /**
+     * Returns the row model for the table after pagination has been applied.
+     */
+    getPaginatedRowModel: () => RowModel<TFeatures, TData>;
+    /**
+     * Returns the row model for the table before any pagination has been applied.
+     */
+    getPrePaginatedRowModel: () => RowModel<TFeatures, TData>;
+}
+export interface CreateRowModel_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+    /**
+     * Returns the row model after pagination has taken place, but no further.
+     * Pagination columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here.
+     */
+    paginatedRowModel?: (table: Table<TFeatures, TData>) => () => RowModel<TFeatures, TData>;
+}
+export interface CachedRowModel_Paginated<TFeatures extends TableFeatures, TData extends RowData> {
+    paginatedRowModel: () => RowModel<TFeatures, TData>;
+}

package/dist/esm/features/row-pagination/rowPaginationFeature.utils.d.ts

@@ -0,0 +1,21 @@
+import { RowData, Updater } from '../../types/type-utils.js';
+import { TableFeatures } from '../../types/TableFeatures.js';
+import { Table_Internal } from '../../types/Table.js';
+import { PaginationState } from './rowPaginationFeature.types';
+export declare function getDefaultPaginationState(): PaginationState;
+export declare function table_autoResetPageIndex<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+export declare function table_setPagination<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<PaginationState>): void | undefined;
+export declare function table_resetPagination<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+export declare function table_setPageIndex<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<number>): void;
+export declare function table_resetPageIndex<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+export declare function table_resetPageSize<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+export declare function table_setPageSize<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<number>): void;
+export declare function table_getPageOptions<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): number[];
+export declare function table_getCanPreviousPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+export declare function table_getCanNextPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+export declare function table_previousPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+export declare function table_nextPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+export declare function table_firstPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+export declare function table_lastPage<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+export declare function table_getPageCount<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): number;
+export declare function table_getRowCount<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): number;

package/dist/esm/features/row-pagination/rowPaginationFeature.utils.js

@@ -0,0 +1,126 @@
+import { functionalUpdate } from "../../utils.js";
+const defaultPageIndex = 0;
+const defaultPageSize = 10;
+function getDefaultPaginationState() {
+  return structuredClone({
+    pageIndex: defaultPageIndex,
+    pageSize: defaultPageSize
+  });
+}
+function table_autoResetPageIndex(table) {
+  if (table.options.autoResetAll ?? table.options.autoResetPageIndex ?? !table.options.manualPagination) {
+    table_resetPageIndex(table);
+  }
+}
+function table_setPagination(table, updater) {
+  const safeUpdater = (old) => {
+    const newState = functionalUpdate(updater, old);
+    return newState;
+  };
+  return table.options.onPaginationChange?.(safeUpdater);
+}
+function table_resetPagination(table, defaultState) {
+  table_setPagination(
+    table,
+    defaultState ? getDefaultPaginationState() : table.initialState.pagination ?? getDefaultPaginationState()
+  );
+}
+function table_setPageIndex(table, updater) {
+  table_setPagination(table, (old) => {
+    let pageIndex = functionalUpdate(updater, old.pageIndex);
+    const maxPageIndex = typeof table.options.pageCount === "undefined" || table.options.pageCount === -1 ? Number.MAX_SAFE_INTEGER : table.options.pageCount - 1;
+    pageIndex = Math.max(0, Math.min(pageIndex, maxPageIndex));
+    return {
+      ...old,
+      pageIndex
+    };
+  });
+}
+function table_resetPageIndex(table, defaultState) {
+  table_setPageIndex(
+    table,
+    defaultState ? defaultPageIndex : table.initialState.pagination?.pageIndex ?? defaultPageIndex
+  );
+}
+function table_resetPageSize(table, defaultState) {
+  table_setPageSize(
+    table,
+    defaultState ? defaultPageSize : table.initialState.pagination?.pageSize ?? defaultPageSize
+  );
+}
+function table_setPageSize(table, updater) {
+  table_setPagination(table, (old) => {
+    const pageSize = Math.max(1, functionalUpdate(updater, old.pageSize));
+    const topRowIndex = old.pageSize * old.pageIndex;
+    const pageIndex = Math.floor(topRowIndex / pageSize);
+    return {
+      ...old,
+      pageIndex,
+      pageSize
+    };
+  });
+}
+function table_getPageOptions(table) {
+  const pageCount = table_getPageCount(table);
+  let pageOptions = [];
+  if (pageCount && pageCount > 0) {
+    pageOptions = [...new Array(pageCount)].fill(null).map((_, i) => i);
+  }
+  return pageOptions;
+}
+function table_getCanPreviousPage(table) {
+  return (table.store.state.pagination?.pageIndex ?? 0) > 0;
+}
+function table_getCanNextPage(table) {
+  const pageIndex = table.store.state.pagination?.pageIndex ?? defaultPageIndex;
+  const pageCount = table_getPageCount(table);
+  if (pageCount === -1) {
+    return true;
+  }
+  if (pageCount === 0) {
+    return false;
+  }
+  return pageIndex < pageCount - 1;
+}
+function table_previousPage(table) {
+  return table_setPageIndex(table, (old) => old - 1);
+}
+function table_nextPage(table) {
+  return table_setPageIndex(table, (old) => {
+    return old + 1;
+  });
+}
+function table_firstPage(table) {
+  return table_setPageIndex(table, 0);
+}
+function table_lastPage(table) {
+  return table_setPageIndex(table, table_getPageCount(table) - 1);
+}
+function table_getPageCount(table) {
+  return table.options.pageCount ?? Math.ceil(
+    table_getRowCount(table) / (table.store.state.pagination?.pageSize ?? defaultPageSize)
+  );
+}
+function table_getRowCount(table) {
+  return table.options.rowCount ?? table.getPrePaginatedRowModel().rows.length;
+}
+export {
+  getDefaultPaginationState,
+  table_autoResetPageIndex,
+  table_firstPage,
+  table_getCanNextPage,
+  table_getCanPreviousPage,
+  table_getPageCount,
+  table_getPageOptions,
+  table_getRowCount,
+  table_lastPage,
+  table_nextPage,
+  table_previousPage,
+  table_resetPageIndex,
+  table_resetPageSize,
+  table_resetPagination,
+  table_setPageIndex,
+  table_setPageSize,
+  table_setPagination
+};
+//# sourceMappingURL=rowPaginationFeature.utils.js.map

package/dist/esm/features/row-pagination/rowPaginationFeature.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rowPaginationFeature.utils.js","sources":["../../../../src/features/row-pagination/rowPaginationFeature.utils.ts"],"sourcesContent":["import { functionalUpdate } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { PaginationState } from './rowPaginationFeature.types'\n\nconst defaultPageIndex = 0\nconst defaultPageSize = 10\n\nexport function getDefaultPaginationState(): PaginationState {\n  return structuredClone({\n    pageIndex: defaultPageIndex,\n    pageSize: defaultPageSize,\n  })\n}\n\nexport function table_autoResetPageIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  if (\n    table.options.autoResetAll ??\n    table.options.autoResetPageIndex ??\n    !table.options.manualPagination\n  ) {\n    table_resetPageIndex(table)\n  }\n}\n\nexport function table_setPagination<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<PaginationState>) {\n  const safeUpdater: Updater<PaginationState> = (old) => {\n    const newState = functionalUpdate(updater, old)\n\n    return newState\n  }\n\n  return table.options.onPaginationChange?.(safeUpdater)\n}\n\nexport function table_resetPagination<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setPagination(\n    table,\n    defaultState\n      ? getDefaultPaginationState()\n      : (table.initialState.pagination ?? getDefaultPaginationState()),\n  )\n}\n\nexport function table_setPageIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<number>) {\n  table_setPagination(table, (old) => {\n    let pageIndex = functionalUpdate(updater, old.pageIndex)\n\n    const maxPageIndex =\n      typeof table.options.pageCount === 'undefined' ||\n      table.options.pageCount === -1\n        ? Number.MAX_SAFE_INTEGER\n        : table.options.pageCount - 1\n\n    pageIndex = Math.max(0, Math.min(pageIndex, maxPageIndex))\n\n    return {\n      ...old,\n      pageIndex,\n    }\n  })\n}\n\nexport function table_resetPageIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setPageIndex(\n    table,\n    defaultState\n      ? defaultPageIndex\n      : (table.initialState.pagination?.pageIndex ?? defaultPageIndex),\n  )\n}\n\nexport function table_resetPageSize<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setPageSize(\n    table,\n    defaultState\n      ? defaultPageSize\n      : (table.initialState.pagination?.pageSize ?? defaultPageSize),\n  )\n}\n\nexport function table_setPageSize<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: Updater<number>) {\n  table_setPagination(table, (old) => {\n    const pageSize = Math.max(1, functionalUpdate(updater, old.pageSize))\n    const topRowIndex = old.pageSize * old.pageIndex\n    const pageIndex = Math.floor(topRowIndex / pageSize)\n\n    return {\n      ...old,\n      pageIndex,\n      pageSize,\n    }\n  })\n}\n\nexport function table_getPageOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const pageCount = table_getPageCount(table)\n  let pageOptions: Array<number> = []\n  if (pageCount && pageCount > 0) {\n    pageOptions = [...new Array(pageCount)].fill(null).map((_, i) => i)\n  }\n  return pageOptions\n}\n\nexport function table_getCanPreviousPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (table.store.state.pagination?.pageIndex ?? 0) > 0\n}\n\nexport function table_getCanNextPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  const pageIndex = table.store.state.pagination?.pageIndex ?? defaultPageIndex\n\n  const pageCount = table_getPageCount(table)\n\n  if (pageCount === -1) {\n    return true\n  }\n\n  if (pageCount === 0) {\n    return false\n  }\n\n  return pageIndex < pageCount - 1\n}\n\nexport function table_previousPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table_setPageIndex(table, (old) => old - 1)\n}\n\nexport function table_nextPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table_setPageIndex(table, (old) => {\n    return old + 1\n  })\n}\n\nexport function table_firstPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table_setPageIndex(table, 0)\n}\n\nexport function table_lastPage<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table_setPageIndex(table, table_getPageCount(table) - 1)\n}\n\nexport function table_getPageCount<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (\n    table.options.pageCount ??\n    Math.ceil(\n      table_getRowCount(table) /\n        (table.store.state.pagination?.pageSize ?? defaultPageSize),\n    )\n  )\n}\n\nexport function table_getRowCount<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table.options.rowCount ?? table.getPrePaginatedRowModel().rows.length\n}\n"],"names":[],"mappings":";AAMA,MAAM,mBAAmB;AACzB,MAAM,kBAAkB;AAEjB,SAAS,4BAA6C;AAC3D,SAAO,gBAAgB;AAAA,IACrB,WAAW;AAAA,IACX,UAAU;AAAA,EAAA,CACX;AACH;AAEO,SAAS,yBAGd,OAAyC;AACzC,MACE,MAAM,QAAQ,gBACd,MAAM,QAAQ,sBACd,CAAC,MAAM,QAAQ,kBACf;AACA,yBAAqB,KAAK;AAAA,EAC5B;AACF;AAEO,SAAS,oBAGd,OAAyC,SAAmC;AAC5E,QAAM,cAAwC,CAAC,QAAQ;AACrD,UAAM,WAAW,iBAAiB,SAAS,GAAG;AAE9C,WAAO;AAAA,EACT;AAEA,SAAO,MAAM,QAAQ,qBAAqB,WAAW;AACvD;AAEO,SAAS,sBAGd,OAAyC,cAAwB;AACjE;AAAA,IACE;AAAA,IACA,eACI,0BAAA,IACC,MAAM,aAAa,cAAc,0BAAA;AAAA,EAA0B;AAEpE;AAEO,SAAS,mBAGd,OAAyC,SAA0B;AACnE,sBAAoB,OAAO,CAAC,QAAQ;AAClC,QAAI,YAAY,iBAAiB,SAAS,IAAI,SAAS;AAEvD,UAAM,eACJ,OAAO,MAAM,QAAQ,cAAc,eACnC,MAAM,QAAQ,cAAc,KACxB,OAAO,mBACP,MAAM,QAAQ,YAAY;AAEhC,gBAAY,KAAK,IAAI,GAAG,KAAK,IAAI,WAAW,YAAY,CAAC;AAEzD,WAAO;AAAA,MACL,GAAG;AAAA,MACH;AAAA,IAAA;AAAA,EAEJ,CAAC;AACH;AAEO,SAAS,qBAGd,OAAyC,cAAwB;AACjE;AAAA,IACE;AAAA,IACA,eACI,mBACC,MAAM,aAAa,YAAY,aAAa;AAAA,EAAA;AAErD;AAEO,SAAS,oBAGd,OAAyC,cAAwB;AACjE;AAAA,IACE;AAAA,IACA,eACI,kBACC,MAAM,aAAa,YAAY,YAAY;AAAA,EAAA;AAEpD;AAEO,SAAS,kBAGd,OAAyC,SAA0B;AACnE,sBAAoB,OAAO,CAAC,QAAQ;AAClC,UAAM,WAAW,KAAK,IAAI,GAAG,iBAAiB,SAAS,IAAI,QAAQ,CAAC;AACpE,UAAM,cAAc,IAAI,WAAW,IAAI;AACvC,UAAM,YAAY,KAAK,MAAM,cAAc,QAAQ;AAEnD,WAAO;AAAA,MACL,GAAG;AAAA,MACH;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ,CAAC;AACH;AAEO,SAAS,qBAGd,OAAyC;AACzC,QAAM,YAAY,mBAAmB,KAAK;AAC1C,MAAI,cAA6B,CAAA;AACjC,MAAI,aAAa,YAAY,GAAG;AAC9B,kBAAc,CAAC,GAAG,IAAI,MAAM,SAAS,CAAC,EAAE,KAAK,IAAI,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC;AAAA,EACpE;AACA,SAAO;AACT;AAEO,SAAS,yBAGd,OAAyC;AACzC,UAAQ,MAAM,MAAM,MAAM,YAAY,aAAa,KAAK;AAC1D;AAEO,SAAS,qBAGd,OAAyC;AACzC,QAAM,YAAY,MAAM,MAAM,MAAM,YAAY,aAAa;AAE7D,QAAM,YAAY,mBAAmB,KAAK;AAE1C,MAAI,cAAc,IAAI;AACpB,WAAO;AAAA,EACT;AAEA,MAAI,cAAc,GAAG;AACnB,WAAO;AAAA,EACT;AAEA,SAAO,YAAY,YAAY;AACjC;AAEO,SAAS,mBAGd,OAAyC;AACzC,SAAO,mBAAmB,OAAO,CAAC,QAAQ,MAAM,CAAC;AACnD;AAEO,SAAS,eAGd,OAAyC;AACzC,SAAO,mBAAmB,OAAO,CAAC,QAAQ;AACxC,WAAO,MAAM;AAAA,EACf,CAAC;AACH;AAEO,SAAS,gBAGd,OAAyC;AACzC,SAAO,mBAAmB,OAAO,CAAC;AACpC;AAEO,SAAS,eAGd,OAAyC;AACzC,SAAO,mBAAmB,OAAO,mBAAmB,KAAK,IAAI,CAAC;AAChE;AAEO,SAAS,mBAGd,OAAyC;AACzC,SACE,MAAM,QAAQ,aACd,KAAK;AAAA,IACH,kBAAkB,KAAK,KACpB,MAAM,MAAM,MAAM,YAAY,YAAY;AAAA,EAAA;AAGnD;AAEO,SAAS,kBAGd,OAAyC;AACzC,SAAO,MAAM,QAAQ,YAAY,MAAM,wBAAA,EAA0B,KAAK;AACxE;"}

package/dist/esm/features/row-pinning/rowPinningFeature.d.ts

@@ -0,0 +1,10 @@
+import { RowData } from '../../types/type-utils.js';
+import { TableFeature, TableFeatures } from '../../types/TableFeatures.js';
+interface RowPinningFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {
+}
+export declare function constructRowPinningFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<RowPinningFeatureConstructors<TFeatures, TData>>;
+/**
+ * The Row Pinning feature adds row pinning state and APIs to the table and row objects.
+ */
+export declare const rowPinningFeature: TableFeature<RowPinningFeatureConstructors<TableFeatures, RowData>>;
+export {};

package/dist/esm/features/row-pinning/rowPinningFeature.js

@@ -0,0 +1,80 @@
+import { assignTableAPIs, assignPrototypeAPIs, makeStateUpdater } from "../../utils.js";
+import { table_getCenterRows, table_getBottomRows, table_getTopRows, table_getIsSomeRowsPinned, table_resetRowPinning, table_setRowPinning, row_pin, row_getPinnedIndex, row_getIsPinned, row_getCanPin, getDefaultRowPinningState } from "./rowPinningFeature.utils.js";
+function constructRowPinningFeature() {
+  return {
+    getInitialState: (initialState) => {
+      return {
+        ...initialState,
+        rowPinning: {
+          ...getDefaultRowPinningState(),
+          ...initialState.rowPinning
+        }
+      };
+    },
+    getDefaultTableOptions: (table) => {
+      return {
+        onRowPinningChange: makeStateUpdater("rowPinning", table)
+      };
+    },
+    assignRowPrototype: (prototype, table) => {
+      assignPrototypeAPIs("rowPinningFeature", prototype, table, {
+        row_getCanPin: {
+          fn: (row) => row_getCanPin(row)
+        },
+        row_getIsPinned: {
+          fn: (row) => row_getIsPinned(row)
+        },
+        row_getPinnedIndex: {
+          fn: (row) => row_getPinnedIndex(row),
+          memoDeps: (row) => [
+            row.table.getRowModel().rows,
+            row.table.store.state.rowPinning
+          ]
+        },
+        row_pin: {
+          fn: (row, position, includeLeafRows, includeParentRows) => row_pin(row, position, includeLeafRows, includeParentRows)
+        }
+      });
+    },
+    constructTableAPIs: (table) => {
+      assignTableAPIs("rowPinningFeature", table, {
+        table_setRowPinning: {
+          fn: (updater) => table_setRowPinning(table, updater)
+        },
+        table_resetRowPinning: {
+          fn: (defaultState) => table_resetRowPinning(table, defaultState)
+        },
+        table_getIsSomeRowsPinned: {
+          fn: (position) => table_getIsSomeRowsPinned(table, position)
+        },
+        table_getTopRows: {
+          fn: () => table_getTopRows(table),
+          memoDeps: () => [
+            table.getRowModel().rows,
+            table.store.state.rowPinning?.top
+          ]
+        },
+        table_getBottomRows: {
+          fn: () => table_getBottomRows(table),
+          memoDeps: () => [
+            table.getRowModel().rows,
+            table.store.state.rowPinning?.bottom
+          ]
+        },
+        table_getCenterRows: {
+          fn: () => table_getCenterRows(table),
+          memoDeps: () => [
+            table.getRowModel().rows,
+            table.store.state.rowPinning
+          ]
+        }
+      });
+    }
+  };
+}
+const rowPinningFeature = constructRowPinningFeature();
+export {
+  constructRowPinningFeature,
+  rowPinningFeature
+};
+//# sourceMappingURL=rowPinningFeature.js.map

package/dist/esm/features/row-pinning/rowPinningFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rowPinningFeature.js","sources":["../../../../src/features/row-pinning/rowPinningFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  getDefaultRowPinningState,\n  row_getCanPin,\n  row_getIsPinned,\n  row_getPinnedIndex,\n  row_pin,\n  table_getBottomRows,\n  table_getCenterRows,\n  table_getIsSomeRowsPinned,\n  table_getTopRows,\n  table_resetRowPinning,\n  table_setRowPinning,\n} from './rowPinningFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Row_RowPinning,\n//   TableOptions_RowPinning,\n//   TableState_RowPinning,\n//   Table_RowPinning,\n// } from './rowPinningFeature.types'\n\ninterface RowPinningFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Row: Row_RowPinning\n  // Table: Table_RowPinning<TFeatures, RowData>\n  // TableOptions: TableOptions_RowPinning<TFeatures, RowData>\n  // TableState: TableState_RowPinning\n}\n\nexport function constructRowPinningFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<RowPinningFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        ...initialState,\n        rowPinning: {\n          ...getDefaultRowPinningState(),\n          ...initialState.rowPinning,\n        },\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onRowPinningChange: makeStateUpdater('rowPinning', table),\n      }\n    },\n\n    assignRowPrototype: (prototype, table) => {\n      assignPrototypeAPIs('rowPinningFeature', prototype, table, {\n        row_getCanPin: {\n          fn: (row) => row_getCanPin(row),\n        },\n        row_getIsPinned: {\n          fn: (row) => row_getIsPinned(row),\n        },\n        row_getPinnedIndex: {\n          fn: (row) => row_getPinnedIndex(row),\n          memoDeps: (row) => [\n            row.table.getRowModel().rows,\n            row.table.store.state.rowPinning,\n          ],\n        },\n        row_pin: {\n          fn: (row, position, includeLeafRows, includeParentRows) =>\n            row_pin(row, position, includeLeafRows, includeParentRows),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('rowPinningFeature', table, {\n        table_setRowPinning: {\n          fn: (updater) => table_setRowPinning(table, updater),\n        },\n        table_resetRowPinning: {\n          fn: (defaultState) => table_resetRowPinning(table, defaultState),\n        },\n        table_getIsSomeRowsPinned: {\n          fn: (position) => table_getIsSomeRowsPinned(table, position),\n        },\n        table_getTopRows: {\n          fn: () => table_getTopRows(table),\n          memoDeps: () => [\n            table.getRowModel().rows,\n            table.store.state.rowPinning?.top,\n          ],\n        },\n        table_getBottomRows: {\n          fn: () => table_getBottomRows(table),\n          memoDeps: () => [\n            table.getRowModel().rows,\n            table.store.state.rowPinning?.bottom,\n          ],\n        },\n        table_getCenterRows: {\n          fn: () => table_getCenterRows(table),\n          memoDeps: () => [\n            table.getRowModel().rows,\n            table.store.state.rowPinning,\n          ],\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Row Pinning feature adds row pinning state and APIs to the table and row objects.\n */\nexport const rowPinningFeature = constructRowPinningFeature()\n"],"names":[],"mappings":";;AAqCO,SAAS,6BAGmD;AACjE,SAAO;AAAA,IACL,iBAAiB,CAAC,iBAAiB;AACjC,aAAO;AAAA,QACL,GAAG;AAAA,QACH,YAAY;AAAA,UACV,GAAG,0BAAA;AAAA,UACH,GAAG,aAAa;AAAA,QAAA;AAAA,MAClB;AAAA,IAEJ;AAAA,IAEA,wBAAwB,CAAC,UAAU;AACjC,aAAO;AAAA,QACL,oBAAoB,iBAAiB,cAAc,KAAK;AAAA,MAAA;AAAA,IAE5D;AAAA,IAEA,oBAAoB,CAAC,WAAW,UAAU;AACxC,0BAAoB,qBAAqB,WAAW,OAAO;AAAA,QACzD,eAAe;AAAA,UACb,IAAI,CAAC,QAAQ,cAAc,GAAG;AAAA,QAAA;AAAA,QAEhC,iBAAiB;AAAA,UACf,IAAI,CAAC,QAAQ,gBAAgB,GAAG;AAAA,QAAA;AAAA,QAElC,oBAAoB;AAAA,UAClB,IAAI,CAAC,QAAQ,mBAAmB,GAAG;AAAA,UACnC,UAAU,CAAC,QAAQ;AAAA,YACjB,IAAI,MAAM,YAAA,EAAc;AAAA,YACxB,IAAI,MAAM,MAAM,MAAM;AAAA,UAAA;AAAA,QACxB;AAAA,QAEF,SAAS;AAAA,UACP,IAAI,CAAC,KAAK,UAAU,iBAAiB,sBACnC,QAAQ,KAAK,UAAU,iBAAiB,iBAAiB;AAAA,QAAA;AAAA,MAC7D,CACD;AAAA,IACH;AAAA,IAEA,oBAAoB,CAAC,UAAU;AAC7B,sBAAgB,qBAAqB,OAAO;AAAA,QAC1C,qBAAqB;AAAA,UACnB,IAAI,CAAC,YAAY,oBAAoB,OAAO,OAAO;AAAA,QAAA;AAAA,QAErD,uBAAuB;AAAA,UACrB,IAAI,CAAC,iBAAiB,sBAAsB,OAAO,YAAY;AAAA,QAAA;AAAA,QAEjE,2BAA2B;AAAA,UACzB,IAAI,CAAC,aAAa,0BAA0B,OAAO,QAAQ;AAAA,QAAA;AAAA,QAE7D,kBAAkB;AAAA,UAChB,IAAI,MAAM,iBAAiB,KAAK;AAAA,UAChC,UAAU,MAAM;AAAA,YACd,MAAM,cAAc;AAAA,YACpB,MAAM,MAAM,MAAM,YAAY;AAAA,UAAA;AAAA,QAChC;AAAA,QAEF,qBAAqB;AAAA,UACnB,IAAI,MAAM,oBAAoB,KAAK;AAAA,UACnC,UAAU,MAAM;AAAA,YACd,MAAM,cAAc;AAAA,YACpB,MAAM,MAAM,MAAM,YAAY;AAAA,UAAA;AAAA,QAChC;AAAA,QAEF,qBAAqB;AAAA,UACnB,IAAI,MAAM,oBAAoB,KAAK;AAAA,UACnC,UAAU,MAAM;AAAA,YACd,MAAM,cAAc;AAAA,YACpB,MAAM,MAAM,MAAM;AAAA,UAAA;AAAA,QACpB;AAAA,MACF,CACD;AAAA,IACH;AAAA,EAAA;AAEJ;AAKO,MAAM,oBAAoB,2BAAA;"}

package/dist/esm/features/row-pinning/rowPinningFeature.types.d.ts

@@ -0,0 +1,72 @@
+import { OnChangeFn, RowData, Updater } from '../../types/type-utils.js';
+import { TableFeatures } from '../../types/TableFeatures.js';
+import { Row } from '../../types/Row.js';
+export type RowPinningPosition = false | 'top' | 'bottom';
+export interface RowPinningState {
+    bottom: Array<string>;
+    top: Array<string>;
+}
+export interface TableState_RowPinning {
+    rowPinning: RowPinningState;
+}
+export interface TableOptions_RowPinning<TFeatures extends TableFeatures, TData extends RowData> {
+    /**
+     * Enables/disables row pinning for the table. Defaults to `true`.
+     */
+    enableRowPinning?: boolean | ((row: Row<TFeatures, TData>) => 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 RowPinningDefaultOptions {
+    onRowPinningChange: OnChangeFn<RowPinningState>;
+}
+export interface Row_RowPinning {
+    /**
+     * Returns whether or not the row can be pinned.
+     */
+    getCanPin: () => boolean;
+    /**
+     * Returns the pinned position of the row. (`'top'`, `'bottom'` or `false`)
+     */
+    getIsPinned: () => RowPinningPosition;
+    /**
+     * 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 Table_RowPinning<TFeatures extends TableFeatures, TData extends RowData> {
+    /**
+     * Returns all bottom pinned rows.
+     */
+    getBottomRows: () => Array<Row<TFeatures, TData>>;
+    /**
+     * Returns all rows that are not pinned to the top or bottom.
+     */
+    getCenterRows: () => Array<Row<TFeatures, TData>>;
+    /**
+     * Returns whether or not 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.
+     */
+    getTopRows: () => Array<Row<TFeatures, 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;
+}

package/dist/esm/features/row-pinning/rowPinningFeature.utils.d.ts

@@ -0,0 +1,16 @@
+import { RowData, Updater } from '../../types/type-utils.js';
+import { TableFeatures } from '../../types/TableFeatures.js';
+import { Table_Internal } from '../../types/Table.js';
+import { Row } from '../../types/Row.js';
+import { RowPinningPosition, RowPinningState } from './rowPinningFeature.types';
+export declare function getDefaultRowPinningState(): RowPinningState;
+export declare function table_setRowPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<RowPinningState>): void;
+export declare function table_resetRowPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+export declare function table_getIsSomeRowsPinned<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, position?: RowPinningPosition): boolean;
+export declare function table_getTopRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+export declare function table_getBottomRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+export declare function table_getCenterRows<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>>;
+export declare function row_getCanPin<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+export declare function row_getIsPinned<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): RowPinningPosition;
+export declare function row_getPinnedIndex<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): number;
+export declare function row_pin<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, position: RowPinningPosition, includeLeafRows?: boolean, includeParentRows?: boolean): void;

package/dist/esm/features/row-pinning/rowPinningFeature.utils.js

@@ -0,0 +1,115 @@
+import { row_getIsAllParentsExpanded } from "../row-expanding/rowExpandingFeature.utils.js";
+import { callMemoOrStaticFn } from "../../utils.js";
+function getDefaultRowPinningState() {
+  return structuredClone({
+    top: [],
+    bottom: []
+  });
+}
+function table_setRowPinning(table, updater) {
+  table.options.onRowPinningChange?.(updater);
+}
+function table_resetRowPinning(table, defaultState) {
+  table_setRowPinning(
+    table,
+    defaultState ? getDefaultRowPinningState() : table.initialState.rowPinning ?? getDefaultRowPinningState()
+  );
+}
+function table_getIsSomeRowsPinned(table, position) {
+  const rowPinning = table.store.state.rowPinning;
+  if (!position) {
+    return Boolean(rowPinning?.top.length || rowPinning?.bottom.length);
+  }
+  return Boolean(rowPinning?.[position].length);
+}
+function table_getPinnedRows(table, position) {
+  const visibleRows = table.getRowModel().rows;
+  const pinnedRowIds = table.store.state.rowPinning?.[position] ?? [];
+  const rows = table.options.keepPinnedRows ?? true ? (
+    // get all rows that are pinned even if they would not be otherwise visible
+    // account for expanded parent rows, but not pagination or filtering
+    pinnedRowIds.map((rowId) => {
+      const row = table.getRow(rowId, true);
+      return row_getIsAllParentsExpanded(row) ? row : null;
+    })
+  ) : (
+    // else get only visible rows that are pinned
+    pinnedRowIds.map(
+      (rowId) => visibleRows.find((row) => row.id === rowId)
+    )
+  );
+  const filteredRows = rows.filter((r) => !!r);
+  filteredRows.forEach((row) => {
+    row.position = position;
+  });
+  return filteredRows;
+}
+function table_getTopRows(table) {
+  return table_getPinnedRows(table, "top");
+}
+function table_getBottomRows(table) {
+  return table_getPinnedRows(table, "bottom");
+}
+function table_getCenterRows(table) {
+  const { top, bottom } = table.store.state.rowPinning ?? getDefaultRowPinningState();
+  const allRows = table.getRowModel().rows;
+  const topAndBottom = /* @__PURE__ */ new Set([...top, ...bottom]);
+  return allRows.filter((d) => !topAndBottom.has(d.id));
+}
+function row_getCanPin(row) {
+  const { enableRowPinning } = row.table.options;
+  if (typeof enableRowPinning === "function") {
+    return enableRowPinning(row);
+  }
+  return enableRowPinning ?? true;
+}
+function row_getIsPinned(row) {
+  const { top, bottom } = row.table.store.state.rowPinning ?? getDefaultRowPinningState();
+  return top.includes(row.id) ? "top" : bottom.includes(row.id) ? "bottom" : false;
+}
+function row_getPinnedIndex(row) {
+  const position = row_getIsPinned(row);
+  if (!position) return -1;
+  const visiblePinnedRowIds = (position === "top" ? callMemoOrStaticFn(row.table, "getTopRows", table_getTopRows) : callMemoOrStaticFn(row.table, "getBottomRows", table_getBottomRows)).map(({ id }) => id);
+  return visiblePinnedRowIds.indexOf(row.id);
+}
+function row_pin(row, position, includeLeafRows, includeParentRows) {
+  const leafRowIds = includeLeafRows ? row.getLeafRows().map(({ id }) => id) : [];
+  const parentRowIds = includeParentRows ? row.getParentRows().map(({ id }) => id) : [];
+  const rowIds = /* @__PURE__ */ new Set([...parentRowIds, row.id, ...leafRowIds]);
+  table_setRowPinning(row.table, (old) => {
+    if (position === "bottom") {
+      return {
+        top: old.top.filter((d) => !rowIds.has(d)),
+        bottom: [
+          ...old.bottom.filter((d) => !rowIds.has(d)),
+          ...Array.from(rowIds)
+        ]
+      };
+    }
+    if (position === "top") {
+      return {
+        top: [...old.top.filter((d) => !rowIds.has(d)), ...Array.from(rowIds)],
+        bottom: old.bottom.filter((d) => !rowIds.has(d))
+      };
+    }
+    return {
+      top: old.top.filter((d) => !rowIds.has(d)),
+      bottom: old.bottom.filter((d) => !rowIds.has(d))
+    };
+  });
+}
+export {
+  getDefaultRowPinningState,
+  row_getCanPin,
+  row_getIsPinned,
+  row_getPinnedIndex,
+  row_pin,
+  table_getBottomRows,
+  table_getCenterRows,
+  table_getIsSomeRowsPinned,
+  table_getTopRows,
+  table_resetRowPinning,
+  table_setRowPinning
+};
+//# sourceMappingURL=rowPinningFeature.utils.js.map

package/dist/esm/features/row-pinning/rowPinningFeature.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rowPinningFeature.utils.js","sources":["../../../../src/features/row-pinning/rowPinningFeature.utils.ts"],"sourcesContent":["import { row_getIsAllParentsExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { callMemoOrStaticFn } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type {\n  RowPinningPosition,\n  RowPinningState,\n} from './rowPinningFeature.types'\n\n// State Utils\n\nexport function getDefaultRowPinningState(): RowPinningState {\n  return structuredClone({\n    top: [],\n    bottom: [],\n  })\n}\n\nexport function table_setRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<RowPinningState>,\n): void {\n  table.options.onRowPinningChange?.(updater)\n}\n\nexport function table_resetRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void {\n  table_setRowPinning(\n    table,\n    defaultState\n      ? getDefaultRowPinningState()\n      : (table.initialState.rowPinning ?? getDefaultRowPinningState()),\n  )\n}\n\n// Table Utils\n\nexport function table_getIsSomeRowsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position?: RowPinningPosition,\n): boolean {\n  const rowPinning = table.store.state.rowPinning\n\n  if (!position) {\n    return Boolean(rowPinning?.top.length || rowPinning?.bottom.length)\n  }\n  return Boolean(rowPinning?.[position].length)\n}\n\nfunction table_getPinnedRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position: 'top' | 'bottom',\n): Array<Row<TFeatures, TData>> {\n  const visibleRows = table.getRowModel().rows\n  const pinnedRowIds = table.store.state.rowPinning?.[position] ?? []\n\n  const rows =\n    (table.options.keepPinnedRows ?? true)\n      ? // get all rows that are pinned even if they would not be otherwise visible\n        // account for expanded parent rows, but not pagination or filtering\n        pinnedRowIds.map((rowId) => {\n          const row = table.getRow(rowId, true)\n          return row_getIsAllParentsExpanded(row) ? row : null\n        })\n      : // else get only visible rows that are pinned\n        pinnedRowIds.map(\n          (rowId) => visibleRows.find((row) => row.id === rowId)!,\n        )\n\n  const filteredRows = rows.filter((r) => !!r)\n  // Assign position property directly to preserve prototype chain\n  filteredRows.forEach((row) => {\n    ;(row as any).position = position\n  })\n  return filteredRows\n}\n\nexport function table_getTopRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'top')\n}\n\nexport function table_getBottomRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'bottom')\n}\n\nexport function table_getCenterRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  const { top, bottom } =\n    table.store.state.rowPinning ?? getDefaultRowPinningState()\n  const allRows = table.getRowModel().rows\n\n  const topAndBottom = new Set([...top, ...bottom])\n  return allRows.filter((d) => !topAndBottom.has(d.id))\n}\n\n// Row Utils\n\nexport function row_getCanPin<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): boolean {\n  const { enableRowPinning } = row.table.options\n  if (typeof enableRowPinning === 'function') {\n    return enableRowPinning(row)\n  }\n  return enableRowPinning ?? true\n}\n\nexport function row_getIsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): RowPinningPosition {\n  const { top, bottom } =\n    row.table.store.state.rowPinning ?? getDefaultRowPinningState()\n\n  return top.includes(row.id)\n    ? 'top'\n    : bottom.includes(row.id)\n      ? 'bottom'\n      : false\n}\n\nexport function row_getPinnedIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): number {\n  const position = row_getIsPinned(row)\n  if (!position) return -1\n\n  const visiblePinnedRowIds = (\n    position === 'top'\n      ? callMemoOrStaticFn(row.table, 'getTopRows', table_getTopRows)\n      : callMemoOrStaticFn(row.table, 'getBottomRows', table_getBottomRows)\n  ).map(({ id }) => id)\n\n  return visiblePinnedRowIds.indexOf(row.id)\n}\n\nexport function row_pin<TFeatures extends TableFeatures, TData extends RowData>(\n  row: Row<TFeatures, TData>,\n  position: RowPinningPosition,\n  includeLeafRows?: boolean,\n  includeParentRows?: boolean,\n): void {\n  const leafRowIds = includeLeafRows\n    ? row.getLeafRows().map(({ id }) => id)\n    : []\n  const parentRowIds = includeParentRows\n    ? row.getParentRows().map(({ id }) => id)\n    : []\n  const rowIds: Set<string> = new Set([...parentRowIds, row.id, ...leafRowIds])\n\n  table_setRowPinning(row.table, (old) => {\n    if (position === 'bottom') {\n      return {\n        top: old.top.filter((d) => !rowIds.has(d)),\n        bottom: [\n          ...old.bottom.filter((d) => !rowIds.has(d)),\n          ...Array.from(rowIds),\n        ],\n      }\n    }\n\n    if (position === 'top') {\n      return {\n        top: [...old.top.filter((d) => !rowIds.has(d)), ...Array.from(rowIds)],\n        bottom: old.bottom.filter((d) => !rowIds.has(d)),\n      }\n    }\n\n    return {\n      top: old.top.filter((d) => !rowIds.has(d)),\n      bottom: old.bottom.filter((d) => !rowIds.has(d)),\n    }\n  })\n}\n"],"names":[],"mappings":";;AAaO,SAAS,4BAA6C;AAC3D,SAAO,gBAAgB;AAAA,IACrB,KAAK,CAAA;AAAA,IACL,QAAQ,CAAA;AAAA,EAAC,CACV;AACH;AAEO,SAAS,oBAId,OACA,SACM;AACN,QAAM,QAAQ,qBAAqB,OAAO;AAC5C;AAEO,SAAS,sBAGd,OAAyC,cAA8B;AACvE;AAAA,IACE;AAAA,IACA,eACI,0BAAA,IACC,MAAM,aAAa,cAAc,0BAAA;AAAA,EAA0B;AAEpE;AAIO,SAAS,0BAId,OACA,UACS;AACT,QAAM,aAAa,MAAM,MAAM,MAAM;AAErC,MAAI,CAAC,UAAU;AACb,WAAO,QAAQ,YAAY,IAAI,UAAU,YAAY,OAAO,MAAM;AAAA,EACpE;AACA,SAAO,QAAQ,aAAa,QAAQ,EAAE,MAAM;AAC9C;AAEA,SAAS,oBAIP,OACA,UAC8B;AAC9B,QAAM,cAAc,MAAM,YAAA,EAAc;AACxC,QAAM,eAAe,MAAM,MAAM,MAAM,aAAa,QAAQ,KAAK,CAAA;AAEjE,QAAM,OACH,MAAM,QAAQ,kBAAkB;AAAA;AAAA;AAAA,IAG7B,aAAa,IAAI,CAAC,UAAU;AAC1B,YAAM,MAAM,MAAM,OAAO,OAAO,IAAI;AACpC,aAAO,4BAA4B,GAAG,IAAI,MAAM;AAAA,IAClD,CAAC;AAAA;AAAA;AAAA,IAED,aAAa;AAAA,MACX,CAAC,UAAU,YAAY,KAAK,CAAC,QAAQ,IAAI,OAAO,KAAK;AAAA,IAAA;AAAA;AAG7D,QAAM,eAAe,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAE3C,eAAa,QAAQ,CAAC,QAAQ;AAC1B,QAAY,WAAW;AAAA,EAC3B,CAAC;AACD,SAAO;AACT;AAEO,SAAS,iBAGd,OAAuE;AACvE,SAAO,oBAAoB,OAAO,KAAK;AACzC;AAEO,SAAS,oBAGd,OAAuE;AACvE,SAAO,oBAAoB,OAAO,QAAQ;AAC5C;AAEO,SAAS,oBAGd,OAAuE;AACvE,QAAM,EAAE,KAAK,WACX,MAAM,MAAM,MAAM,cAAc,0BAAA;AAClC,QAAM,UAAU,MAAM,YAAA,EAAc;AAEpC,QAAM,mCAAmB,IAAI,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC;AAChD,SAAO,QAAQ,OAAO,CAAC,MAAM,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC;AACtD;AAIO,SAAS,cAGd,KAAqC;AACrC,QAAM,EAAE,iBAAA,IAAqB,IAAI,MAAM;AACvC,MAAI,OAAO,qBAAqB,YAAY;AAC1C,WAAO,iBAAiB,GAAG;AAAA,EAC7B;AACA,SAAO,oBAAoB;AAC7B;AAEO,SAAS,gBAGd,KAAgD;AAChD,QAAM,EAAE,KAAK,OAAA,IACX,IAAI,MAAM,MAAM,MAAM,cAAc,0BAAA;AAEtC,SAAO,IAAI,SAAS,IAAI,EAAE,IACtB,QACA,OAAO,SAAS,IAAI,EAAE,IACpB,WACA;AACR;AAEO,SAAS,mBAGd,KAAoC;AACpC,QAAM,WAAW,gBAAgB,GAAG;AACpC,MAAI,CAAC,SAAU,QAAO;AAEtB,QAAM,uBACJ,aAAa,QACT,mBAAmB,IAAI,OAAO,cAAc,gBAAgB,IAC5D,mBAAmB,IAAI,OAAO,iBAAiB,mBAAmB,GACtE,IAAI,CAAC,EAAE,GAAA,MAAS,EAAE;AAEpB,SAAO,oBAAoB,QAAQ,IAAI,EAAE;AAC3C;AAEO,SAAS,QACd,KACA,UACA,iBACA,mBACM;AACN,QAAM,aAAa,kBACf,IAAI,YAAA,EAAc,IAAI,CAAC,EAAE,GAAA,MAAS,EAAE,IACpC,CAAA;AACJ,QAAM,eAAe,oBACjB,IAAI,cAAA,EAAgB,IAAI,CAAC,EAAE,GAAA,MAAS,EAAE,IACtC,CAAA;AACJ,QAAM,SAAsB,oBAAI,IAAI,CAAC,GAAG,cAAc,IAAI,IAAI,GAAG,UAAU,CAAC;AAE5E,sBAAoB,IAAI,OAAO,CAAC,QAAQ;AACtC,QAAI,aAAa,UAAU;AACzB,aAAO;AAAA,QACL,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;AAAA,QACzC,QAAQ;AAAA,UACN,GAAG,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;AAAA,UAC1C,GAAG,MAAM,KAAK,MAAM;AAAA,QAAA;AAAA,MACtB;AAAA,IAEJ;AAEA,QAAI,aAAa,OAAO;AACtB,aAAO;AAAA,QACL,KAAK,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,GAAG,MAAM,KAAK,MAAM,CAAC;AAAA,QACrE,QAAQ,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;AAAA,MAAA;AAAA,IAEnD;AAEA,WAAO;AAAA,MACL,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;AAAA,MACzC,QAAQ,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;AAAA,IAAA;AAAA,EAEnD,CAAC;AACH;"}

package/dist/esm/features/row-selection/rowSelectionFeature.d.ts

@@ -0,0 +1,10 @@
+import { RowData } from '../../types/type-utils.js';
+import { TableFeature, TableFeatures } from '../../types/TableFeatures.js';
+interface RowSelectionFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {
+}
+export declare function constructRowSelectionFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<RowSelectionFeatureConstructors<TFeatures, TData>>;
+/**
+ * The Row Selection feature adds row selection state and APIs to the table and row objects.
+ */
+export declare const rowSelectionFeature: TableFeature<RowSelectionFeatureConstructors<TableFeatures, RowData>>;
+export {};