@svgrid/grid 2.1.22 → 2.2.0

package/src/keyboard.test.ts

@@ -1,59 +1,59 @@
-import { describe, expect, it } from 'vitest'
-import { getKeyboardIntent, getNextActiveCell } from './keyboard'
-
-describe('keyboard navigation engine', () => {
-  it('maps keys to navigation intents', () => {
-    expect(getKeyboardIntent(new KeyboardEvent('keydown', { key: 'ArrowLeft' }))).toBe(
-      'moveLeft',
-    )
-    expect(getKeyboardIntent(new KeyboardEvent('keydown', { key: 'Home', ctrlKey: true }))).toBe(
-      'gridStart',
-    )
-    expect(getKeyboardIntent(new KeyboardEvent('keydown', { key: ' ' }))).toBe(
-      'activate',
-    )
-  })
-
-  it('computes next active cell within bounds', () => {
-    const next = getNextActiveCell(
-      { rowIndex: 1, colIndex: 1, cellId: null },
-      'moveDown',
-      { maxRow: 2, maxCol: 3, pageSize: 10 },
-    )
-    expect(next.rowIndex).toBe(2)
-    expect(next.colIndex).toBe(1)
-  })
-
-  it('handles row and grid boundary intents', () => {
-    const rowEnd = getNextActiveCell(
-      { rowIndex: 2, colIndex: 1, cellId: null },
-      'rowEnd',
-      { maxRow: 2, maxCol: 4, pageSize: 2 },
-    )
-    expect(rowEnd.colIndex).toBe(4)
-
-    const gridStart = getNextActiveCell(
-      { rowIndex: 2, colIndex: 4, cellId: null },
-      'gridStart',
-      { maxRow: 2, maxCol: 4, pageSize: 2 },
-    )
-    expect(gridStart.rowIndex).toBe(0)
-    expect(gridStart.colIndex).toBe(0)
-  })
-
-  it('clamps page navigation to valid bounds', () => {
-    const pageUp = getNextActiveCell(
-      { rowIndex: 1, colIndex: 0, cellId: null },
-      'pageUp',
-      { maxRow: 20, maxCol: 2, pageSize: 10 },
-    )
-    const pageDown = getNextActiveCell(
-      { rowIndex: 18, colIndex: 0, cellId: null },
-      'pageDown',
-      { maxRow: 20, maxCol: 2, pageSize: 10 },
-    )
-
-    expect(pageUp.rowIndex).toBe(0)
-    expect(pageDown.rowIndex).toBe(20)
-  })
-})
+import { describe, expect, it } from 'vitest'
+import { getKeyboardIntent, getNextActiveCell } from './keyboard'
+
+describe('keyboard navigation engine', () => {
+  it('maps keys to navigation intents', () => {
+    expect(getKeyboardIntent(new KeyboardEvent('keydown', { key: 'ArrowLeft' }))).toBe(
+      'moveLeft',
+    )
+    expect(getKeyboardIntent(new KeyboardEvent('keydown', { key: 'Home', ctrlKey: true }))).toBe(
+      'gridStart',
+    )
+    expect(getKeyboardIntent(new KeyboardEvent('keydown', { key: ' ' }))).toBe(
+      'activate',
+    )
+  })
+
+  it('computes next active cell within bounds', () => {
+    const next = getNextActiveCell(
+      { rowIndex: 1, colIndex: 1, cellId: null },
+      'moveDown',
+      { maxRow: 2, maxCol: 3, pageSize: 10 },
+    )
+    expect(next.rowIndex).toBe(2)
+    expect(next.colIndex).toBe(1)
+  })
+
+  it('handles row and grid boundary intents', () => {
+    const rowEnd = getNextActiveCell(
+      { rowIndex: 2, colIndex: 1, cellId: null },
+      'rowEnd',
+      { maxRow: 2, maxCol: 4, pageSize: 2 },
+    )
+    expect(rowEnd.colIndex).toBe(4)
+
+    const gridStart = getNextActiveCell(
+      { rowIndex: 2, colIndex: 4, cellId: null },
+      'gridStart',
+      { maxRow: 2, maxCol: 4, pageSize: 2 },
+    )
+    expect(gridStart.rowIndex).toBe(0)
+    expect(gridStart.colIndex).toBe(0)
+  })
+
+  it('clamps page navigation to valid bounds', () => {
+    const pageUp = getNextActiveCell(
+      { rowIndex: 1, colIndex: 0, cellId: null },
+      'pageUp',
+      { maxRow: 20, maxCol: 2, pageSize: 10 },
+    )
+    const pageDown = getNextActiveCell(
+      { rowIndex: 18, colIndex: 0, cellId: null },
+      'pageDown',
+      { maxRow: 20, maxCol: 2, pageSize: 10 },
+    )
+
+    expect(pageUp.rowIndex).toBe(0)
+    expect(pageDown.rowIndex).toBe(20)
+  })
+})

