@contractspec/example.data-grid-showcase
v3.8.9
Published
Focused data-grid example for ContractSpec table capabilities
Readme
@contractspec/example.data-grid-showcase
Website: https://contractspec.io
Focused data-grid example for ContractSpec table capabilities.
What This Demonstrates
- ContractSpec-native table composition through
useContractTable,useDataViewTable, and the design-systemDataTable. - Client-mode and server-mode table controllers with sorting, pagination, selection, column visibility, resizing, pinning, and row expansion.
- A declarative
DataViewSpectable contract that adapts onto the same headless table stack. - Sandbox-friendly UI packaging for a focused example instead of a full app template.
Running Locally
From packages/examples/data-grid-showcase:
bun run devbun run buildbun run testbun run typecheck
Usage
Use @contractspec/example.data-grid-showcase as a focused reference for ContractSpec table primitives, or import its exported contracts and UI into docs, sandboxes, and internal examples.
Architecture
src/contracts/owns the sample query contract and declarative data view spec.src/docs/contains docblocks and documentation-facing exports.src/example.tsis the example manifest surfaced by@contractspec/module.examples.src/ui/contains the table showcase component and demo data/helpers.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./contractsresolves through./src/contracts/index.ts. - Export
./contracts/data-grid-showcase.data-viewresolves through./src/contracts/data-grid-showcase.data-view.ts. - Export
./contracts/data-grid-showcase.operationresolves through./src/contracts/data-grid-showcase.operation.ts. - Export
./data-grid-showcase.featureresolves through./src/data-grid-showcase.feature.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./exampleresolves through./src/example.ts. - Export
./uiresolves through./src/ui/index.ts. - Export
./ui/DataGridShowcaseresolves through./src/ui/DataGridShowcase.tsx.
Local Commands
bun run dev— contractspec-bun-build devbun run build— bun run prebuild && bun run build:bundle && bun run build:typesbun run test— bun testbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsc --noEmit
Notes
- This package is intentionally narrow: it exists to showcase the table primitive, not to simulate a full vertical business template.
- The same table stack is reused by the larger examples in
analytics-dashboard,crm-pipeline,integration-hub, andagent-console.
