@jielga/tmdatagrid 1.0.0 → 1.0.2

package/src/tmdatagrid/core/persistence.ts

@@ -55,8 +55,8 @@ export type TMDataGridSettingsSlice = (typeof SETTINGS_STATE_SLICES)[number];
 /**
  * A storage key, optionally narrowed to a subset of its group's slices.
  *
- * - `"employees.data"` — persists every slice in the group.
- * - `["employees.data", ["sorting"]]` — persists only the listed slices.
+ * - `"employees.data"` - persists every slice in the group.
+ * - `["employees.data", ["sorting"]]` - persists only the listed slices.
  */
 export type TMDataGridPersistKey<TSlice extends string> =
   | string
@@ -83,7 +83,7 @@ export type TMDataGridPersistence = {
  * collide with. A payload whose version does not match is dropped whole: a
  * migration would be guessing at a shape this code no longer knows, and the
  * cost of dropping is one lost layout. Payloads written before versioning
- * existed (≤0.4.0) have no stamp and are dropped the same way — the 1.0
+ * existed (≤0.4.0) have no stamp and are dropped the same way - the 1.0
  * wave's one-time break, named in its changeset.
  */
 export const PERSIST_PAYLOAD_VERSION = 1;
@@ -163,7 +163,7 @@ const SLICE_GUARDS: Record<
   (value: unknown) => boolean
 > = {
   columnFilters: (value) => isArrayOf(value, hasStringId),
-  // TanStack leaves the global filter value untyped — the grid's own default
+  // TanStack leaves the global filter value untyped - the grid's own default
   // filters on a string, but a consumer may store anything here.
   globalFilter: () => true,
   sorting: (value) =>
@@ -266,7 +266,7 @@ const defaultSerialize = (value: Partial<GridState>): string =>
  * The leaf column ids a set of column defs will produce, by TanStack's own
  * derivation: `id`, else `accessorKey` with dots replaced by underscores,
  * else a string `header`. Mirrored here so restored state can be realigned
- * against the columns that will actually exist — deriving ids any other way
+ * against the columns that will actually exist - deriving ids any other way
  * would realign against names the table never uses.
  */
 export function collectLeafColumnIds(
@@ -295,7 +295,7 @@ export function collectLeafColumnIds(
  * Drops restored entries that name columns the grid no longer has.
  *
  * A stored layout outlives the column set: a column removed between deploys
- * would otherwise linger forever — a ghost id in the order, a width for
+ * would otherwise linger forever - a ghost id in the order, a width for
  * nothing, and worse, a *filter or sort that is active but has no column to
  * show for itself*. New columns need no counterpart here: TanStack appends
  * columns missing from `columnOrder` on its own, in definition order.
@@ -337,8 +337,8 @@ function realignToColumns(
 /**
  * State to merge into `initialState`, read once on mount.
  *
- * With `knownColumnIds` — every id the grid is about to construct, generated
- * lanes included — the column-shaped slices are realigned first; see
+ * With `knownColumnIds` - every id the grid is about to construct, generated
+ * lanes included - the column-shaped slices are realigned first; see
  * {@link realignToColumns}. Without it the payload is returned as stored.
  */
 export function readPersistedState(

package/src/tmdatagrid/core/quickSearch.ts

@@ -12,11 +12,11 @@ import {
   type TableFeatures,
 } from "@tanstack/react-table";
 
-/** How the quick search matches — see `quickSearchMode` on the hook options. */
+/** How the quick search matches - see `quickSearchMode` on the hook options. */
 export type TMDataGridQuickSearchMode = "fuzzy" | "contains";
 
 /**
- * The fuzzy filter's registry name — what `globalFilterFn` resolves to while
+ * The fuzzy filter's registry name - what `globalFilterFn` resolves to while
  * `quickSearchMode` is `"fuzzy"`. The rank ordering keys off this name, so an
  * explicit `globalFilterFn` override switches the ordering off with it.
  */
@@ -37,8 +37,8 @@ function isFuzzyFilterMeta(value: unknown): value is FuzzyFilterMeta {
 
 /**
  * Match-sorter ranking as the global filter: a row passes when a globally
- * filterable column ranks above match-sorter's threshold — typos and skipped
- * characters forgiven — and the rank is recorded for the ordering to read.
+ * filterable column ranks above match-sorter's threshold - typos and skipped
+ * characters forgiven - and the rank is recorded for the ordering to read.
  *
  * TanStack stops probing a row's columns at the first passing one, so the
  * recorded ranks cover the columns up to and including it; the best of those
@@ -81,7 +81,7 @@ function bestRank<TFeatures extends TableFeatures, TData extends RowData>(
 
 /**
  * Whether the ranked ordering applies: the fuzzy quick search is narrowing
- * the grid, and nothing else claims an order — no sort, no grouping.
+ * the grid, and nothing else claims an order - no sort, no grouping.
  */
 function isRankingActive<TFeatures extends TableFeatures, TData extends RowData>(
   table: Table<TFeatures, TData>,
@@ -106,7 +106,7 @@ function isRankingActive<TFeatures extends TableFeatures, TData extends RowData>
 
 /**
  * The sorted row model, with one addition: while {@link isRankingActive},
- * rows order by match quality, best first. Declarative — the ordering is
+ * rows order by match quality, best first. Declarative - the ordering is
  * derived from filter state, never written into `sorting`, so no column
  * claims `aria-sort`, the persisted slice stays untouched, and the user's
  * next sort click suspends it just by existing.
@@ -121,8 +121,8 @@ export function createFuzzyRankedSortedRowModel<
   const base = createSortedRowModel<TFeatures, TData>();
   return (table) => {
     const getSorted = base(table);
-    // One-slot memo: every input of the ordering — filter text, data, the
-    // sorting and grouping states — changes the sorted model's identity, so
+    // One-slot memo: every input of the ordering - filter text, data, the
+    // sorting and grouping states - changes the sorted model's identity, so
     // the model alone is the cache key.
     let lastModel: RowModel<TFeatures, TData> | null = null;
     let ranked: RowModel<TFeatures, TData> | null = null;

package/src/tmdatagrid/core/rowPinning.ts

@@ -5,7 +5,7 @@ import type { TMDataGridFeatures, TMDataGridTable } from "../useTMDataGrid";
  * The rows pinned to one edge, resolved safely and in pin order.
  *
  * Not TanStack's `getTopRows()`: that resolves each pinned id with
- * `getRow(id, true)`, which throws once the row's data is gone — and pinned
+ * `getRow(id, true)`, which throws once the row's data is gone - and pinned
  * ids outlive data. A delete, a server-side page swap, a refetch that comes
  * back without the row: any of these would take the whole grid down. Here a
  * stale id is skipped instead; it stays in state, harmless, and the row
@@ -13,8 +13,8 @@ import type { TMDataGridFeatures, TMDataGridTable } from "../useTMDataGrid";
  *
  * The semantics are TanStack's `keepPinnedRows: true`: a pinned row stays at
  * its edge even when a filter or the pager would have dropped it from the
- * body. Ids resolve against the pre-pagination model first — those rows carry
- * the live sort and filter context — with the core model as the fallback for
+ * body. Ids resolve against the pre-pagination model first - those rows carry
+ * the live sort and filter context - with the core model as the fallback for
  * rows the filters removed. A leaf whose group is collapsed stays hidden,
  * as upstream does.
  */

package/src/tmdatagrid/core/rowSelection.ts

@@ -5,17 +5,17 @@ import type { TMDataGridFeatures, TMDataGridTable } from "../useTMDataGrid";
 
 /**
  * Rows in the order they are displayed, which is the order a shift-click range
- * is measured over — so a range follows the active sort and skips filtered-out
+ * is measured over - so a range follows the active sort and skips filtered-out
  * rows. Under pagination it is the current page, so a range cannot cross a page
  * boundary.
  *
  * Once a column is grouped this includes the group rows, and only the leaves of
- * groups that are open — and paging is suspended, so it is the whole tree. That
+ * groups that are open - and paging is suspended, so it is the whole tree. That
  * is the right list for a range: it is what the user can see, and a range that
  * swept collapsed rows would select things off screen. What a group row in the
  * range contributes is decided by {@link getSelectableRowIds}.
  *
- * Rows pinned to an edge leave this list — they render in their own sticky
+ * Rows pinned to an edge leave this list - they render in their own sticky
  * blocks, outside the scrolling order a shift-click range or the virtualizer
  * walks. See `readPinnedRows`.
  */
@@ -42,7 +42,7 @@ export function getDisplayedRows<TData extends RowData>(
  * to go looking for, and counting only the top-level rows quietly redefines
  * "rows per page" as groups per page, so a page of 25 can hold thousands of
  * rows. Rather than pick, the grid renders the whole tree and leans on the
- * virtualizer — which is its default mode anyway, pagination being opt-in.
+ * virtualizer - which is its default mode anyway, pagination being opt-in.
  *
  * `TMDataGrid.Footer` reads this too, and greys the pager out rather than
  * hiding it, so the pager going quiet is visible instead of mysterious.
@@ -56,7 +56,7 @@ export function isPagingActive<TData extends RowData>(
 
 /**
  * Which modifiers were held. Named for what they mean rather than for the keys,
- * because the keys differ per platform — `toggle` is Ctrl on Windows/Linux and
+ * because the keys differ per platform - `toggle` is Ctrl on Windows/Linux and
  * Cmd on macOS.
  */
 export type TMDataGridRowClickModifiers = {
@@ -65,7 +65,7 @@ export type TMDataGridRowClickModifiers = {
 };
 
 export type ResolveRowSelectionClickArgs<TData extends RowData> = {
-  /** Displayed order — see {@link getDisplayedRows}. */
+  /** Displayed order - see {@link getDisplayedRows}. */
   rows: ReadonlyArray<Row<TMDataGridFeatures, TData>>;
   rowId: string;
   /** The pivot a shift-click extends from. */
@@ -76,7 +76,7 @@ export type ResolveRowSelectionClickArgs<TData extends RowData> = {
    * Whether this gesture is allowed to clear rows it did not touch.
    *
    * `true` for a bare row click, where replacing is the whole point. `false` for
-   * a checkbox, which is only ever additive — ticking one box has never cleared
+   * a checkbox, which is only ever additive - ticking one box has never cleared
    * the others, and shift-clicking one adds the range rather than becoming it.
    */
   canReplaceSelection: boolean;
@@ -138,7 +138,7 @@ export function resolveRowSelectionClick<TData extends RowData>({
 }: ResolveRowSelectionClickArgs<TData>): ResolvedRowSelection {
   const index = rows.findIndex((row) => row.id === rowId);
   const clickedRow = rows[index];
-  // Clicked row is not in the displayed set — nothing sensible to resolve.
+  // Clicked row is not in the displayed set - nothing sensible to resolve.
   if (index === -1 || clickedRow === undefined) return { selection, anchorRowId };
 
   const targets = getSelectableRowIds(clickedRow);
@@ -152,7 +152,7 @@ export function resolveRowSelectionClick<TData extends RowData>({
   //
   // This has to be enforced here. Rebuilding the map and handing it to
   // `setRowSelection` skips `mutateRowIsSelected`, which is where TanStack
-  // clears the other rows — so without this, Ctrl and Shift would quietly
+  // clears the other rows - so without this, Ctrl and Shift would quietly
   // produce the multi-selection the option ruled out.
   if (!clickedRow.getCanMultiSelect()) {
     // A group stands for several rows, which single-select cannot express. The
@@ -179,12 +179,12 @@ export function resolveRowSelectionClick<TData extends RowData>({
     const from = Math.min(anchorIndex, index);
     const to = Math.max(anchorIndex, index);
     // Ctrl+Shift adds to what is already selected; Shift alone becomes the
-    // range — unless the gesture may not replace, in which case it also adds.
+    // range - unless the gesture may not replace, in which case it also adds.
     const next: RowSelectionState =
       modifiers.toggle || !canReplaceSelection ? { ...selection } : {};
     for (const row of rows.slice(from, to + 1)) {
       // A group row inside the range brings its whole subtree, including leaves
-      // that are collapsed out of `rows` — sweeping past a closed group selects
+      // that are collapsed out of `rows` - sweeping past a closed group selects
       // it entire, which is the only reading that matches what it displays.
       for (const id of getSelectableRowIds(row)) next[id] = true;
     }
@@ -195,7 +195,7 @@ export function resolveRowSelectionClick<TData extends RowData>({
   if (modifiers.toggle || !canReplaceSelection) {
     const next: RowSelectionState = { ...selection };
     // Asked of the targets rather than of `rowId`: a group row carries no id in
-    // the map, so it counts as selected exactly when all of its leaves do —
+    // the map, so it counts as selected exactly when all of its leaves do -
     // which is also when its checkbox shows a tick rather than a dash.
     const allSelected = targets.every((id) => selection[id] === true);
     for (const id of targets) {

package/src/tmdatagrid/core/sizes.ts

@@ -7,7 +7,7 @@ export const DEFAULT_TMDATAGRID_SIZE: TMDataGridSize = "md";
 /**
  * Row height per size, in px.
  *
- * The virtualizer needs this as a number — it cannot read the CSS variable —
+ * The virtualizer needs this as a number - it cannot read the CSS variable -
  * so the scale lives here and `TMDataGrid.module.css` mirrors it. `meta.rowHeight`
  * overrides it when a grid needs a height the scale doesn't offer.
  */

package/src/tmdatagrid/core/summary.ts

@@ -2,11 +2,11 @@ import { aggregationFns, type RowData } from "@tanstack/react-table";
 import type { TMDataGridRowData } from "../TMDataGridContext";
 import type { TMDataGridTable } from "../useTMDataGrid";
 
-/** The registered aggregation names — the same set `aggregationFn` accepts. */
+/** The registered aggregation names - the same set `aggregationFn` accepts. */
 export type TMDataGridAggregationName = keyof typeof aggregationFns;
 
 /**
- * One column aggregated over every filtered row — the number a summary-row
+ * One column aggregated over every filtered row - the number a summary-row
  * `footer` wants:
  *
  * ```tsx
@@ -16,7 +16,7 @@ export type TMDataGridAggregationName = keyof typeof aggregationFns;
  * ```
  *
  * Filtered rather than paginated rows, so the total covers everything the
- * filters left — all pages — and follows the filters as they change. Reuses
+ * filters left (all pages), and follows the filters as they change. Reuses
  * TanStack's registered aggregation functions; `fn` defaults to `"sum"`.
  */
 export function aggregateColumn<TData extends RowData>({