Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,9 @@
"examples": "docs-src/components/data-table.docs.examples.tsx",
"sources": [
"packages/core/src/components/data-table/**",
"packages/core/src/components/internals/table-core/column-types.ts",
"packages/core/src/components/internals/table-core/cell-edit-error.ts",
"packages/core/src/components/internals/table-core/editing/date.tsx",
"packages/core/src/hooks/use-collection-variables.ts",
"packages/core/src/lib/collection-url-state.ts",
"packages/core/src/contexts/collection-control-context.tsx",
Expand Down Expand Up @@ -476,10 +479,10 @@
"withURLCollectionState"
],
"hashes": {
"typeSurface": "413c66caec0a0bf8",
"outline": "7591217822d0183b",
"typeSurface": "8ada983257d51646",
"outline": "1bcf784b4b500873",
"snapshot": "a97e067c66e46ef6",
"outputMd": "36bb587b7088fb1c",
"outputMd": "f0e28c3045e5bb2d",
"examples": "8adc119ac0d7152c"
}
},
Expand Down Expand Up @@ -1840,7 +1843,7 @@
"packages/core/skills/app-shell-patterns/references/components/combobox.md": "c79cd0fe175187e3",
"packages/core/skills/app-shell-patterns/references/components/command-palette.md": "7e5bc675a593791a",
"packages/core/skills/app-shell-patterns/references/components/csv-importer.md": "10c04c78bb846c9a",
"packages/core/skills/app-shell-patterns/references/components/data-table.md": "36bb587b7088fb1c",
"packages/core/skills/app-shell-patterns/references/components/data-table.md": "f0e28c3045e5bb2d",
"packages/core/skills/app-shell-patterns/references/components/date-picker.md": "376e7d4ad14c2934",
"packages/core/skills/app-shell-patterns/references/components/default-header.md": "375e55f4b12fa2be",
"packages/core/skills/app-shell-patterns/references/components/default-sidebar.md": "9b1672c71b6db3ff",
Expand Down
5 changes: 4 additions & 1 deletion docs-src/components/data-table.docs.outline.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ title: DataTable
description: Compound data table component with sortable columns, filter chips, cursor-based pagination, row actions, and multi-row selection
sources:
- packages/core/src/components/data-table/**
- packages/core/src/components/internals/table-core/column-types.ts
- packages/core/src/components/internals/table-core/cell-edit-error.ts
- packages/core/src/components/internals/table-core/editing/date.tsx
- packages/core/src/hooks/use-collection-variables.ts
- packages/core/src/lib/collection-url-state.ts
- packages/core/src/contexts/collection-control-context.tsx
Expand Down Expand Up @@ -41,8 +44,8 @@ import {
type NumberCellEditOptions,
type BadgeCellEditOptions,
type DateCellEditOptions,
type CellEditState,
type DateTimeDraft,
type CellEditState,
type FooterRenderContext,
} from "@tailor-platform/app-shell";
```
Expand Down
2 changes: 1 addition & 1 deletion docs/components/data-table.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions examples/vite-app/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ const AppInner = () => {
<SidebarItem to="/showcase/data-table-empty" />
<SidebarItem to="/showcase/data-table-lab" />
<SidebarItem to="/showcase/data-table-selection" />
<SidebarItem to="/showcase/line-items" />
<SidebarItem to="/showcase/data-table-tree" />
<SidebarItem to="/showcase/filter-rail" />
<SidebarItem to="/showcase/tree" />
Expand Down
204 changes: 204 additions & 0 deletions examples/vite-app/src/pages/showcase/line-items/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
import {
Button,
CellEditError,
Layout,
LineItems,
Tabs,
useLineItems,
type AppShellPageProps,
type LineItemsColumn,
} from "@tailor-platform/app-shell";
import { ListIcon, XIcon } from "lucide-react";
import { useCallback, useState } from "react";

type OrderLine = {
id?: string;
item: string | null;
quantity: number | null;
unitPrice: number | null;
status: string | null;
dueDate: string | null;
};

const validateQuantity = (_row: Readonly<OrderLine>, value: number | null) => {
if (value === null || value <= 0) {
throw new CellEditError("Quantity must be greater than zero.");
}
};

const LineItemsPage = () => {
const [editable, setEditable] = useState(true);
const canEdit = useCallback(() => editable, [editable]);
const lineItems = useLineItems<OrderLine>({
orderer: editable,
defaultLines: [
{
id: "line-1",
item: "Notebook",
quantity: 2,
unitPrice: 5,
status: "open",
dueDate: "2026-11-16",
},
{
id: "line-2",
item: "Pen",
quantity: 3,
unitPrice: 1.5,
status: "closed",
dueDate: "2026-11-17",
},
{
id: "line-3",
item: "Pencil",
quantity: 4,
unitPrice: 1,
status: "open",
dueDate: "2026-11-18",
},
{
id: "line-4",
item: "Eraser",
quantity: 2,
unitPrice: 0.75,
status: "open",
dueDate: "2026-11-19",
},
{
id: "line-5",
item: "Ruler",
quantity: 1,
unitPrice: 2,
status: "closed",
dueDate: "2026-11-20",
},
],
columns: [
{ accessorKey: "item", label: "Item", edit: { editorType: "text", canEdit } },
{
accessorKey: "quantity",
label: "Quantity",
type: "number",
typeOptions: { maxDecimals: 2 },
edit: { editorType: "number", canEdit, onValueCommitted: validateQuantity },
},
{
accessorKey: "unitPrice",
label: "Unit price",
type: "money",
edit: { editorType: "number", canEdit },
},
{
id: "total",
label: "Total",
type: "money",
accessor: (line) => (line.quantity ?? 0) * (line.unitPrice ?? 0),
},
{
accessorKey: "status",
label: "Status",
edit: {
editorType: "combobox",
canEdit,
editorOptions: {
options: [
{ value: "open", label: "Open" },
{ value: "closed", label: "Closed" },
],
},
},
},
{
accessorKey: "dueDate",
label: "Due date",
type: "date",
edit: { editorType: "date", canEdit },
},
...(editable
? [
{
id: "actions",
label: "Actions",
width: 64,
align: "center",
headerProps: () => ({ className: "first:pl-2! last:pr-2!" }),
cellProps: () => ({ className: "py-1! first:pl-2! last:pr-2!" }),
render: (line) => (
<Button
type="button"
variant="ghost"
size="xs"
className="align-middle"
aria-label={`Delete ${line.item ?? "line"}`}
onClick={() => lineItems.removeLine(lineItems.getLineKey(line))}
>
<XIcon aria-hidden="true" />
</Button>
),
} satisfies LineItemsColumn<OrderLine>,
]
: []),
],
});

return (
<Layout>
<Layout.Header title="Line Items" />
<Layout.Column>
<Tabs.Root
value={editable ? "editable" : "readonly"}
onValueChange={(value) => setEditable(value === "editable")}
>
<Tabs.List aria-label="Editing mode">
<Tabs.Tab value="editable">Editable</Tabs.Tab>
<Tabs.Tab value="readonly">Readonly</Tabs.Tab>
</Tabs.List>
</Tabs.Root>
{editable && (
<p className="text-sm text-muted-foreground">
Clear Quantity or enter zero or a negative number, then press Enter to see a validation
error.
</p>
)}
<LineItems.Root value={lineItems}>
<LineItems.Table aria-label="Order line items" />
</LineItems.Root>
{editable && (
<div className="flex gap-2">
<Button
type="button"
onClick={() =>
lineItems.addLine({
item: "New item",
quantity: 1,
unitPrice: 1,
status: "open",
dueDate: null,
})
}
>
Add line
</Button>
<Button
type="button"
variant="outline"
disabled={!lineItems.isDirty}
onClick={lineItems.revert}
>
Discard changes
</Button>
</div>
)}
</Layout.Column>
</Layout>
);
};

LineItemsPage.appShellPageProps = {
meta: {
title: "Line Items",
icon: <ListIcon />,
},
} satisfies AppShellPageProps;

export default LineItemsPage;
1 change: 1 addition & 0 deletions examples/vite-app/src/routes.generated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export type GeneratedRouteParams = {
"/showcase/grid": {};
"/showcase/item-list": {};
"/showcase/layouts": {};
"/showcase/line-items": {};
"/showcase/metric-card": {};
"/showcase/primitives": {};
"/showcase/spinner": {};
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
import { afterEach, describe, expect, it, vi } from "vitest";
import * as tableCore from "@/components/internals/table-core";
import { cleanup, render, renderHook, screen } from "@testing-library/react";
import { createAppShellWrapper } from "../../../tests/test-utils";
import { useEditorProps } from "./editing/cell/shared";
import { createCellEditNavigation } from "./editing/use-navigation";
import { MemoryRouter } from "react-router";
import {
createTypedCellRenderer,
createTypedValueRenderer,
getCellValue,
renderTypedValue,
} from "./cell-renderers";
import type { Column } from "./types";

afterEach(() => {
cleanup();
vi.restoreAllMocks();
});

describe("DataTable renderer adapter compatibility", () => {
const row = { id: "A", status: "open", name: "Raw name" };

it("retains accessor/id lookup precedence without treating render output as raw data", () => {
expect(getCellValue(row, { id: "name" })).toBe("Raw name");
expect(getCellValue(row, { id: "name", accessor: (value) => value.status })).toBe("open");
expect(getCellValue(row, { render: () => "Display only" })).toBeUndefined();
});

it.each([false, true])(
"resolves an editable value once with a prepared renderer (custom display: %s)",
(custom) => {
const accessor = vi.fn((value: typeof row) => value.name);
const col = {
id: "name",
type: "text",
accessor,
render: custom ? () => "Custom" : undefined,
edit: { onValueCommitted: () => {} },
} satisfies Column<typeof row>;
const valueRenderer = vi.fn(createTypedValueRenderer(col, { timeZone: "UTC" }));
const { result } = renderHook(
() =>
useEditorProps({
row,
col,
valueRenderer,
rowKey: row.id,
colKey: "name",
label: "Name",
align: "left",
navigation: createCellEditNavigation(),
cellProps: {},
}),
{ wrapper: createAppShellWrapper() },
);
expect(accessor).toHaveBeenCalledExactlyOnceWith(row);
expect(result.current.current).toBe("Raw name");
expect(result.current.display).toBe(custom ? "Custom" : "Raw name");
if (custom) expect(valueRenderer).not.toHaveBeenCalled();
else expect(valueRenderer).toHaveBeenCalledExactlyOnceWith("Raw name", row);
},
);

it("keeps edit-choice labels in legacy text rendering", () => {
const col: Column<typeof row> = {
id: "status",
type: "text",
edit: {
options: [{ value: "open", label: "Open label" }],
onValueCommitted: () => {},
},
};
expect(createTypedCellRenderer(col, "UTC")(row)).toBe("Open label");
});

it.each(["number", "money"] as const)(
"prepares a %s renderer once rather than recreating it for each row",
(type) => {
const createRenderer = vi.spyOn(tableCore, "createValueRenderer");
const col: Column<{ value: number }> = { id: "value", type };
const renderer = createTypedCellRenderer(col, "UTC");
expect(createRenderer).toHaveBeenCalledExactlyOnceWith(col, { timeZone: "UTC" });
renderer({ value: 1 });
renderer({ value: 2 });
renderer({ value: 3 });
expect(createRenderer).toHaveBeenCalledOnce();
},
);

it("resolves legacy link labels and plaintext editor display outside table-core", () => {
const col: Column<typeof row> = {
id: "status",
type: "link",
typeOptions: { href: (value) => `/rows/${value.id}` },
edit: {
options: [{ value: "open", label: "Open label" }],
onValueCommitted: () => {},
},
};
const readonly = createTypedCellRenderer(col, "UTC");
const editable = createTypedCellRenderer(col, "UTC", { linkAsText: true });
expect(editable(row)).toBe("Open label");
expect(renderTypedValue(row, col, row.status, { linkAsText: true })).toBe("Open label");
render(<MemoryRouter>{readonly(row)}</MemoryRouter>);
expect(screen.getByRole("link", { name: "Open label" }).getAttribute("href")).toBe("/rows/A");
});
});
Loading
Loading