@svgrid/grid 2.6.2 → 2.6.4

package/src/svgrid.group-pagination.test.ts

@@ -1,153 +1,153 @@
-/**
- * DOM: with grouping on, `pageSize` budgets DATA rows, not group banners (#73).
- *
- * The row model hands the view one flat list with group banners interleaved
- * between their children. Slicing that list by `pageSize` spent the budget on
- * banners: ten groups of two at `pageSize: 10` showed roughly three data rows,
- * and with enough small groups a page could show almost none.
- *
- * Now the page window is measured in data rows, and each page reprints the
- * banners its rows sit under - so a group split across a page boundary is
- * labelled on both pages.
- */
-import { afterEach, describe, expect, it } from 'vitest'
-import { mount, unmount } from 'svelte'
-import SvGrid from './SvGrid.svelte'
-import {
-  createCoreRowModel,
-  createExpandedRowModel,
-  createFilteredRowModel,
-  createGroupedRowModel,
-  createPaginatedRowModel,
-  createSortedRowModel,
-  sortFns,
-  tableFeatures,
-  rowSortingFeature,
-  columnGroupingFeature,
-} from './index'
-
-type Row = { id: number; region: string; amount: number }
-
-// Ten groups of two rows - the shape from the report.
-const data: Row[] = []
-for (let g = 0; g < 10; g += 1) {
-  data.push({ id: g * 2, region: `R${g}`, amount: 1 })
-  data.push({ id: g * 2 + 1, region: `R${g}`, amount: 2 })
-}
-
-const columns = [
-  { field: 'region', header: 'Region', width: 120 },
-  { field: 'amount', header: 'Amount', width: 100 },
-]
-
-const features = tableFeatures({ rowSortingFeature, columnGroupingFeature })
-const tick = () => new Promise<void>((r) => queueMicrotask(r))
-
-function mountGrid(pageSize: number, groupFooters = false) {
-  const target = document.createElement('div')
-  document.body.appendChild(target)
-  // Grouping state starts empty and is driven through the api - there is no
-  // initial-grouping prop - so group by region as soon as the api lands.
-  let api: { setGroupBy: (ids: string[]) => void } | null = null
-  const app = mount(SvGrid, {
-    target,
-    props: {
-      data,
-      columns,
-      features,
-      groupable: true,
-      groupFooters,
-      onApiReady: (a: never) => { api = a as never },
-      pageable: true,
-      pageSize,
-      _rowModels: {
-        coreRowModel: createCoreRowModel(),
-        filteredRowModel: createFilteredRowModel(),
-        sortedRowModel: createSortedRowModel(sortFns),
-        groupedRowModel: createGroupedRowModel(),
-        expandedRowModel: createExpandedRowModel(),
-        paginatedRowModel: createPaginatedRowModel(),
-      },
-      containerHeight: 900,
-      virtualization: false,
-    } as never,
-  })
-  return {
-    target,
-    groupByRegion: () => api?.setGroupBy(['region']),
-    /** Groups render collapsed by default; click every banner to open them. */
-    expandAll: () => {
-      for (const btn of target.querySelectorAll<HTMLButtonElement>('.sv-grid-group-toggle')) {
-        if (btn.getAttribute('aria-expanded') !== 'true') btn.click()
-      }
-    },
-    destroy: () => { unmount(app); target.remove() },
-  }
-}
-
-let cleanup: (() => void) | null = null
-afterEach(() => { cleanup?.(); cleanup = null })
-
-const dataRows = (t: HTMLElement) =>
-  [...t.querySelectorAll('tbody tr.sv-grid-row')].filter(
-    (r) => !r.classList.contains('sv-grid-group-row') && !r.classList.contains('sv-grid-row-spacer'),
-  )
-const groupRows = (t: HTMLElement) => [...t.querySelectorAll('tbody tr.sv-grid-group-row')]
-
-async function grouped(pageSize: number, expand = true, groupFooters = false) {
-  const g = mountGrid(pageSize, groupFooters)
-  cleanup = g.destroy
-  await tick()
-  g.groupByRegion()
-  await tick()
-  if (expand) {
-    g.expandAll()
-    await tick()
-  }
-  return g
-}
-
-describe('grouped pagination (#73)', () => {
-  it('fills the page with pageSize DATA rows, not banners', async () => {
-    const { target } = await grouped(10)
-    // Before the fix the flat slice returned 10 TOTAL rows - banners included -
-    // so only a handful of them were data.
-    expect(dataRows(target)).toHaveLength(10)
-    // Those 10 data rows span 5 groups, so 5 banners come along for free.
-    expect(groupRows(target)).toHaveLength(5)
-  })
-
-  it('reports the data-row count in the pager, not banners + data', async () => {
-    const { target } = await grouped(10)
-    // 20 data rows at pageSize 10 = 2 pages. Counting banners would say 30.
-    expect(target.textContent).toMatch(/of\s+20\b/)
-  })
-
-  it('reprints the banner for a group straddling a page boundary', async () => {
-    const { target } = await grouped(3)
-    // Page 0 holds R0's two rows plus R1's first, so both banners show.
-    const labels = groupRows(target).map((r) => r.textContent ?? '')
-    expect(labels.some((t) => t.includes('R0'))).toBe(true)
-    expect(labels.some((t) => t.includes('R1'))).toBe(true)
-    expect(dataRows(target)).toHaveLength(3)
-  })
-
-  it('does not spend page budget on group footers', async () => {
-    // Footers are inserted after paging, so turning them on must not push data
-    // rows onto the next page.
-    const { target } = await grouped(10, true, true)
-    expect(dataRows(target).filter((r) => !r.classList.contains('sv-grid-group-footer-row')))
-      .toHaveLength(10)
-    expect(target.textContent).toMatch(/of\s+20\b/)
-  })
-
-  it('still fills a page when every group is collapsed', async () => {
-    // Collapsed groups are the visible unit. Treating them as free headers
-    // emptied the page entirely - caught here, not by the pure helper.
-    const { target } = await grouped(4, false)
-    expect(groupRows(target)).toHaveLength(4)
-    expect(dataRows(target)).toHaveLength(0)
-    // 10 collapsed groups over pageSize 4.
-    expect(target.textContent).toMatch(/of\s+10\b/)
-  })
-})
+/**
+ * DOM: with grouping on, `pageSize` budgets DATA rows, not group banners (#73).
+ *
+ * The row model hands the view one flat list with group banners interleaved
+ * between their children. Slicing that list by `pageSize` spent the budget on
+ * banners: ten groups of two at `pageSize: 10` showed roughly three data rows,
+ * and with enough small groups a page could show almost none.
+ *
+ * Now the page window is measured in data rows, and each page reprints the
+ * banners its rows sit under - so a group split across a page boundary is
+ * labelled on both pages.
+ */
+import { afterEach, describe, expect, it } from 'vitest'
+import { mount, unmount } from 'svelte'
+import SvGrid from './SvGrid.svelte'
+import {
+  createCoreRowModel,
+  createExpandedRowModel,
+  createFilteredRowModel,
+  createGroupedRowModel,
+  createPaginatedRowModel,
+  createSortedRowModel,
+  sortFns,
+  tableFeatures,
+  rowSortingFeature,
+  columnGroupingFeature,
+} from './index'
+
+type Row = { id: number; region: string; amount: number }
+
+// Ten groups of two rows - the shape from the report.
+const data: Row[] = []
+for (let g = 0; g < 10; g += 1) {
+  data.push({ id: g * 2, region: `R${g}`, amount: 1 })
+  data.push({ id: g * 2 + 1, region: `R${g}`, amount: 2 })
+}
+
+const columns = [
+  { field: 'region', header: 'Region', width: 120 },
+  { field: 'amount', header: 'Amount', width: 100 },
+]
+
+const features = tableFeatures({ rowSortingFeature, columnGroupingFeature })
+const tick = () => new Promise<void>((r) => queueMicrotask(r))
+
+function mountGrid(pageSize: number, groupFooters = false) {
+  const target = document.createElement('div')
+  document.body.appendChild(target)
+  // Grouping state starts empty and is driven through the api - there is no
+  // initial-grouping prop - so group by region as soon as the api lands.
+  let api: { setGroupBy: (ids: string[]) => void } | null = null
+  const app = mount(SvGrid, {
+    target,
+    props: {
+      data,
+      columns,
+      features,
+      groupable: true,
+      groupFooters,
+      onApiReady: (a: never) => { api = a as never },
+      pageable: true,
+      pageSize,
+      _rowModels: {
+        coreRowModel: createCoreRowModel(),
+        filteredRowModel: createFilteredRowModel(),
+        sortedRowModel: createSortedRowModel(sortFns),
+        groupedRowModel: createGroupedRowModel(),
+        expandedRowModel: createExpandedRowModel(),
+        paginatedRowModel: createPaginatedRowModel(),
+      },
+      containerHeight: 900,
+      virtualization: false,
+    } as never,
+  })
+  return {
+    target,
+    groupByRegion: () => api?.setGroupBy(['region']),
+    /** Groups render collapsed by default; click every banner to open them. */
+    expandAll: () => {
+      for (const btn of target.querySelectorAll<HTMLButtonElement>('.sv-grid-group-toggle')) {
+        if (btn.getAttribute('aria-expanded') !== 'true') btn.click()
+      }
+    },
+    destroy: () => { unmount(app); target.remove() },
+  }
+}
+
+let cleanup: (() => void) | null = null
+afterEach(() => { cleanup?.(); cleanup = null })
+
+const dataRows = (t: HTMLElement) =>
+  [...t.querySelectorAll('tbody tr.sv-grid-row')].filter(
+    (r) => !r.classList.contains('sv-grid-group-row') && !r.classList.contains('sv-grid-row-spacer'),
+  )
+const groupRows = (t: HTMLElement) => [...t.querySelectorAll('tbody tr.sv-grid-group-row')]
+
+async function grouped(pageSize: number, expand = true, groupFooters = false) {
+  const g = mountGrid(pageSize, groupFooters)
+  cleanup = g.destroy
+  await tick()
+  g.groupByRegion()
+  await tick()
+  if (expand) {
+    g.expandAll()
+    await tick()
+  }
+  return g
+}
+
+describe('grouped pagination (#73)', () => {
+  it('fills the page with pageSize DATA rows, not banners', async () => {
+    const { target } = await grouped(10)
+    // Before the fix the flat slice returned 10 TOTAL rows - banners included -
+    // so only a handful of them were data.
+    expect(dataRows(target)).toHaveLength(10)
+    // Those 10 data rows span 5 groups, so 5 banners come along for free.
+    expect(groupRows(target)).toHaveLength(5)
+  })
+
+  it('reports the data-row count in the pager, not banners + data', async () => {
+    const { target } = await grouped(10)
+    // 20 data rows at pageSize 10 = 2 pages. Counting banners would say 30.
+    expect(target.textContent).toMatch(/of\s+20\b/)
+  })
+
+  it('reprints the banner for a group straddling a page boundary', async () => {
+    const { target } = await grouped(3)
+    // Page 0 holds R0's two rows plus R1's first, so both banners show.
+    const labels = groupRows(target).map((r) => r.textContent ?? '')
+    expect(labels.some((t) => t.includes('R0'))).toBe(true)
+    expect(labels.some((t) => t.includes('R1'))).toBe(true)
+    expect(dataRows(target)).toHaveLength(3)
+  })
+
+  it('does not spend page budget on group footers', async () => {
+    // Footers are inserted after paging, so turning them on must not push data
+    // rows onto the next page.
+    const { target } = await grouped(10, true, true)
+    expect(dataRows(target).filter((r) => !r.classList.contains('sv-grid-group-footer-row')))
+      .toHaveLength(10)
+    expect(target.textContent).toMatch(/of\s+20\b/)
+  })
+
+  it('still fills a page when every group is collapsed', async () => {
+    // Collapsed groups are the visible unit. Treating them as free headers
+    // emptied the page entirely - caught here, not by the pure helper.
+    const { target } = await grouped(4, false)
+    expect(groupRows(target)).toHaveLength(4)
+    expect(dataRows(target)).toHaveLength(0)
+    // 10 collapsed groups over pageSize 4.
+    expect(target.textContent).toMatch(/of\s+10\b/)
+  })
+})