package/src/keyboard.ts

@@ -1,97 +1,97 @@
-import type { ActiveCellState } from './core'
-
-export type GridKeyboardIntent =
-  | 'moveLeft'
-  | 'moveRight'
-  | 'moveUp'
-  | 'moveDown'
-  | 'tabNext'
-  | 'tabPrev'
-  | 'rowStart'
-  | 'rowEnd'
-  | 'gridStart'
-  | 'gridEnd'
-  | 'pageUp'
-  | 'pageDown'
-  | 'activate'
-  | 'clearCells'
-  | 'noop'
-
-export function getKeyboardIntent(event: KeyboardEvent): GridKeyboardIntent {
-  // Ctrl+Home / Ctrl+End come before plain Home / End so the modifier wins.
-  if (event.ctrlKey && event.key === 'Home') return 'gridStart'
-  if (event.ctrlKey && event.key === 'End') return 'gridEnd'
-
-  if (event.key === 'ArrowLeft') return 'moveLeft'
-  if (event.key === 'ArrowRight') return 'moveRight'
-  if (event.key === 'ArrowUp') return 'moveUp'
-  if (event.key === 'ArrowDown') return 'moveDown'
-  if (event.key === 'Home') return 'rowStart'
-  if (event.key === 'End') return 'rowEnd'
-  if (event.key === 'PageUp') return 'pageUp'
-  if (event.key === 'PageDown') return 'pageDown'
-
-  // Excel-style data-entry navigation:
-  //   Enter      → move down (Shift+Enter → up)
-  //   Tab        → move right (Shift+Tab → left), wraps at row boundaries
-  //   Delete     → clear contents of the selected cells
-  //   F2 / Space → start editing the active cell
-  if (event.key === 'Enter') return event.shiftKey ? 'moveUp' : 'moveDown'
-  if (event.key === 'Tab') return event.shiftKey ? 'tabPrev' : 'tabNext'
-  if (event.key === 'F2') return 'activate'
-  if (event.key === ' ') return 'activate'
-  if (event.key === 'Delete') return 'clearCells'
-
-  return 'noop'
-}
-
-export function getNextActiveCell(
-  current: ActiveCellState,
-  intent: GridKeyboardIntent,
-  bounds: { maxRow: number; maxCol: number; pageSize?: number },
-): ActiveCellState {
-  const pageSize = bounds.pageSize ?? 10
-  let rowIndex = current.rowIndex
-  let colIndex = current.colIndex
-
-  if (intent === 'moveLeft') colIndex -= 1
-  if (intent === 'moveRight') colIndex += 1
-  if (intent === 'moveUp') rowIndex -= 1
-  if (intent === 'moveDown') rowIndex += 1
-  if (intent === 'tabNext') {
-    // Right one column; if we fall off the right edge, wrap to the
-    // first column of the next row - Excel's "data entry" behavior.
-    colIndex += 1
-    if (colIndex > bounds.maxCol) {
-      colIndex = 0
-      rowIndex += 1
-    }
-  }
-  if (intent === 'tabPrev') {
-    colIndex -= 1
-    if (colIndex < 0) {
-      colIndex = bounds.maxCol
-      rowIndex -= 1
-    }
-  }
-  if (intent === 'rowStart') colIndex = 0
-  if (intent === 'rowEnd') colIndex = bounds.maxCol
-  if (intent === 'gridStart') {
-    rowIndex = 0
-    colIndex = 0
-  }
-  if (intent === 'gridEnd') {
-    rowIndex = bounds.maxRow
-    colIndex = bounds.maxCol
-  }
-  if (intent === 'pageUp') rowIndex -= pageSize
-  if (intent === 'pageDown') rowIndex += pageSize
-
-  rowIndex = Math.min(Math.max(rowIndex, 0), Math.max(bounds.maxRow, 0))
-  colIndex = Math.min(Math.max(colIndex, 0), Math.max(bounds.maxCol, 0))
-  return {
-    rowIndex,
-    colIndex,
-    cellId: current.cellId,
-  }
-}
+import type { ActiveCellState } from './core'
+
+export type GridKeyboardIntent =
+  | 'moveLeft'
+  | 'moveRight'
+  | 'moveUp'
+  | 'moveDown'
+  | 'tabNext'
+  | 'tabPrev'
+  | 'rowStart'
+  | 'rowEnd'
+  | 'gridStart'
+  | 'gridEnd'
+  | 'pageUp'
+  | 'pageDown'
+  | 'activate'
+  | 'clearCells'
+  | 'noop'
+
+export function getKeyboardIntent(event: KeyboardEvent): GridKeyboardIntent {
+  // Ctrl+Home / Ctrl+End come before plain Home / End so the modifier wins.
+  if (event.ctrlKey && event.key === 'Home') return 'gridStart'
+  if (event.ctrlKey && event.key === 'End') return 'gridEnd'
+
+  if (event.key === 'ArrowLeft') return 'moveLeft'
+  if (event.key === 'ArrowRight') return 'moveRight'
+  if (event.key === 'ArrowUp') return 'moveUp'
+  if (event.key === 'ArrowDown') return 'moveDown'
+  if (event.key === 'Home') return 'rowStart'
+  if (event.key === 'End') return 'rowEnd'
+  if (event.key === 'PageUp') return 'pageUp'
+  if (event.key === 'PageDown') return 'pageDown'
+
+  // Excel-style data-entry navigation:
+  //   Enter      → move down (Shift+Enter → up)
+  //   Tab        → move right (Shift+Tab → left), wraps at row boundaries
+  //   Delete     → clear contents of the selected cells
+  //   F2 / Space → start editing the active cell
+  if (event.key === 'Enter') return event.shiftKey ? 'moveUp' : 'moveDown'
+  if (event.key === 'Tab') return event.shiftKey ? 'tabPrev' : 'tabNext'
+  if (event.key === 'F2') return 'activate'
+  if (event.key === ' ') return 'activate'
+  if (event.key === 'Delete') return 'clearCells'
+
+  return 'noop'
+}
+
+export function getNextActiveCell(
+  current: ActiveCellState,
+  intent: GridKeyboardIntent,
+  bounds: { maxRow: number; maxCol: number; pageSize?: number },
+): ActiveCellState {
+  const pageSize = bounds.pageSize ?? 10
+  let rowIndex = current.rowIndex
+  let colIndex = current.colIndex
+
+  if (intent === 'moveLeft') colIndex -= 1
+  if (intent === 'moveRight') colIndex += 1
+  if (intent === 'moveUp') rowIndex -= 1
+  if (intent === 'moveDown') rowIndex += 1
+  if (intent === 'tabNext') {
+    // Right one column; if we fall off the right edge, wrap to the
+    // first column of the next row - Excel's "data entry" behavior.
+    colIndex += 1
+    if (colIndex > bounds.maxCol) {
+      colIndex = 0
+      rowIndex += 1
+    }
+  }
+  if (intent === 'tabPrev') {
+    colIndex -= 1
+    if (colIndex < 0) {
+      colIndex = bounds.maxCol
+      rowIndex -= 1
+    }
+  }
+  if (intent === 'rowStart') colIndex = 0
+  if (intent === 'rowEnd') colIndex = bounds.maxCol
+  if (intent === 'gridStart') {
+    rowIndex = 0
+    colIndex = 0
+  }
+  if (intent === 'gridEnd') {
+    rowIndex = bounds.maxRow
+    colIndex = bounds.maxCol
+  }
+  if (intent === 'pageUp') rowIndex -= pageSize
+  if (intent === 'pageDown') rowIndex += pageSize
+
+  rowIndex = Math.min(Math.max(rowIndex, 0), Math.max(bounds.maxRow, 0))
+  colIndex = Math.min(Math.max(colIndex, 0), Math.max(bounds.maxCol, 0))
+  return {
+    rowIndex,
+    colIndex,
+    cellId: current.cellId,
+  }
+}

