torch-glare 2.4.4 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/apps/lib/components/DataViews/{badgeAdapter.ts → badge.ts} +2 -2
  2. package/apps/lib/components/DataViews/cell.tsx +324 -0
  3. package/apps/lib/components/DataViews/context.ts +144 -0
  4. package/apps/lib/components/DataViews/data-views.tsx +383 -0
  5. package/apps/lib/components/DataViews/filters/children.tsx +98 -0
  6. package/apps/lib/components/DataViews/filters/custom.tsx +34 -0
  7. package/apps/lib/components/DataViews/filters/filters.tsx +163 -0
  8. package/apps/lib/components/DataViews/filters/index.ts +4 -0
  9. package/apps/lib/components/DataViews/filters/labelled.tsx +20 -0
  10. package/apps/lib/components/DataViews/filters/presets.tsx +65 -0
  11. package/apps/lib/components/DataViews/filters/summary.tsx +65 -0
  12. package/apps/lib/components/DataViews/filters/sync.tsx +35 -0
  13. package/apps/lib/components/DataViews/filters/values.ts +173 -0
  14. package/apps/lib/components/DataViews/header.tsx +217 -0
  15. package/apps/lib/components/DataViews/hooks/index.ts +5 -0
  16. package/apps/lib/components/DataViews/hooks/useActiveRow.ts +22 -0
  17. package/apps/lib/components/DataViews/hooks/useControllable.ts +52 -0
  18. package/apps/lib/components/DataViews/index.ts +74 -26
  19. package/apps/lib/components/DataViews/panel/columns.tsx +153 -0
  20. package/apps/lib/components/DataViews/panel/controls.tsx +106 -0
  21. package/apps/lib/components/DataViews/panel/index.ts +3 -0
  22. package/apps/lib/components/DataViews/panel/panel.tsx +164 -0
  23. package/apps/lib/components/DataViews/panel/saved-views.tsx +67 -0
  24. package/apps/lib/components/DataViews/panel/section.tsx +79 -0
  25. package/apps/lib/components/DataViews/panel/sort.tsx +42 -0
  26. package/apps/lib/components/DataViews/panel/tab.tsx +31 -0
  27. package/apps/lib/components/DataViews/slots.ts +63 -0
  28. package/apps/lib/components/DataViews/states.tsx +38 -0
  29. package/apps/lib/components/DataViews/types.ts +485 -178
  30. package/apps/lib/components/DataViews/views/board-view.tsx +379 -0
  31. package/apps/lib/components/DataViews/views/card-rows.tsx +36 -0
  32. package/apps/lib/components/DataViews/views/inbox-view.tsx +257 -0
  33. package/apps/lib/components/DataViews/views/pane-views.tsx +192 -0
  34. package/apps/lib/components/DataViews/views/table-view.tsx +426 -0
  35. package/apps/lib/components/DataViews/views/tree-view.tsx +365 -0
  36. package/apps/lib/components/FormBuilder/context.ts +20 -6
  37. package/apps/lib/components/FormBuilder/field-kind.ts +28 -0
  38. package/apps/lib/components/FormBuilder/fields/DateField.tsx +3 -3
  39. package/apps/lib/components/FormBuilder/fields/FieldShell.tsx +7 -6
  40. package/apps/lib/components/FormBuilder/fields/PhoneField.tsx +30 -4
  41. package/apps/lib/components/FormBuilder/fields/SelectField.tsx +7 -7
  42. package/apps/lib/components/FormBuilder/fields/TableField.tsx +80 -52
  43. package/apps/lib/components/FormBuilder/fields/TextField.tsx +9 -9
  44. package/apps/lib/components/FormBuilder/form-builder.tsx +66 -6
  45. package/apps/lib/components/FormBuilder/index.ts +3 -1
  46. package/apps/lib/components/FormBuilder/types.ts +40 -0
  47. package/apps/lib/components/Input.tsx +3 -0
  48. package/apps/lib/components/SearchableTable.tsx +5 -4
  49. package/apps/lib/components/SectionBlock.tsx +58 -11
  50. package/apps/lib/components/Select.tsx +3 -1
  51. package/apps/lib/components/TabSwitch.tsx +16 -4
  52. package/apps/lib/components/Table.tsx +265 -67
  53. package/apps/lib/components/TreeFolder/TreeFolder.tsx +6 -3
  54. package/apps/lib/components/TreeFolder/TreeFolderRow.tsx +16 -14
  55. package/apps/lib/components/TreeFolder/index.ts +1 -1
  56. package/apps/lib/components/TreeFolder/useTreeFolderDnD.ts +70 -207
  57. package/apps/lib/hooks/useDragDrop.tsx +365 -0
  58. package/apps/lib/hooks/useInfiniteScroll.ts +108 -0
  59. package/apps/lib/registry.json +159 -4
  60. package/apps/lib/tsconfig.tsbuildinfo +1 -1
  61. package/apps/lib/utils/dataViews/path.ts +67 -0
  62. package/apps/lib/utils/dataViews/query.ts +73 -0
  63. package/apps/lib/utils/dataViews/types.ts +187 -0
  64. package/docs/components/breadcrumb.md +1 -1
  65. package/docs/components/button-group.md +1 -1
  66. package/docs/components/button.md +1 -1
  67. package/docs/components/card.md +1 -1
  68. package/docs/components/checkbox.md +1 -1
  69. package/docs/components/data-views/backend-response.md +324 -0
  70. package/docs/components/data-views/examples/a11y-rtl.md +250 -0
  71. package/docs/components/data-views/examples/api-orders-route.md +130 -0
  72. package/docs/components/data-views/examples/fields.md +362 -0
  73. package/docs/components/data-views/examples/filters.md +308 -0
  74. package/docs/components/data-views/examples/inbox-routing.md +218 -0
  75. package/docs/components/data-views/examples/index.md +29 -0
  76. package/docs/components/data-views/examples/overview.md +244 -0
  77. package/docs/components/data-views/examples/panel.md +212 -0
  78. package/docs/components/data-views/examples/scale.md +231 -0
  79. package/docs/components/data-views/examples/server-side.md +210 -0
  80. package/docs/components/data-views/examples/state.md +250 -0
  81. package/docs/components/data-views/examples/tree-custom.md +388 -0
  82. package/docs/components/data-views/examples/view-registry.md +313 -0
  83. package/docs/components/data-views/examples/views.md +534 -0
  84. package/docs/components/data-views/guide.md +405 -0
  85. package/docs/components/data-views/index.md +1504 -0
  86. package/docs/components/data-views/migration.md +79 -0
  87. package/docs/components/date-picker.md +0 -1
  88. package/docs/components/form-builder.md +19 -8
  89. package/docs/components/form-renderer.md +2 -1
  90. package/docs/components/form.md +1 -1
  91. package/docs/components/input-field.md +1 -1
  92. package/docs/components/input-otp.md +1 -1
  93. package/docs/components/input.md +1 -1
  94. package/docs/components/labeled-check-box.md +1 -1
  95. package/docs/components/labeled-radio.md +1 -1
  96. package/docs/components/radio-card.md +1 -1
  97. package/docs/components/radio.md +1 -1
  98. package/docs/components/search-field.md +1 -1
  99. package/docs/components/section-block.md +79 -3
  100. package/docs/components/select.md +1 -1
  101. package/docs/components/simple-select.md +1 -1
  102. package/docs/components/switch.md +1 -1
  103. package/docs/components/tab-switch.md +1 -1
  104. package/docs/components/table.md +45 -8
  105. package/docs/components/text-editor.md +1 -1
  106. package/docs/components/textarea.md +1 -1
  107. package/docs/components/toggle-button.md +1 -1
  108. package/docs/components/toggle.md +1 -1
  109. package/docs/components/tree-folder.md +110 -0
  110. package/docs/how-to/forms-with-form-builder.md +6 -4
  111. package/docs/reference/components.md +16 -6
  112. package/docs/tutorials/component-composition.md +11 -13
  113. package/package.json +3 -2
  114. package/apps/lib/components/DataViews/DataViewRadio.tsx +0 -49
  115. package/apps/lib/components/DataViews/DataViewsConfigPanel.tsx +0 -393
  116. package/apps/lib/components/DataViews/DataViewsHeader.tsx +0 -207
  117. package/apps/lib/components/DataViews/DataViewsLayout.tsx +0 -332
  118. package/apps/lib/components/DataViews/FilterPanel.tsx +0 -493
  119. package/apps/lib/components/DataViews/HeaderSearch.tsx +0 -93
  120. package/apps/lib/components/DataViews/InboxView.tsx +0 -463
  121. package/apps/lib/components/DataViews/InboxViewCard.tsx +0 -127
  122. package/apps/lib/components/DataViews/KanbanView.tsx +0 -336
  123. package/apps/lib/components/DataViews/PanelControls.tsx +0 -39
  124. package/apps/lib/components/DataViews/SettingsPanel.tsx +0 -279
  125. package/apps/lib/components/DataViews/TableView.tsx +0 -212
  126. package/apps/lib/components/DataViews/TreeView.tsx +0 -364
  127. package/apps/lib/components/DataViews/fieldRenderers.tsx +0 -299
  128. package/apps/lib/components/DataViews/filters/DatePickerRangeFilter.tsx +0 -87
  129. package/apps/lib/components/DataViews/filters/DateRangePopover.tsx +0 -120
  130. package/apps/lib/components/DataViews/filters/PresetChips.tsx +0 -45
  131. package/apps/lib/components/DataViews/filters/RangeSliderWithInputs.tsx +0 -165
  132. package/apps/lib/components/DataViews/tree/TreeDrawer.tsx +0 -50
  133. package/apps/lib/components/DataViews/tree/TreeSidebar.tsx +0 -74
  134. package/apps/lib/hooks/useDataViewsState.ts +0 -175
  135. package/apps/lib/utils/dataViews/columnUtils.ts +0 -132
  136. package/apps/lib/utils/dataViews/fieldUtils.ts +0 -197
  137. package/apps/lib/utils/dataViews/nestedDataUtils.tsx +0 -371
  138. package/apps/lib/utils/dataViews/pathUtils.ts +0 -139
  139. package/apps/lib/utils/dataViews/rangeUtils.ts +0 -234
  140. package/apps/lib/utils/dataViews/treeUtils.ts +0 -396
  141. package/docs/components/data-views-config-panel.md +0 -208
  142. package/docs/components/data-views-layout.md +0 -291
  143. package/docs/components/inbox-view.md +0 -170
  144. package/docs/components/kanban-view.md +0 -135
  145. package/docs/components/table-view.md +0 -141
  146. package/docs/components/tree-view.md +0 -147
  147. package/docs/how-to/data-views-from-backend-response.md +0 -194