package/src/svgrid.group-props-reactive.svelte.test.ts

@@ -0,0 +1,151 @@
+/**
+ * Reactivity for `groupBy` / `expanded`: reassigning the prop must re-apply to
+ * the engine, and a controlled parent that echoes `onExpandedChange` straight
+ * back into `expanded` must settle instead of looping.
+ *
+ * Lives in a `.svelte.test.ts` so runes are available - the props object is a
+ * `$state` proxy, which is what makes a prop reassignment reach the component.
+ */
+import { describe, expect, it } from 'vitest'
+import { mount, unmount, flushSync } from 'svelte'
+import SvGrid from './SvGrid.svelte'
+import {
+  columnGroupingFeature,
+  createCoreRowModel,
+  createExpandedRowModel,
+  createFilteredRowModel,
+  createGroupedRowModel,
+  createPaginatedRowModel,
+  createSortedRowModel,
+  rowExpandingFeature,
+  rowSortingFeature,
+  sortFns,
+  tableFeatures,
+} from './index'
+import type { SvGridApi } from './index'
+
+type Row = { id: number; name: string; department: string }
+
+const rows: Row[] = [
+  { id: 1, name: 'Ada', department: 'Engineering' },
+  { id: 2, name: 'Grace', department: 'Engineering' },
+  { id: 3, name: 'Linus', department: 'Operations' },
+]
+const columns = [
+  { field: 'name', header: 'Name', width: 150 },
+  { field: 'department', header: 'Department', width: 180 },
+]
+const features = tableFeatures({ rowSortingFeature, columnGroupingFeature, rowExpandingFeature })
+
+function baseProps(extra: Record<string, unknown>): Record<string, unknown> {
+  return {
+    data: rows,
+    columns,
+    features,
+    _rowModels: {
+      coreRowModel: createCoreRowModel(),
+      filteredRowModel: createFilteredRowModel(),
+      sortedRowModel: createSortedRowModel(sortFns),
+      groupedRowModel: createGroupedRowModel(),
+      expandedRowModel: createExpandedRowModel(),
+      paginatedRowModel: createPaginatedRowModel(),
+    },
+    containerHeight: 480,
+    virtualization: false,
+    ...extra,
+  }
+}
+
+describe('groupBy reactivity', () => {
+  it('re-groups when the prop is reassigned, and ungroups when emptied', () => {
+    const target = document.createElement('div')
+    document.body.appendChild(target)
+    let api: SvGridApi<typeof features, Row> | null = null
+    const props = $state(
+      baseProps({
+        groupBy: ['department'],
+        onApiReady: (next: SvGridApi<typeof features, Row>) => (api = next),
+      }),
+    )
+    const app = mount(SvGrid, { target, props: props as never })
+    flushSync()
+    expect(api!.getState().grouping).toEqual(['department'])
+
+    props.groupBy = ['name']
+    flushSync()
+    expect(api!.getState().grouping).toEqual(['name'])
+
+    props.groupBy = []
+    flushSync()
+    expect(api!.getState().grouping).toEqual([])
+    expect(target.querySelectorAll('tbody tr').length).toBe(3) // flat again
+
+    unmount(app)
+    target.remove()
+  })
+})
+
+describe('expanded reactivity', () => {
+  it('opens and closes a group when the prop is reassigned', () => {
+    const target = document.createElement('div')
+    document.body.appendChild(target)
+    const props = $state(baseProps({ groupBy: ['department'], expanded: {} }))
+    const app = mount(SvGrid, { target, props: props as never })
+    flushSync()
+    expect(target.querySelectorAll('tbody tr').length).toBe(2) // two banners
+
+    props.expanded = {
+      group_department_Engineering: true,
+    }
+    flushSync()
+    expect(target.querySelectorAll('tbody tr').length).toBe(4) // + Ada, Grace
+
+    props.expanded = {}
+    flushSync()
+    expect(target.querySelectorAll('tbody tr').length).toBe(2)
+
+    unmount(app)
+    target.remove()
+  })
+
+  it('settles when a controlled parent echoes onExpandedChange back into the prop', () => {
+    const target = document.createElement('div')
+    document.body.appendChild(target)
+    let api: SvGridApi<typeof features, Row> | null = null
+    let notifications = 0
+    const props = $state(
+      baseProps({
+        groupBy: ['department'],
+        expanded: {} as Record<string, boolean>,
+        // The exact round-trip the docs recommend.
+        onExpandedChange: (next: Record<string, boolean>) => {
+          notifications += 1
+          props.expanded = next
+        },
+        onApiReady: (next: SvGridApi<typeof features, Row>) => (api = next),
+      }),
+    )
+    const app = mount(SvGrid, { target, props: props as never })
+    flushSync()
+    notifications = 0
+
+    api!.expandAllGroups()
+    flushSync()
+
+    // The echo must not re-seed and re-fire; one settled notification.
+    expect(notifications).toBe(1)
+    expect(props.expanded).toEqual({
+      group_department_Engineering: true,
+      group_department_Operations: true,
+    })
+    expect(target.querySelectorAll('tbody tr').length).toBe(5) // 2 banners + 3 leaves
+
+    api!.collapseAllGroups()
+    flushSync()
+    expect(notifications).toBe(2)
+    expect(target.querySelectorAll('tbody tr').length).toBe(2)
+
+    unmount(app)
+    target.remove()
+  })
+})