package/src/list-nav.test.ts

@@ -0,0 +1,49 @@
+import { describe, expect, it } from 'vitest'
+import { enabledIndices, wrapMove } from './list-nav'
+
+describe('enabledIndices', () => {
+  it('lists every index when nothing is disabled', () => {
+    expect(enabledIndices(3)).toEqual([0, 1, 2])
+  })
+
+  it('skips indices the predicate marks disabled', () => {
+    expect(enabledIndices(5, (i) => i === 1 || i === 3)).toEqual([0, 2, 4])
+  })
+
+  it('returns an empty array for a zero count', () => {
+    expect(enabledIndices(0)).toEqual([])
+  })
+})
+
+describe('wrapMove', () => {
+  const list = [0, 2, 4] // e.g. indices 1 and 3 are disabled
+
+  it('moves forward to the next enabled index', () => {
+    expect(wrapMove(list, 2, 1)).toBe(4)
+  })
+
+  it('wraps past the end back to the head', () => {
+    expect(wrapMove(list, 4, 1)).toBe(0)
+  })
+
+  it('wraps before the head to the tail', () => {
+    expect(wrapMove(list, 0, -1)).toBe(4)
+  })
+
+  it('from an absent current, delta 1 lands on the first entry', () => {
+    expect(wrapMove(list, -1, 1)).toBe(0)
+  })
+
+  it('from an absent current, delta -1 lands on the last-but-one', () => {
+    expect(wrapMove(list, -1, -1)).toBe(2)
+  })
+
+  it('stays put for a single-entry list', () => {
+    expect(wrapMove([5], 5, 1)).toBe(5)
+    expect(wrapMove([5], 5, -1)).toBe(5)
+  })
+
+  it('returns -1 for an empty list', () => {
+    expect(wrapMove([], 0, 1)).toBe(-1)
+  })
+})

