Skip to content

Your first data view

Use View Engine for new projects and further data-view development. Viewer is deprecated and in maintenance mode, with no new features; the Viewer path below is retained for existing consumers. The packages use different models and APIs, so migration requires adaptation.

UI and ownershipEntry
shadcn/Base UI, headless engine, component-configuration persistence and ViewHostView Engine example and task guide
Ant Design, application-controlled table data and Viewer stateViewer example

View Engine currently uses workspace/local-archive instructions until its first registry release. Its core entry is usable independently of the React UI.

Legacy Ant Design Viewer path (deprecated)

Start with the complete local Viewer example. It supplies a consumer installation, one complete component, the React entry and a run command. No server, authentication setup or Storybook fixtures are needed.

Follow its five actions: inspect the first page, change pages, sort Name, filter Active, then save and switch views. The row results change because the example application calculates the data and supplies it to Viewer.

PieceOwner
Fields and available filtersApplication's ViewDefinition
Page/condition/sort interactionViewer calls the application
Filtered, sorted, paged rows and totalApplication's local calculation
Saved settings and success callbackApplication's in-memory state
Permanent storage and access controlYour application and backend

Use the linked example's Storybook entry and browser check to verify the same behavior in this repository. It is the single executable source for this page; refreshing loses saved views. The optional server data monitor is outside this local example.

A single table may only need View. Use Viewer for a collection of views with application-owned loading and saving. Consider FetcherViewer only when your service implements its expected protocol; see integration decisions.

Released under the Apache License 2.0.