@tanstack/table-core 9.0.0-beta.52 → 9.0.0-beta.53

package/dist/features/row-selection/rowSelectionFeature.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rowSelectionFeature.js","names":[],"sources":["../../../src/features/row-selection/rowSelectionFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  getDefaultRowSelectionState,\n  row_getCanMultiSelect,\n  row_getCanSelect,\n  row_getCanSelectSubRows,\n  row_getIsAllSubRowsSelected,\n  row_getIsSelected,\n  row_getIsSomeSelected,\n  row_getToggleSelectedHandler,\n  row_toggleSelected,\n  table_getFilteredSelectedRowModel,\n  table_getGroupedSelectedRowModel,\n  table_getIsAllPageRowsSelected,\n  table_getIsAllRowsSelected,\n  table_getIsSomePageRowsSelected,\n  table_getIsSomeRowsSelected,\n  table_getPreSelectedRowModel,\n  table_getSelectedRowIds,\n  table_getSelectedRowModel,\n  table_getToggleAllPageRowsSelectedHandler,\n  table_getToggleAllRowsSelectedHandler,\n  table_resetRowSelection,\n  table_setRowSelection,\n  table_toggleAllPageRowsSelected,\n  table_toggleAllRowsSelected,\n} from './rowSelectionFeature.utils'\nimport type { TableFeature } from '../../types/TableFeatures'\n\n/**\n * Feature that adds row selection state and APIs for row and page selection.\n */\nexport const rowSelectionFeature: TableFeature = {\n  initTableInstanceData: (table) => {\n    // @ts-ignore - _lastSelectedRowId is row selection table instance data\n    table._lastSelectedRowId = null\n  },\n\n  resetTableInstanceData: (table) => {\n    // @ts-ignore - _lastSelectedRowId is row selection table instance data\n    table._lastSelectedRowId = null\n  },\n\n  getInitialState: (initialState) => {\n    return {\n      rowSelection: getDefaultRowSelectionState(),\n      ...initialState,\n    }\n  },\n\n  getDefaultTableOptions: (table) => {\n    return {\n      onRowSelectionChange: makeStateUpdater('rowSelection', table),\n      enableRowSelection: true,\n      enableMultiRowSelection: true,\n      enableRowRangeSelection: true,\n      enableSubRowSelection: true,\n      isRowRangeSelectionEvent: (event) => {\n        const rangeEvent = event as {\n          shiftKey?: boolean\n          nativeEvent?: { shiftKey?: boolean }\n        }\n        return Boolean(rangeEvent.shiftKey || rangeEvent.nativeEvent?.shiftKey)\n      },\n    }\n  },\n\n  assignRowPrototype: (prototype, table) => {\n    assignPrototypeAPIs('rowSelectionFeature', prototype, table, {\n      row_toggleSelected: {\n        fn: (row, value, opts) => row_toggleSelected(row, value, opts),\n      },\n      row_getIsSelected: {\n        fn: (row) => row_getIsSelected(row),\n      },\n      row_getIsSomeSelected: {\n        fn: (row) => row_getIsSomeSelected(row),\n        memoDeps: (row) => [\n          row.subRows,\n          row.table.atoms.rowSelection?.get(),\n          row.table.options.enableRowSelection,\n        ],\n      },\n      row_getIsAllSubRowsSelected: {\n        fn: (row) => row_getIsAllSubRowsSelected(row),\n        memoDeps: (row) => [\n          row.subRows,\n          row.table.atoms.rowSelection?.get(),\n          row.table.options.enableRowSelection,\n        ],\n      },\n      row_getCanSelect: {\n        fn: (row) => row_getCanSelect(row),\n      },\n      row_getCanSelectSubRows: {\n        fn: (row) => row_getCanSelectSubRows(row),\n      },\n      row_getCanMultiSelect: {\n        fn: (row) => row_getCanMultiSelect(row),\n      },\n      row_getToggleSelectedHandler: {\n        fn: (row, opts) => row_getToggleSelectedHandler(row, opts),\n      },\n    })\n  },\n\n  constructTableAPIs: (table) => {\n    assignTableAPIs('rowSelectionFeature', table, {\n      table_setRowSelection: {\n        fn: (updater) => table_setRowSelection(table, updater),\n      },\n      table_resetRowSelection: {\n        fn: (defaultState) => table_resetRowSelection(table, defaultState),\n      },\n      table_toggleAllRowsSelected: {\n        fn: (value, opts) => table_toggleAllRowsSelected(table, value, opts),\n      },\n      table_toggleAllPageRowsSelected: {\n        fn: (value, opts) =>\n          table_toggleAllPageRowsSelected(table, value, opts),\n      },\n      table_getPreSelectedRowModel: {\n        fn: () => table_getPreSelectedRowModel(table),\n      },\n      table_getSelectedRowModel: {\n        fn: () => table_getSelectedRowModel(table),\n        memoDeps: () => [\n          table.atoms.rowSelection?.get(),\n          table.getCoreRowModel(),\n        ],\n      },\n      table_getFilteredSelectedRowModel: {\n        fn: () => table_getFilteredSelectedRowModel(table),\n        memoDeps: () => [\n          table.atoms.rowSelection?.get(),\n          table.getFilteredRowModel(),\n        ],\n      },\n      table_getGroupedSelectedRowModel: {\n        fn: () => table_getGroupedSelectedRowModel(table),\n        memoDeps: () => [\n          table.atoms.rowSelection?.get(),\n          table.getSortedRowModel(),\n        ],\n      },\n      table_getSelectedRowIds: {\n        fn: () => table_getSelectedRowIds(table),\n        memoDeps: () => [table.atoms.rowSelection?.get()],\n      },\n      table_getIsAllRowsSelected: {\n        fn: () => table_getIsAllRowsSelected(table),\n        memoDeps: () => [\n          table.atoms.rowSelection?.get(),\n          table.getFilteredRowModel(),\n          table.options.enableRowSelection,\n        ],\n      },\n      table_getIsAllPageRowsSelected: {\n        fn: () => table_getIsAllPageRowsSelected(table),\n        memoDeps: () => [\n          table.atoms.rowSelection?.get(),\n          table.getPaginatedRowModel(),\n          table.options.enableRowSelection,\n        ],\n      },\n      table_getIsSomeRowsSelected: {\n        fn: () => table_getIsSomeRowsSelected(table),\n        memoDeps: () => [table.atoms.rowSelection?.get()],\n      },\n      table_getIsSomePageRowsSelected: {\n        fn: () => table_getIsSomePageRowsSelected(table),\n        memoDeps: () => [\n          table.atoms.rowSelection?.get(),\n          table.getPaginatedRowModel(),\n          table.options.enableRowSelection,\n        ],\n      },\n      table_getToggleAllRowsSelectedHandler: {\n        fn: () => table_getToggleAllRowsSelectedHandler(table),\n      },\n      table_getToggleAllPageRowsSelectedHandler: {\n        fn: () => table_getToggleAllPageRowsSelectedHandler(table),\n      },\n    })\n  },\n}\n"],"mappings":";;;;;;;AAoCA,MAAa,sBAAoC;CAC/C,wBAAwB,UAAU;EAEhC,MAAM,qBAAqB;CAC7B;CAEA,yBAAyB,UAAU;EAEjC,MAAM,qBAAqB;CAC7B;CAEA,kBAAkB,iBAAiB;EACjC,OAAO;GACL,cAAc,4BAA4B;GAC1C,GAAG;EACL;CACF;CAEA,yBAAyB,UAAU;EACjC,OAAO;GACL,sBAAsB,iBAAiB,gBAAgB,KAAK;GAC5D,oBAAoB;GACpB,yBAAyB;GACzB,yBAAyB;GACzB,uBAAuB;GACvB,2BAA2B,UAAU;IACnC,MAAM,aAAa;IAInB,OAAO,QAAQ,WAAW,YAAY,WAAW,aAAa,QAAQ;GACxE;EACF;CACF;CAEA,qBAAqB,WAAW,UAAU;EACxC,oBAAoB,uBAAuB,WAAW,OAAO;GAC3D,oBAAoB,EAClB,KAAK,KAAK,OAAO,SAAS,mBAAmB,KAAK,OAAO,IAAI,EAC/D;GACA,mBAAmB,EACjB,KAAK,QAAQ,kBAAkB,GAAG,EACpC;GACA,uBAAuB;IACrB,KAAK,QAAQ,sBAAsB,GAAG;IACtC,WAAW,QAAQ;KACjB,IAAI;KACJ,IAAI,MAAM,MAAM,cAAc,IAAI;KAClC,IAAI,MAAM,QAAQ;IACpB;GACF;GACA,6BAA6B;IAC3B,KAAK,QAAQ,4BAA4B,GAAG;IAC5C,WAAW,QAAQ;KACjB,IAAI;KACJ,IAAI,MAAM,MAAM,cAAc,IAAI;KAClC,IAAI,MAAM,QAAQ;IACpB;GACF;GACA,kBAAkB,EAChB,KAAK,QAAQ,iBAAiB,GAAG,EACnC;GACA,yBAAyB,EACvB,KAAK,QAAQ,wBAAwB,GAAG,EAC1C;GACA,uBAAuB,EACrB,KAAK,QAAQ,sBAAsB,GAAG,EACxC;GACA,8BAA8B,EAC5B,KAAK,KAAK,SAAS,6BAA6B,KAAK,IAAI,EAC3D;EACF,CAAC;CACH;CAEA,qBAAqB,UAAU;EAC7B,gBAAgB,uBAAuB,OAAO;GAC5C,uBAAuB,EACrB,KAAK,YAAY,sBAAsB,OAAO,OAAO,EACvD;GACA,yBAAyB,EACvB,KAAK,iBAAiB,wBAAwB,OAAO,YAAY,EACnE;GACA,6BAA6B,EAC3B,KAAK,OAAO,SAAS,4BAA4B,OAAO,OAAO,IAAI,EACrE;GACA,iCAAiC,EAC/B,KAAK,OAAO,SACV,gCAAgC,OAAO,OAAO,IAAI,EACtD;GACA,8BAA8B,EAC5B,UAAU,6BAA6B,KAAK,EAC9C;GACA,2BAA2B;IACzB,UAAU,0BAA0B,KAAK;IACzC,gBAAgB,CACd,MAAM,MAAM,cAAc,IAAI,GAC9B,MAAM,gBAAgB,CACxB;GACF;GACA,mCAAmC;IACjC,UAAU,kCAAkC,KAAK;IACjD,gBAAgB,CACd,MAAM,MAAM,cAAc,IAAI,GAC9B,MAAM,oBAAoB,CAC5B;GACF;GACA,kCAAkC;IAChC,UAAU,iCAAiC,KAAK;IAChD,gBAAgB,CACd,MAAM,MAAM,cAAc,IAAI,GAC9B,MAAM,kBAAkB,CAC1B;GACF;GACA,yBAAyB;IACvB,UAAU,wBAAwB,KAAK;IACvC,gBAAgB,CAAC,MAAM,MAAM,cAAc,IAAI,CAAC;GAClD;GACA,4BAA4B;IAC1B,UAAU,2BAA2B,KAAK;IAC1C,gBAAgB;KACd,MAAM,MAAM,cAAc,IAAI;KAC9B,MAAM,oBAAoB;KAC1B,MAAM,QAAQ;IAChB;GACF;GACA,gCAAgC;IAC9B,UAAU,+BAA+B,KAAK;IAC9C,gBAAgB;KACd,MAAM,MAAM,cAAc,IAAI;KAC9B,MAAM,qBAAqB;KAC3B,MAAM,QAAQ;IAChB;GACF;GACA,6BAA6B;IAC3B,UAAU,4BAA4B,KAAK;IAC3C,gBAAgB,CAAC,MAAM,MAAM,cAAc,IAAI,CAAC;GAClD;GACA,iCAAiC;IAC/B,UAAU,gCAAgC,KAAK;IAC/C,gBAAgB;KACd,MAAM,MAAM,cAAc,IAAI;KAC9B,MAAM,qBAAqB;KAC3B,MAAM,QAAQ;IAChB;GACF;GACA,uCAAuC,EACrC,UAAU,sCAAsC,KAAK,EACvD;GACA,2CAA2C,EACzC,UAAU,0CAA0C,KAAK,EAC3D;EACF,CAAC;CACH;AACF"}

package/dist/features/row-selection/rowSelectionFeature.types.d.cts

@@ -1,174 +0,0 @@
-import { OnChangeFn, RowData, Updater } from "../../types/type-utils.cjs";
-import { Row } from "../../types/Row.cjs";
-import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.cjs";
-import { TableFeatures } from "../../types/TableFeatures.cjs";
-
-//#region src/features/row-selection/rowSelectionFeature.types.d.ts
-type RowSelectionState = Record<string, true>;
-/**
- * Controls how toggling a row affects its descendants.
- */
-interface ToggleSelectedOptions {
-  /**
-   * Whether selectable child rows should be toggled recursively. Defaults to
-   * `true`.
-   */
-  selectChildren?: boolean;
-}
-interface TableState_RowSelection {
-  rowSelection: RowSelectionState;
-}
-interface TableOptions_RowSelection<in out TFeatures extends TableFeatures, in out TData extends RowData> {
-  /**
-   * Enables inclusive row range selection through
-   * `row.getToggleSelectedHandler()`. Defaults to `true`.
-   */
-  enableRowRangeSelection?: boolean;
-  /**
-   * Allows rows to be selected alongside other rows.
-   *
-   * Provide a predicate to decide per row. Defaults to `true`.
-   */
-  enableMultiRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
-  /**
-   * Allows rows to be selected.
-   *
-   * Provide a predicate to decide per row. Defaults to `true`.
-   */
-  enableRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
-  /**
-   * Controls whether selecting a parent row also selects its subRows.
-   *
-   * Provide a predicate to decide per row. This is most useful with expanding or
-   * grouping features and defaults to `true`.
-   */
-  enableSubRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
-  /**
-   * Determines whether a row-selection handler event should select or
-   * deselect the inclusive range from the most recent handler interaction.
-   *
-   * By default, events with `shiftKey` directly on the event or on
-   * `event.nativeEvent` are treated as range-selection events.
-   */
-  isRowRangeSelectionEvent?: (event: unknown) => boolean;
-  /**
-   * Called with an updater when row selection state changes. Pair this with
-   * `state.rowSelection` when using external state; external atoms can own the
-   * slice without this callback.
-   */
-  onRowSelectionChange?: OnChangeFn<RowSelectionState>;
-}
-interface Row_RowSelection {
-  /**
-   * Checks whether this row can be selected alongside other rows.
-   */
-  getCanMultiSelect: () => boolean;
-  /**
-   * Checks whether this row can currently be selected.
-   */
-  getCanSelect: () => boolean;
-  /**
-   * Checks whether selecting this row should also select its subRows.
-   */
-  getCanSelectSubRows: () => boolean;
-  /**
-   * Checks whether all selectable descendants are selected.
-   */
-  getIsAllSubRowsSelected: () => boolean;
-  /**
-   * Checks whether this row id is selected.
-   */
-  getIsSelected: () => boolean;
-  /**
-   * Checks whether some selectable descendants are selected.
-   */
-  getIsSomeSelected: () => boolean;
-  /**
-   * Creates a checkbox-style handler that toggles this row's selected state.
-   * Pass the original checkbox click event, or a framework event whose
-   * `nativeEvent` is that click, so Shift range selection can detect the
-   * modifier key.
-   */
-  getToggleSelectedHandler: (opts?: ToggleSelectedOptions) => (event: unknown) => void;
-  /**
-   * Selects/deselects the row.
-   */
-  toggleSelected: (value?: boolean, opts?: ToggleSelectedOptions) => void;
-}
-interface Table_RowSelection<in out TFeatures extends TableFeatures, in out TData extends RowData> {
-  /**
-   * The most recent row interacted with through the row selection handler.
-   *
-   * @internal
-   */
-  _lastSelectedRowId: string | null;
-  /**
-   * Builds a selected-row model from rows after filtering.
-   */
-  getFilteredSelectedRowModel: () => RowModel<TFeatures, TData>;
-  /**
-   * Builds a selected-row model from rows after grouping.
-   */
-  getGroupedSelectedRowModel: () => RowModel<TFeatures, TData>;
-  /**
-   * Returns the ids of all selected rows.
-   */
-  getSelectedRowIds: () => Array<string>;
-  /**
-   * Checks whether every selectable row on the current page is selected.
-   */
-  getIsAllPageRowsSelected: () => boolean;
-  /**
-   * Checks whether every selectable filtered row is selected.
-   */
-  getIsAllRowsSelected: () => boolean;
-  /**
-   * Checks whether the current page has a partial row selection.
-   */
-  getIsSomePageRowsSelected: () => boolean;
-  /**
-   * Checks whether filtered rows have a partial row selection.
-   */
-  getIsSomeRowsSelected: () => boolean;
-  /**
-   * Returns the core row model of all rows before row selection has been applied.
-   */
-  getPreSelectedRowModel: () => RowModel<TFeatures, TData>;
-  /**
-   * Builds a selected-row model from the core row model.
-   */
-  getSelectedRowModel: () => RowModel<TFeatures, TData>;
-  /**
-   * Creates a checkbox-style handler that toggles all current-page rows.
-   */
-  getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void;
-  /**
-   * Creates a checkbox-style handler that toggles all selectable rows.
-   */
-  getToggleAllRowsSelectedHandler: () => (event: unknown) => void;
-  /**
-   * Resets `rowSelection` to `initialState.rowSelection`.
-   *
-   * Pass `true` to ignore initial state and reset to `{}`.
-   */
-  resetRowSelection: (defaultState?: boolean) => void;
-  /**
-   * Updates row selection state with a next map or updater function.
-   */
-  setRowSelection: (updater: Updater<RowSelectionState>) => void;
-  /**
-   * Selects/deselects all rows on the current page.
-   */
-  toggleAllPageRowsSelected: (value?: boolean, opts?: {
-    deselectAll?: boolean;
-  }) => void;
-  /**
-   * Selects/deselects all rows in the table.
-   */
-  toggleAllRowsSelected: (value?: boolean, opts?: {
-    deselectAll?: boolean;
-  }) => void;
-}
-//#endregion
-export { RowSelectionState, Row_RowSelection, TableOptions_RowSelection, TableState_RowSelection, Table_RowSelection, ToggleSelectedOptions };
-//# sourceMappingURL=rowSelectionFeature.types.d.cts.map