package/src/list-nav.ts

@@ -0,0 +1,29 @@
+/**
+ * list-nav - the pure, framework-free navigation math shared by the roving-focus
+ * cores (createListbox, createPopoverSelect, createMenu). No runes, no DOM - just
+ * index arithmetic, so it is unit-testable on its own and behaves identically
+ * everywhere. The cores wrap these in `$state`.
+ */
+
+/** Indices of items that can take roving focus / selection - i.e. the ones the
+ *  caller does not mark disabled. `count` is the total item count; `isDisabled`
+ *  is consulted per index (a separator counts as disabled to the caller). */
+export function enabledIndices(count: number, isDisabled?: (index: number) => boolean): number[] {
+  const out: number[] = []
+  for (let i = 0; i < count; i++) if (!isDisabled?.(i)) out.push(i)
+  return out
+}
+
+/**
+ * The next index when moving `delta` steps through `list`, wrapping around the
+ * ends. `current` need not be in `list` (it may sit on a disabled item): when it
+ * is absent we start just before the head so `delta: 1` lands on the first entry
+ * and `delta: -1` on the last-but-one - the same behaviour every existing core
+ * already had. Returns `-1` for an empty list.
+ */
+export function wrapMove(list: readonly number[], current: number, delta: number): number {
+  const len = list.length
+  if (len === 0) return -1
+  const pos = list.indexOf(current)
+  return list[(pos + delta + len) % len]!
+}

