-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdata-table-server-driven.stories.tsx
More file actions
434 lines (384 loc) · 14.1 KB
/
data-table-server-driven.stories.tsx
File metadata and controls
434 lines (384 loc) · 14.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
import type { Meta, StoryObj } from '@storybook/react';
import { useMemo } from 'react';
import { type LoaderFunctionArgs, useLoaderData, useSearchParams } from 'react-router';
import { columnConfigs, columns } from './data-table-stories.components';
import {
calculateFacetedCounts,
type DataResponse,
DataTable,
DataTableFilter,
dataTableRouterParsers,
filtersArraySchema,
getCoreRowModel,
getPaginationRowModel,
getSortedRowModel,
type MockIssue,
mockDatabase,
type OnChangeFn,
type PaginationState,
type SortingState,
useDataTableFilters,
useFilterSync,
useReactTable,
withReactRouterStubDecorator,
} from './data-table-stories.helpers';
import { testFiltering, testInitialRender, testPagination } from './data-table-stories.test-utils';
// --- Data Fetch Handler ---
const handleDataFetch = async ({ request }: LoaderFunctionArgs): Promise<DataResponse> => {
await new Promise((resolve) => setTimeout(resolve, 300)); // Simulate latency
const url = new URL(request.url);
const params = url.searchParams;
// Parse pagination, sorting, and filters from URL using helpers/schemas
const page = dataTableRouterParsers.page.parse(params.get('page')) ?? 0;
let pageSize = dataTableRouterParsers.pageSize.parse(params.get('pageSize')) ?? 10;
const sortField = params.get('sortField'); // Get raw string or null
const sortOrder = (params.get('sortOrder') || 'asc') as 'asc' | 'desc'; // 'asc' or 'desc'
const filtersParam = params.get('filters');
if (!pageSize || pageSize <= 0) {
pageSize = 10;
}
let parsedFilters: Array<{ type: string; columnId: string; values: unknown[] }> = [];
try {
if (filtersParam) {
// Parse and validate filters strictly according to Bazza v0.2 model
parsedFilters = filtersArraySchema.parse(JSON.parse(filtersParam));
}
} catch (error) {
console.error('[Loader] - Filter parsing/validation error:', error);
parsedFilters = [];
}
// --- Apply filtering, sorting, pagination ---
let processedData = [...mockDatabase];
// 1. Apply filters (support option and text types)
if (parsedFilters.length > 0) {
parsedFilters.forEach((filter) => {
processedData = processedData.filter((item) => {
switch (filter.type) {
case 'option': {
// Option filter: support multi-value (is any of)
if (Array.isArray(filter.values) && filter.values.length > 0) {
const value = item[filter.columnId as keyof MockIssue];
if (
typeof value === 'string' ||
typeof value === 'number' ||
typeof value === 'boolean' ||
value === null
) {
return filter.values.includes(value);
}
// If value is not a supported type (e.g., Date), skip filtering
return true;
}
return true;
}
case 'text': {
// Text filter: support contains
if (Array.isArray(filter.values) && filter.values.length > 0 && typeof filter.values[0] === 'string') {
const value = item[filter.columnId as keyof MockIssue];
return typeof value === 'string' && value.toLowerCase().includes(String(filter.values[0]).toLowerCase());
}
return true;
}
// Add more filter types as needed (number, date, etc.)
default:
return true;
}
});
});
}
// 2. Apply sorting
if (sortField && sortField in mockDatabase[0]) {
processedData.sort((a, b) => {
const aValue = a[sortField as keyof MockIssue];
const bValue = b[sortField as keyof MockIssue];
let comparison = 0;
if (aValue < bValue) comparison = -1;
if (aValue > bValue) comparison = 1;
return sortOrder === 'desc' ? comparison * -1 : comparison;
});
}
const totalItems = processedData.length;
const totalPages = Math.ceil(totalItems / pageSize);
// 3. Apply pagination
const start = page * pageSize;
const paginatedData = processedData.slice(start, start + pageSize);
// Calculate faceted counts based on the filtered data
const allDefinedOptions: Record<keyof MockIssue, { value: string; label: string }[] | undefined> = {
id: undefined,
title: undefined,
status: columnConfigs.find((c) => c.id === 'status')?.options,
assignee: columnConfigs.find((c) => c.id === 'assignee')?.options,
priority: columnConfigs.find((c) => c.id === 'priority')?.options,
createdDate: undefined,
estimatedHours: undefined,
};
const facetedColumns: Array<keyof MockIssue> = ['status', 'assignee', 'priority'];
const facetedCounts = calculateFacetedCounts(processedData, facetedColumns, allDefinedOptions);
const response: DataResponse = {
data: paginatedData,
meta: {
total: totalItems,
page: page,
pageSize: pageSize,
pageCount: totalPages,
},
facetedCounts: facetedCounts,
};
return response;
};
// --- Main Component ---
function DataTableWithBazzaFilters() {
// Get the loader data (filtered/paginated/sorted data from server)
const loaderData = useLoaderData<DataResponse>();
const [searchParams, setSearchParams] = useSearchParams();
// Initialize data from loader response
const data = loaderData?.data ?? [];
const pageCount = loaderData?.meta.pageCount ?? 0;
const facetedCounts = loaderData?.facetedCounts ?? {};
// Convert facetedCounts to the correct type for useDataTableFilters (Map-based)
const facetedOptionCounts = useMemo(() => {
const result: Partial<Record<string, Map<string, number>>> = {};
Object.entries(facetedCounts).forEach(([col, valueObj]) => {
result[col] = new Map(Object.entries(valueObj));
});
return result;
}, [facetedCounts]);
// --- Bazza UI Filter Setup ---
// 1. Initialize filters state with useFilterSync (syncs with URL)
const [filters, setFilters] = useFilterSync();
// --- Read pagination and sorting directly from URL ---
const pageIndex = Number.parseInt(searchParams.get('page') ?? '0', 10);
const pageSize = Number.parseInt(searchParams.get('pageSize') ?? '10', 10);
const sortField = searchParams.get('sortField');
const sortOrder = (searchParams.get('sortOrder') || 'asc') as 'asc' | 'desc';
// --- Pagination and Sorting State ---
const pagination = { pageIndex, pageSize };
const sorting = sortField ? [{ id: sortField, desc: sortOrder === 'desc' }] : [];
// --- Event Handlers: update URL directly ---
const handlePaginationChange: OnChangeFn<PaginationState> = (updaterOrValue) => {
const next = typeof updaterOrValue === 'function' ? updaterOrValue(pagination) : updaterOrValue;
searchParams.set('page', next.pageIndex.toString());
searchParams.set('pageSize', next.pageSize.toString());
setSearchParams(searchParams);
};
const handleSortingChange: OnChangeFn<SortingState> = (updaterOrValue) => {
const next = typeof updaterOrValue === 'function' ? updaterOrValue(sorting) : updaterOrValue;
if (next.length > 0) {
searchParams.set('sortField', next[0].id);
searchParams.set('sortOrder', next[0].desc ? 'desc' : 'asc');
} else {
searchParams.delete('sortField');
searchParams.delete('sortOrder');
}
setSearchParams(searchParams);
};
// --- Bazza UI Filter Setup ---
const bazzaProcessedColumns = useMemo(() => columnConfigs, []);
// Define a filter strategy (replace with your actual strategy if needed)
const filterStrategy = 'server' as const;
// Setup filter actions and strategy (controlled mode)
const {
columns: filterColumns,
actions,
strategy,
} = useDataTableFilters({
columnsConfig: bazzaProcessedColumns,
filters,
onFiltersChange: setFilters,
faceted: facetedOptionCounts,
strategy: filterStrategy,
data,
});
// --- TanStack Table Setup ---
const table = useReactTable({
data,
columns,
pageCount,
state: {
pagination,
sorting,
},
onPaginationChange: handlePaginationChange,
onSortingChange: handleSortingChange,
getCoreRowModel: getCoreRowModel(),
getPaginationRowModel: getPaginationRowModel(),
getSortedRowModel: getSortedRowModel(),
manualPagination: true,
manualSorting: true,
});
return (
<div className="space-y-4">
<div>
<h1 className="text-2xl font-bold mb-4">Issues Table (Bazza UI Server Filters via Loader)</h1>
<p className="text-gray-600 mb-6">
This demonstrates server-side filtering, pagination, and sorting with Bazza UI components and URL state
synchronization.
</p>
</div>
{/* Bazza UI Filter Interface */}
<DataTableFilter columns={filterColumns} filters={filters} actions={actions} strategy={strategy} />
{/* Data Table */}
<DataTable table={table} columns={columns.length} pageCount={pageCount} />
</div>
);
}
// --- Test Functions ---
const testInitialRenderServerSide = testInitialRender('Issues Table (Bazza UI Server Filters via Loader)');
const testPaginationServerSide = testPagination({ serverSide: true });
// --- Story Configuration ---
const meta: Meta<typeof DataTableWithBazzaFilters> = {
title: 'Data Table/Server Driven Filters',
component: DataTableWithBazzaFilters,
parameters: {
layout: 'fullscreen',
docs: {
description: {
component: 'Server-side filtering with Bazza UI components and URL state synchronization.',
},
},
},
tags: ['autodocs'],
};
export default meta;
type Story = StoryObj<typeof meta>;
export const ServerDriven: Story = {
args: {},
parameters: {
docs: {
description: {
story:
'Demonstrates server-side filtering (via loader), pagination, and sorting with Bazza UI components and URL state synchronization.',
},
source: {
code: `
import { useMemo } from 'react';
import { type LoaderFunctionArgs, useLoaderData, useSearchParams } from 'react-router';
import {
DataTable,
DataTableFilter,
useDataTableFilters,
useFilterSync,
useReactTable,
getCoreRowModel,
getPaginationRowModel,
getSortedRowModel,
} from './data-table-stories.helpers';
// --- Data Fetch Handler ---
const handleDataFetch = async ({ request }: LoaderFunctionArgs): Promise<DataResponse> => {
const url = new URL(request.url);
const params = url.searchParams;
// Parse pagination, sorting, and filters from URL
const page = dataTableRouterParsers.page.parse(params.get('page')) ?? 0;
const pageSize = dataTableRouterParsers.pageSize.parse(params.get('pageSize')) ?? 10;
const sortField = params.get('sortField');
const sortOrder = (params.get('sortOrder') || 'asc') as 'asc' | 'desc';
const filtersParam = params.get('filters');
// Parse filters
let parsedFilters = [];
try {
if (filtersParam) {
parsedFilters = filtersArraySchema.parse(JSON.parse(filtersParam));
}
} catch (error) {
console.error('Filter parsing error:', error);
}
// Apply filtering, sorting, pagination to data
let processedData = [...mockDatabase];
// Apply filters, sorting, and pagination logic here...
return {
data: paginatedData,
meta: { total, page, pageSize, pageCount },
facetedCounts,
};
};
function DataTableWithBazzaFilters() {
const loaderData = useLoaderData<DataResponse>();
const [searchParams, setSearchParams] = useSearchParams();
const data = loaderData?.data ?? [];
const pageCount = loaderData?.meta.pageCount ?? 0;
const facetedCounts = loaderData?.facetedCounts ?? {};
// --- Bazza UI Filter Setup ---
const [filters, setFilters] = useFilterSync();
// Read pagination and sorting from URL
const pageIndex = Number.parseInt(searchParams.get('page') ?? '0', 10);
const pageSize = Number.parseInt(searchParams.get('pageSize') ?? '10', 10);
const sortField = searchParams.get('sortField');
const sortOrder = (searchParams.get('sortOrder') || 'asc') as 'asc' | 'desc';
const pagination = { pageIndex, pageSize };
const sorting = sortField ? [{ id: sortField, desc: sortOrder === 'desc' }] : [];
// Event handlers update URL directly
const handlePaginationChange = (updaterOrValue) => {
const next = typeof updaterOrValue === 'function' ? updaterOrValue(pagination) : updaterOrValue;
searchParams.set('page', next.pageIndex.toString());
searchParams.set('pageSize', next.pageSize.toString());
setSearchParams(searchParams);
};
const handleSortingChange = (updaterOrValue) => {
const next = typeof updaterOrValue === 'function' ? updaterOrValue(sorting) : updaterOrValue;
if (next.length > 0) {
searchParams.set('sortField', next[0].id);
searchParams.set('sortOrder', next[0].desc ? 'desc' : 'asc');
} else {
searchParams.delete('sortField');
searchParams.delete('sortOrder');
}
setSearchParams(searchParams);
};
// Setup filter actions and strategy
const {
columns: filterColumns,
actions,
strategy,
} = useDataTableFilters({
columnsConfig: bazzaProcessedColumns,
filters,
onFiltersChange: setFilters,
faceted: facetedOptionCounts,
strategy: 'server',
data,
});
// TanStack Table Setup
const table = useReactTable({
data,
columns,
pageCount,
state: { pagination, sorting },
onPaginationChange: handlePaginationChange,
onSortingChange: handleSortingChange,
getCoreRowModel: getCoreRowModel(),
getPaginationRowModel: getPaginationRowModel(),
getSortedRowModel: getSortedRowModel(),
manualPagination: true,
manualSorting: true,
});
return (
<div className="space-y-4">
{/* Bazza UI Filter Interface */}
<DataTableFilter columns={filterColumns} filters={filters} actions={actions} strategy={strategy} />
{/* Data Table */}
<DataTable table={table} columns={columns.length} pageCount={pageCount} />
</div>
);
}`,
},
},
},
render: () => <DataTableWithBazzaFilters />,
decorators: [
withReactRouterStubDecorator({
routes: [
{
path: '/',
Component: DataTableWithBazzaFilters,
loader: handleDataFetch,
},
],
}),
],
play: async (context) => {
// Run the tests in sequence
await testInitialRenderServerSide(context);
await testPaginationServerSide(context);
await testFiltering(context);
},
};