@@ -0,0 +1,212 @@
1
+ ---
2
+ title: DataViews example — Panel
3
+ description: The settings rail: saved views, columns, sort — and the pane-mode round trip.
4
+ group: examples
5
+ component: DataViews
6
+ keywords: [data-views, example, examples, panel]
7
+ ---
8
+
9
+ # DataViews example — Panel
10
+
11
+ The settings rail: saved views, columns, sort — and the pane-mode round trip.
12
+
13
+ Complete and runnable — this is the page itself, not an excerpt. In the monorepo it lives at `apps/app/data-views/panel/page.tsx`.
14
+
15
+ See the [component reference](../index.md) for what each prop does, or the [guide](../guide.md) for the same ground as scenarios.
16
+
17
+ ```tsx
18
+ "use client";
19
+
20
+ import { useMemo, useState } from "react";
21
+ import { useInfiniteQuery } from "@tanstack/react-query";
22
+ import { Filter, Settings } from "lucide-react";
23
+ import { DataViews, emptyQuery, queryToParams, type SavedView } from "@/components/DataViews";
24
+ import { FormBuilder } from "@/components/FormBuilder";
25
+ import type {
26
+ DataViewsQuery,
27
+ FieldConfig,
28
+ Row,
29
+ RowGroup,
30
+ TreeNode,
31
+ } from "@/utils/dataViews/types";
32
+
33
+ // ─── How the rows are painted ─────────────────────────────────────────────────
34
+
35
+ interface Order extends Row {
36
+ id: number;
37
+ customer: { name: string };
38
+ status: "Pending" | "Shipped" | "Delivered";
39
+ priority: "High" | "Medium" | "Low";
40
+ total: number;
41
+ createdAt: string;
42
+ }
43
+
44
+ const FIELDS: FieldConfig[] = [
45
+ { path: "id", label: "Order #", type: "number" },
46
+ { path: "customer.name", label: "Customer", type: "text" },
47
+ { path: "brand.name", label: "Brand", type: "text" },
48
+ { path: "status", label: "Status", type: "enum-badge", variants: { Pending: "yellow", Shipped: "blue", Delivered: "green" } },
49
+ { path: "priority", label: "Priority", type: "enum-badge", variants: { High: "redOrange", Medium: "purple", Low: "gray" } },
50
+ { path: "total", label: "Total", type: "currency", currency: "USD" },
51
+ { path: "createdAt", label: "Created", type: "date-format", dateFormat: "YYYY-MM-DD" },
52
+ ];
53
+
54
+ /** Dynamic sets — in a real app these come from the endpoint that also does the filtering. */
55
+ const CUSTOMER_OPTIONS = [
56
+ "Acme Inc.", "Globex Corp.", "Initech", "Umbrella",
57
+ "Hooli", "Stark Industries", "Wayne Enterprises", "Cyberdyne",
58
+ ].map((v) => ({ label: v, value: v }));
59
+
60
+ const BRAND_OPTIONS = ["Bosch", "Makita", "DeWalt", "Hilti"].map((v) => ({ label: v, value: v }));
61
+
62
+ const PRIORITY_OPTIONS = ["High", "Medium", "Low"].map((v) => ({ label: v, value: v }));
63
+
64
+ const STATUS_OPTIONS = [
65
+ { label: "Pending", value: "Pending" },
66
+ { label: "Shipped", value: "Shipped" },
67
+ { label: "Delivered", value: "Delivered" },
68
+ ];
69
+
70
+ /** The request this page makes. The querying happens in `app/api/orders/route.ts`. */
71
+ async function fetchOrders(q: DataViewsQuery): Promise<{ rows: Order[]; total: number }> {
72
+ const params = queryToParams(q);
73
+ const res = await fetch(`/api/orders?${params}`);
74
+ if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);
75
+ return res.json();
76
+ }
77
+
78
+ const groupByStatus = (rows: readonly Order[]): RowGroup[] =>
79
+ (["Pending", "Shipped", "Delivered"] as const).map((status) => ({
80
+ id: status,
81
+ label: status,
82
+ color: ({ Pending: "gray", Shipped: "blue", Delivered: "green" } as const)[status],
83
+ rows: rows.filter((row) => row.status === status),
84
+ }));
85
+
86
+ const nodesFromRows = (rows: readonly Order[]): TreeNode[] =>
87
+ rows.map((row) => ({ id: String(row.id), row, depth: 0, children: [] }));
88
+
89
+ // ─── Page ─────────────────────────────────────────────────────────────────────
90
+
91
+ /**
92
+ * The rail: columns, sort and saved views, in tabs that exist because they are rendered.
93
+ *
94
+ * **None of what the rail edits is this page's business.** Column order and visibility, which tab
95
+ * is open, whether the rail is open at all — those change the picture and nothing else, so the
96
+ * component holds them. That is why there are two `useState`s here: the query, and the saved views
97
+ * the app persists.
98
+ *
99
+ * Hiding `Customer` retitles the board's cards and the tree's nodes too: `columns` resolves to the
100
+ * ordered `visibleFields` every view paints from, so it is shared by construction.
101
+ *
102
+ * **Saved views are the exception that proves the rule.** Persisting one is the app's job — it
103
+ * outlives the component — so `onSave` hands over a snapshot to store. Restoring is *not*: hand the
104
+ * snapshot back in `views` and selecting it puts the columns, sort and filters back internally. The
105
+ * blob is opaque here on purpose.
106
+ */
107
+ export default function PanelExample() {
108
+ const [query, setQuery] = useState(emptyQuery());
109
+ const [saved, setSaved] = useState<SavedView[]>([]);
110
+
111
+ // The tree pane's shape, seeded from storage and written back on every switch. `defaultPaneMode`
112
+ // is read once — the view holds the mode from then on — so this reads the store lazily rather
113
+ // than in an effect, which would seed `"table"` for a frame and then flip.
114
+ const [paneMode] = useState<"table" | "cards">(() =>
115
+ (typeof window !== "undefined" && localStorage.getItem("panel-pane-mode")) === "cards"
116
+ ? "cards"
117
+ : "table",
118
+ );
119
+
120
+ const { data, isPending, fetchNextPage, isFetchingNextPage } = useInfiniteQuery({
121
+ queryKey: ["panel-orders", { ...query, page: undefined }],
122
+ queryFn: ({ pageParam }) => fetchOrders({ ...query, page: pageParam }),
123
+ initialPageParam: 1,
124
+ // Undefined means "no more" — which is what the component's `hasMore` resolves to.
125
+ getNextPageParam: (last, pages) => {
126
+ const loaded = pages.reduce((n, page) => n + page.rows.length, 0);
127
+ return loaded < last.total ? pages.length + 1 : undefined;
128
+ },
129
+ });
130
+
131
+ // Memoised because `data?.rows ?? []` is a new array on every render, which would make the
132
+ // `groups`/`nodes` memos below miss every time and hand the board a new array to diff.
133
+ const rows = useMemo(() => data?.pages.flatMap((page) => page.rows) ?? [], [data]);
134
+ const total = data?.pages[0]?.total ?? 0;
135
+ const groups = useMemo(() => groupByStatus(rows), [rows]);
136
+ const nodes = useMemo(() => nodesFromRows(rows), [rows]);
137
+
138
+ return (
139
+ <div className="flex h-full min-h-0 flex-col p-4">
140
+ <DataViews
141
+ rows={rows}
142
+ fields={FIELDS}
143
+ total={total}
144
+ loading={isPending}
145
+ onLoadMore={fetchNextPage}
146
+ loadingMore={isFetchingNextPage}
147
+ onQueryChange={setQuery}
148
+ defaultPanelOpen
149
+ className="h-full"
150
+ >
151
+ <DataViews.Header title="Orders">
152
+ <DataViews.ViewSwitch />
153
+ <DataViews.Search />
154
+ <DataViews.PanelToggle />
155
+ </DataViews.Header>
156
+
157
+ <DataViews.Table />
158
+ <DataViews.Board groups={groups} titlePath="customer.name" />
159
+ <DataViews.Tree
160
+ nodes={nodes}
161
+ labelPath="customer.name"
162
+ defaultPaneMode={paneMode}
163
+ onPaneModeChange={(mode) => localStorage.setItem("panel-pane-mode", mode)}
164
+ >
165
+ <DataViews.Tree.Table />
166
+ <DataViews.Tree.Cards />
167
+ </DataViews.Tree>
168
+
169
+ <DataViews.Panel>
170
+ <DataViews.Panel.Tab value="config" label="Config." icon={<Settings />}>
171
+ <DataViews.Panel.SavedViews
172
+ views={saved}
173
+ onSave={(snapshot) =>
174
+ setSaved((prev) => [
175
+ ...prev,
176
+ { id: `view-${prev.length + 1}`, label: `View ${prev.length + 1}`, snapshot },
177
+ ])
178
+ }
179
+ />
180
+ <DataViews.Panel.Columns />
181
+ <DataViews.Panel.Sort />
182
+ </DataViews.Panel.Tab>
183
+
184
+ <DataViews.Panel.Tab value="filters" label="Filters" icon={<Filter />}>
185
+ <DataViews.Filters title={null} className="border-b-0 p-0">
186
+ {/* One control per section type. Which one a field gets is decided by the data:
187
+ can the option set grow, and can the user pick more than one. */}
188
+ <FormBuilder.CheckboxGroup name="status" label="Status" options={STATUS_OPTIONS} />
189
+ <FormBuilder.RadioList name="priority" label="Priority" options={PRIORITY_OPTIONS} />
190
+ <FormBuilder.SearchableSelect
191
+ name="customer.name"
192
+ label="Customer"
193
+ options={CUSTOMER_OPTIONS}
194
+ />
195
+ <FormBuilder.MultiSelect name="brand.name" label="Brand" options={BRAND_OPTIONS} />
196
+ <FormBuilder.Slider name="total" label="Total" range min={0} max={15000} step={100} />
197
+ <FormBuilder.DateRange name="createdAt" label="Created" />
198
+ </DataViews.Filters>
199
+ </DataViews.Panel.Tab>
200
+
201
+ {/* Not inside a Tab, so it renders under whichever one is open. */}
202
+ <div className="border-border-presentation-global-primary mt-auto border-t pt-2">
203
+ <span className="typography-body-small-regular text-content-presentation-global-secondary">
204
+ Shown on every tab.
205
+ </span>
206
+ </div>
207
+ </DataViews.Panel>
208
+ </DataViews>
209
+ </div>
210
+ );
211
+ }
212
+ ```
@@ -0,0 +1,231 @@
1
+ ---
2
+ title: DataViews example — Scale
3
+ description: Virtualization and scroll loading at size.
4
+ group: examples
5
+ component: DataViews
6
+ keywords: [data-views, example, examples, scale]
7
+ ---
8
+
9
+ # DataViews example — Scale
10
+
11
+ Virtualization and scroll loading at size.
12
+
13
+ Complete and runnable — this is the page itself, not an excerpt. In the monorepo it lives at `apps/app/data-views/scale/page.tsx`.
14
+
15
+ See the [component reference](../index.md) for what each prop does, or the [guide](../guide.md) for the same ground as scenarios.
16
+
17
+ ```tsx
18
+ "use client";
19
+
20
+ import { useMemo, useState } from "react";
21
+ import { useInfiniteQuery } from "@tanstack/react-query";
22
+ import { Filter, Settings } from "lucide-react";
23
+ import { Button } from "@/components/Button";
24
+ import { DataViews, emptyQuery, queryToParams, type SavedView } from "@/components/DataViews";
25
+ import { FormBuilder } from "@/components/FormBuilder";
26
+ import type {
27
+ DataViewsQuery,
28
+ FieldConfig,
29
+ Row,
30
+ } from "@/utils/dataViews/types";
31
+
32
+ // ─── How the two datasets are painted ─────────────────────────────────────────
33
+
34
+ /**
35
+ * The rows themselves are generated and paged by `app/api/scale/route.ts`. What stays here is how
36
+ * to paint them — that is presentation, and it is the same whether one row comes back or a
37
+ * thousand.
38
+ */
39
+ const ROW_FIELDS: FieldConfig[] = [
40
+ { path: "reference", label: "Reference", type: "text" },
41
+ { path: "customer", label: "Customer", type: "text" },
42
+ { path: "status", label: "Status", type: "enum-badge", variants: { Pending: "yellow", Shipped: "blue", Delivered: "green" } },
43
+ { path: "priority", label: "Priority", type: "enum-badge", variants: { High: "redOrange", Medium: "purple", Low: "gray" } },
44
+ { path: "total", label: "Total", type: "currency", currency: "USD" },
45
+ { path: "items", label: "Items", type: "number" },
46
+ { path: "progress", label: "Progress", type: "progress-bar", max: 100, thresholds: [30, 80] },
47
+ { path: "createdAt", label: "Created", type: "date-format", dateFormat: "YYYY-MM-DD" },
48
+ ];
49
+
50
+ /** Forty columns, generated — hand-writing them guarantees one ends up subtly different. */
51
+ const WIDE_FIELDS: FieldConfig[] = Array.from({ length: 40 }, (_, i) => ({
52
+ path: `col${i}`,
53
+ label: i % 5 === 0 ? `Column ${i} with a deliberately long header label` : `Column ${i}`,
54
+ type: "text" as const,
55
+ }));
56
+
57
+ /** Generated data, so the option sets are the generator's own vocabulary. */
58
+ const PRIORITY_OPTIONS = ["High", "Medium", "Low"].map((v) => ({ label: v, value: v }));
59
+ const CUSTOMER_OPTIONS = ["Acme", "Globex", "Initech", "Umbrella", "Hooli", "Soylent", "Stark", "Wayne", "Cyberdyne"]
60
+ .flatMap((c) => ["Inc.", "Ltd", "SA", "GmbH", "BV"].map((sfx) => `${c} ${sfx}`))
61
+ .map((v) => ({ label: v, value: v }));
62
+
63
+ const STATUS_OPTIONS = [
64
+ { label: "Pending", value: "Pending" },
65
+ { label: "Shipped", value: "Shipped" },
66
+ { label: "Delivered", value: "Delivered" },
67
+ ];
68
+
69
+ // ─── The request ──────────────────────────────────────────────────────────────
70
+
71
+ /**
72
+ * The request this page makes. Generating, filtering, sorting and paging all happen in
73
+ * `app/api/scale/route.ts`.
74
+ *
75
+ * This is the case where the two large-dataset answers both show up. Rows arrive a page at a time
76
+ * as you scroll — `useInfiniteQuery` accumulates them and the component only ever paints what it
77
+ * was handed — and once enough have accumulated the table virtualises, so the DOM holds a window
78
+ * of rows rather than all of them.
79
+ */
80
+ async function fetchScale(q: DataViewsQuery & {
81
+ shape: "rows" | "wide";
82
+ count: number;
83
+ }): Promise<{ rows: Row[]; total: number }> {
84
+ const params = queryToParams(q);
85
+ params.set("shape", q.shape);
86
+ params.set("count", String(q.count));
87
+ const res = await fetch(`/api/scale?${params}`);
88
+ if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);
89
+ return res.json();
90
+ }
91
+
92
+ /**
93
+ * This example starts bigger than the default ten, and a hundred at a time is enough that a few
94
+ * scrolls carry it past the table's virtualization threshold — which is the thing this page is
95
+ * here to exercise. The same object seeds the page's state and the component's, because two
96
+ * literals saying "100" is precisely how they come to disagree.
97
+ */
98
+ const INITIAL_QUERY = emptyQuery({ pageSize: 100 });
99
+
100
+ // ─── Page ─────────────────────────────────────────────────────────────────────
101
+
102
+ /**
103
+ * The two axes that hurt.
104
+ *
105
+ * **Rows.** There is no virtualisation: every row handed in is rendered. With the endpoint paging,
106
+ * that is fifty at a time no matter how large the table gets — which is what the component was
107
+ * built for. Set the page size to 500 and you can feel the difference the paging was making.
108
+ *
109
+ * **Columns.** Forty of them scroll inside the view rather than growing the page, cells do not
110
+ * truncate, and the rail's column list carries all forty. Paging does nothing for this axis.
111
+ */
112
+ export default function ScaleExample() {
113
+ const [kase, setCase] = useState<"rows" | "columns">("rows");
114
+ const [count, setCount] = useState(1000);
115
+ const [narrow, setNarrow] = useState(false);
116
+
117
+ const [query, setQuery] = useState(INITIAL_QUERY);
118
+ const [saved, setSaved] = useState<SavedView[]>([]);
119
+
120
+ const wideCase = kase === "columns";
121
+ const shape = wideCase ? "wide" : "rows";
122
+
123
+ const { data, isPending, fetchNextPage, isFetchingNextPage } = useInfiniteQuery({
124
+ // `shape` and `count` are part of the question, so switching case or size refetches rather
125
+ // than handing back a cached answer to a different one. `page` is deliberately *not* in the
126
+ // key — it is what `pageParam` drives, and keying on it would throw the accumulation away on
127
+ // every load.
128
+ queryKey: ["scale", { ...query, page: undefined, shape, count }],
129
+ initialPageParam: 1,
130
+ queryFn: ({ pageParam }) => fetchScale({ ...query, page: pageParam, shape, count }),
131
+ // Undefined means "no more", which is what `hasMore` on the component resolves to.
132
+ getNextPageParam: (last, pages) => {
133
+ const loaded = pages.reduce((n, page) => n + page.rows.length, 0);
134
+ return loaded < last.total ? pages.length + 1 : undefined;
135
+ },
136
+ });
137
+
138
+ // The component is handed every row loaded so far, in order. Accumulating is the app's job —
139
+ // DataViews paints what it is given and asks for more when the user reaches the end.
140
+ const rows = useMemo(() => data?.pages.flatMap((page) => page.rows) ?? [], [data]);
141
+ const total = data?.pages[0]?.total ?? 0;
142
+
143
+ return (
144
+ <div className="flex h-full min-h-0 flex-col p-4">
145
+ <div className={narrow && wideCase ? "flex min-h-0 w-[320px] flex-1" : "flex min-h-0 flex-1"}>
146
+ <DataViews
147
+ // Remounting per case keeps columns and filters from leaking between datasets.
148
+ key={kase}
149
+ rows={rows}
150
+ fields={wideCase ? WIDE_FIELDS : ROW_FIELDS}
151
+ total={total}
152
+ loading={isPending}
153
+ onLoadMore={fetchNextPage}
154
+ loadingMore={isFetchingNextPage}
155
+ onQueryChange={setQuery}
156
+ defaultQuery={INITIAL_QUERY}
157
+ className="h-full"
158
+ >
159
+ <DataViews.Header title={wideCase ? "Wide" : `${total.toLocaleString("en-US")} rows`}>
160
+ <DataViews.ViewSwitch />
161
+ <DataViews.Search />
162
+ <DataViews.Actions>
163
+ <Button variant="BluColStyle" size="M" onClick={() => setCase("rows")}>
164
+ 1,000 rows
165
+ </Button>
166
+ <Button variant="BluColStyle" size="M" onClick={() => setCase("columns")}>
167
+ 40 columns
168
+ </Button>
169
+ {!wideCase &&
170
+ [100, 1000].map((n) => (
171
+ <Button variant="BluColStyle"
172
+ size="M"
173
+ key={n}
174
+ onClick={() => setCount(n)}
175
+ >
176
+ {n.toLocaleString("en-US")}
177
+ </Button>
178
+ ))}
179
+ {wideCase && (
180
+ <Button variant="BluColStyle" size="M" onClick={() => setNarrow((v) => !v)}>
181
+ {narrow ? "Full width" : "Squeeze"}
182
+ </Button>
183
+ )}
184
+ </DataViews.Actions>
185
+ <DataViews.PanelToggle />
186
+ </DataViews.Header>
187
+
188
+ <DataViews.Table />
189
+
190
+ {/* `total` is the filtered count from the endpoint — the component holds fifty rows and
191
+ could not work out that there are 1,000. */}
192
+
193
+ <DataViews.Panel>
194
+ <DataViews.Panel.Tab value="config" label="Config." icon={<Settings />}>
195
+ {/* Saving is the app's job — a view outlives the component. Restoring is not:
196
+ hand the snapshot back and selecting it puts everything back internally. */}
197
+ <DataViews.Panel.SavedViews
198
+ views={saved}
199
+ onSave={(snapshot) =>
200
+ setSaved((prev) => [
201
+ ...prev,
202
+ { id: `view-${prev.length + 1}`, label: `View ${prev.length + 1}`, snapshot },
203
+ ])
204
+ }
205
+ />
206
+ <DataViews.Panel.Columns />
207
+ <DataViews.Panel.Sort />
208
+ </DataViews.Panel.Tab>
209
+
210
+ <DataViews.Panel.Tab value="filters" label="Filters" icon={<Filter />}>
211
+ {/* The two cases offer different columns, so they offer different filters. */}
212
+ <DataViews.Filters
213
+ title={null}
214
+ className="border-b-0 p-0"
215
+ >
216
+ {/* The same section types, over this page's own fields. There is no second dynamic
217
+ categorical here, so the searchable single-select has nothing to bind to. */}
218
+ <FormBuilder.CheckboxGroup name="status" label="Status" options={STATUS_OPTIONS} />
219
+ <FormBuilder.RadioList name="priority" label="Priority" options={PRIORITY_OPTIONS} />
220
+ <FormBuilder.MultiSelect name="customer" label="Customer" options={CUSTOMER_OPTIONS} />
221
+ <FormBuilder.Slider name="total" label="Total" range min={0} max={25000} step={500} />
222
+ <FormBuilder.DateRange name="createdAt" label="Created" />
223
+ </DataViews.Filters>
224
+ </DataViews.Panel.Tab>
225
+ </DataViews.Panel>
226
+ </DataViews>
227
+ </div>
228
+ </div>
229
+ );
230
+ }
231
+ ```
@@ -0,0 +1,210 @@
1
+ ---
2
+ title: DataViews example — Server-side
3
+ description: `queryToParams` on the way out, `parseQuery` on the way in.
4
+ group: examples
5
+ component: DataViews
6
+ keywords: [data-views, example, examples, server, side]
7
+ ---
8
+
9
+ # DataViews example — Server-side
10
+
11
+ `queryToParams` on the way out, `parseQuery` on the way in.
12
+
13
+ Complete and runnable — this is the page itself, not an excerpt. In the monorepo it lives at `apps/app/data-views/server-side/page.tsx`.
14
+
15
+ See the [component reference](../index.md) for what each prop does, or the [guide](../guide.md) for the same ground as scenarios.
16
+
17
+ ```tsx
18
+ "use client";
19
+
20
+ import { useMemo, useState } from "react";
21
+ import { useInfiniteQuery } from "@tanstack/react-query";
22
+ import { Filter, Settings } from "lucide-react";
23
+ import { Button } from "@/components/Button";
24
+ import { DataViews, emptyQuery, queryToParams, type SavedView } from "@/components/DataViews";
25
+ import { FormBuilder } from "@/components/FormBuilder";
26
+ import type {
27
+ DataViewsQuery,
28
+ FieldConfig,
29
+ Row,
30
+ } from "@/utils/dataViews/types";
31
+
32
+ // ─── Data ─────────────────────────────────────────────────────────────────────
33
+
34
+ interface Order extends Row {
35
+ id: number;
36
+ customer: { name: string };
37
+ status: "Pending" | "Shipped" | "Delivered";
38
+ total: number;
39
+ createdAt: string;
40
+ }
41
+
42
+ const FIELDS: FieldConfig[] = [
43
+ { path: "id", label: "Order #", type: "number" },
44
+ { path: "customer.name", label: "Customer", type: "text" },
45
+ { path: "brand.name", label: "Brand", type: "text" },
46
+ { path: "status", label: "Status", type: "enum-badge", variants: { Pending: "yellow", Shipped: "blue", Delivered: "green" } },
47
+ { path: "total", label: "Total", type: "currency", currency: "USD" },
48
+ { path: "createdAt", label: "Created", type: "date-format", dateFormat: "YYYY-MM-DD" },
49
+ ];
50
+
51
+ /** Dynamic sets — in a real app these come from the endpoint that also does the filtering. */
52
+ const CUSTOMER_OPTIONS = [
53
+ "Acme Inc.", "Globex Corp.", "Initech", "Umbrella",
54
+ "Hooli", "Stark Industries", "Wayne Enterprises", "Cyberdyne",
55
+ ].map((v) => ({ label: v, value: v }));
56
+
57
+ const BRAND_OPTIONS = ["Bosch", "Makita", "DeWalt", "Hilti"].map((v) => ({ label: v, value: v }));
58
+
59
+ const PRIORITY_OPTIONS = ["High", "Medium", "Low"].map((v) => ({ label: v, value: v }));
60
+
61
+ const STATUS_OPTIONS = [
62
+ { label: "Pending", value: "Pending" },
63
+ { label: "Shipped", value: "Shipped" },
64
+ { label: "Delivered", value: "Delivered" },
65
+ ];
66
+
67
+ /**
68
+ * The request this page makes. The querying itself happens in `app/api/orders/route.ts` —
69
+ * nothing on this page filters, sorts or pages anything, which is the split DataViews is built
70
+ * around.
71
+ */
72
+ async function fetchOrders(q: DataViewsQuery & { fail: boolean }): Promise<{ rows: Order[]; total: number }> {
73
+ const params = queryToParams(q);
74
+ // The endpoint answers 502 for this — the failure is server-side, as it would be.
75
+ if (q.fail) params.set("fail", "1");
76
+ const res = await fetch(`/api/orders?${params}`);
77
+ if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);
78
+ return res.json();
79
+ }
80
+
81
+ // ─── Page ─────────────────────────────────────────────────────────────────────
82
+
83
+ /**
84
+ * The shape the component is built for: filters, search and sort are three callbacks that trigger
85
+ * one query, and nothing on screen changes until the response lands.
86
+ *
87
+ * The query key carries the whole query, so TanStack refetches when any part of it changes and
88
+ * discards a response that has been superseded — the out-of-order problem you would otherwise
89
+ * solve by hand with a request counter.
90
+ *
91
+ * ` keepPreviousData` is what makes it feel right: the previous rows stay while
92
+ * the next query runs, instead of the table emptying on every keystroke. `isPending` is true only
93
+ * for the very first load, which is why the skeletons appear once and not on every refetch.
94
+ *
95
+ * There is no `DataViews.Error` — an error is an ordinary child, rendered above the view so the
96
+ * header and rail stay usable while the request is broken. Filter changes are already debounced
97
+ * ~200ms inside `Filters`; sorting and searching are not, so add your own if the endpoint is
98
+ * expensive.
99
+ */
100
+ export default function ServerSideExample() {
101
+ const [query, setQuery] = useState(emptyQuery());
102
+ const [saved, setSaved] = useState<SavedView[]>([]);
103
+
104
+ const [failNext, setFailNext] = useState(false);
105
+
106
+
107
+ const { data, isPending, error, fetchNextPage, isFetchingNextPage } = useInfiniteQuery({
108
+ // `failNext` belongs in the key: flipping it asks a different question of the endpoint, and
109
+ // without it the cached answer would come straight back unchanged.
110
+ queryKey: ["server-side-orders", { ...query, page: undefined, failNext }],
111
+ queryFn: ({ pageParam }) => fetchOrders({ ...query, page: pageParam, fail: failNext }),
112
+ initialPageParam: 1,
113
+ // Undefined means "no more" — which is what the component's `hasMore` resolves to.
114
+ getNextPageParam: (last, pages) => {
115
+ const loaded = pages.reduce((n, page) => n + page.rows.length, 0);
116
+ return loaded < last.total ? pages.length + 1 : undefined;
117
+ },
118
+ // A 502 here is the point of the example, not a blip to paper over.
119
+ retry: false,
120
+ });
121
+
122
+ const rows = useMemo(() => data?.pages.flatMap((page) => page.rows) ?? [], [data]);
123
+ const total = data?.pages[0]?.total ?? 0;
124
+
125
+ return (
126
+ <div className="flex h-full min-h-0 flex-col p-4">
127
+ <DataViews
128
+ rows={rows}
129
+ fields={FIELDS}
130
+ total={total}
131
+ loading={isPending}
132
+ onLoadMore={fetchNextPage}
133
+ loadingMore={isFetchingNextPage}
134
+ onQueryChange={setQuery}
135
+ className="h-full"
136
+ >
137
+ <DataViews.Header title="Orders">
138
+ <DataViews.ViewSwitch />
139
+ <DataViews.Search />
140
+ <DataViews.Actions>
141
+ <Button variant="BluColStyle"
142
+ size="M"
143
+ onClick={() => setFailNext((v) => !v)}
144
+ >
145
+ {failNext ? "Stop failing" : "Make it fail"}
146
+ </Button>
147
+ </DataViews.Actions>
148
+ <DataViews.PanelToggle />
149
+ </DataViews.Header>
150
+
151
+ {error && (
152
+ <div
153
+ data-testid="error"
154
+ className="typography-body-small-regular border-border-presentation-state-negative bg-background-presentation-state-negative-secondary text-content-presentation-global-primary m-4 flex items-center gap-2 rounded-[8px] border px-3 py-2"
155
+ >
156
+ <i className="ri-error-warning-line" aria-hidden />
157
+ Could not load orders — {error.message}
158
+ </div>
159
+ )}
160
+
161
+ <DataViews.Table />
162
+
163
+ <DataViews.Panel>
164
+ <DataViews.Panel.Tab value="config" label="Config." icon={<Settings />}>
165
+ {/* Saving is the app's job — a view outlives the component. Restoring is not:
166
+ hand the snapshot back and selecting it puts everything back internally. */}
167
+ {/* Saving is the app's job — a view outlives the component. Restoring is not:
168
+ hand the snapshot back and selecting it puts everything back internally. */}
169
+ <DataViews.Panel.SavedViews
170
+ views={saved}
171
+ onSave={(snapshot) =>
172
+ setSaved((prev) => [
173
+ ...prev,
174
+ { id: `view-${prev.length + 1}`, label: `View ${prev.length + 1}`, snapshot },
175
+ ])
176
+ }
177
+ />
178
+ <DataViews.Panel.Columns />
179
+ <DataViews.Panel.Sort />
180
+ </DataViews.Panel.Tab>
181
+
182
+ <DataViews.Panel.Tab value="filters" label="Filters" icon={<Filter />}>
183
+ {/* The controls are FormBuilder fields — the same Select and Slider any form in
184
+ this library uses. The <FormBuilder> itself lives inside Filters; you write only
185
+ its fields, and Filters reads each one's name, label and bounds to learn what
186
+ it is. */}
187
+ <DataViews.Filters
188
+ title={null}
189
+ className="border-b-0 p-0"
190
+ >
191
+ {/* One control per section type. Which one a field gets is decided by the data:
192
+ can the option set grow, and can the user pick more than one. */}
193
+ <FormBuilder.CheckboxGroup name="status" label="Status" options={STATUS_OPTIONS} />
194
+ <FormBuilder.RadioList name="priority" label="Priority" options={PRIORITY_OPTIONS} />
195
+ <FormBuilder.SearchableSelect
196
+ name="customer.name"
197
+ label="Customer"
198
+ options={CUSTOMER_OPTIONS}
199
+ />
200
+ <FormBuilder.MultiSelect name="brand.name" label="Brand" options={BRAND_OPTIONS} />
201
+ <FormBuilder.Slider name="total" label="Total" range min={0} max={15000} step={100} />
202
+ <FormBuilder.DateRange name="createdAt" label="Created" />
203
+ </DataViews.Filters>
204
+ </DataViews.Panel.Tab>
205
+ </DataViews.Panel>
206
+ </DataViews>
207
+ </div>
208
+ );
209
+ }
210
+ ```