package/src/list-option.ts

@@ -5,6 +5,8 @@ export type ListOption = {
   disabled?: boolean
   /** Optional group heading this option belongs under. */
   group?: string
+  /** Optional color swatch (any CSS color) shown before the label. */
+  color?: string
 }
 
 /** Case-insensitive substring filter over option labels. */

package/src/menu-item.ts

@@ -0,0 +1,21 @@
+import type { Snippet } from 'svelte'
+
+/**
+ * A single item in a menu (SvMenu / SvMenuList / SvContextMenu) and the headless
+ * `createMenu` core. Kept in a plain `.ts` module so the core can import the type
+ * without pulling in the `.svelte` component - which would create a
+ * `.svelte.ts` -> `.svelte` -> `.svelte.ts` import cycle that Vite's dev-time
+ * import-analysis fails to resolve.
+ */
+export type MenuItem = {
+  /** Item text. Omit + set `separator` for a divider. */
+  label?: string
+  separator?: boolean
+  icon?: Snippet
+  /** Right-aligned hint, e.g. a keyboard shortcut. */
+  shortcut?: string
+  disabled?: boolean
+  /** Nested submenu items (renders a flyout). */
+  children?: MenuItem[]
+  onSelect?: () => void
+}

package/src/menus.test.ts

@@ -98,6 +98,54 @@ describe('createMenus - filter row/menu value updates', () => {
     expect(ctx.filterRowValues.name).toBe('foo')
   })
 
+  it('addFilterToken builds a newline-serialised in/notIn list, ignoring dupes/blanks', () => {
+    const ctx = makeCtx()
+    const m = createMenus(ctx)
+    m.addFilterToken('symbol', 'TSM')
+    m.addFilterToken('symbol', 'BP')
+    m.addFilterToken('symbol', 'TSM') // dupe - ignored
+    m.addFilterToken('symbol', '   ') // blank - ignored
+    expect(ctx.filterRowValues.symbol).toBe('TSM\nBP')
+    // mirrored into the menu model too, so both filter surfaces agree
+    expect(ctx.filterMenuValues.symbol.value).toBe('TSM\nBP')
+  })
+
+  it('removeFilterToken drops a value from the list', () => {
+    const ctx = makeCtx({ filterRowValues: { symbol: 'TSM\nBP\nBABA' } })
+    const m = createMenus(ctx)
+    m.removeFilterToken('symbol', 'BP')
+    expect(ctx.filterRowValues.symbol).toBe('TSM\nBABA')
+  })
+
+  it('toggleFilterToken adds when absent and removes when present', () => {
+    const ctx = makeCtx()
+    const m = createMenus(ctx)
+    m.toggleFilterToken('symbol', 'BP')
+    expect(ctx.filterRowValues.symbol).toBe('BP')
+    m.toggleFilterToken('symbol', 'BP')
+    expect(ctx.filterRowValues.symbol).toBe('')
+  })
+
+  it('openInSuggest anchors the dropdown and targets the column; closeInSuggest clears it', () => {
+    const ctx = makeCtx()
+    const m = createMenus(ctx)
+    const anchor = {
+      getBoundingClientRect: () => ({ left: 40, bottom: 80 }),
+    } as unknown as HTMLElement
+    m.openInSuggest(anchor, 'symbol')
+    expect(ctx.inSuggestFor).toBe('symbol')
+    expect(ctx.inSuggestPos).toMatchObject({ y: 84 })
+    m.closeInSuggest()
+    expect(ctx.inSuggestFor).toBe(null)
+  })
+
+  it('closeMenus also dismisses the in-suggest dropdown', () => {
+    const ctx = makeCtx({ inSuggestFor: 'symbol' })
+    const m = createMenus(ctx)
+    m.closeMenus()
+    expect(ctx.inSuggestFor).toBe(null)
+  })
+
   it('updateFilterMenuValueTo sets the upper bound for between', () => {
     const ctx = makeCtx({ filterMenuValues: { age: { operator: 'between', value: '5' } } })
     const m = createMenus(ctx)