Skip to main content

Packages and entry points

Start with the outcome-oriented analytics quickstart. Use this page when you need to understand package boundaries or choose an additional capability.

Application system

PackageVersionResponsibility
@zuilib/apps0.5.0The core view and application system: ViewSpec, AppSpec, registry, renderer, bindings, validation, patches, AI generation helpers, runtime adapters, policy, and telemetry.
@zuilib/builder0.1.0The optional authoring surface around Apps: library, creation flow, canvas, inspector, responsive preview, permission simulation, AI review, versions, and publishing.
@zuilib/workflows0.1.0Operational components and serializable view types for approvals, writeback, tasks, scenarios, comments, audit, and run history.

Analytics and content capabilities

PackageVersionResponsibility
@zuilib/charts0.4.0Ten chart types from a serializable ChartSpec, formatting, forecast views, interactive legends, and cross-filtering.
@zuilib/data-grid0.4.0A server-driven data grid with sorting, filters, column state, selection, editing, pagination, and keyboard navigation.
@zuilib/ai0.5.0Components for AI inside your product: assistant dock, streaming content, tool calls, approvals, diffs, structured output, and citations.
@zuilib/text-editor0.13.3A controlled markdown editor with tables, diagrams, code, outline, folding, comments, and extension points.

Foundation and distribution

PackageVersionResponsibility
@zuilib/primitives0.3.0Accessible React primitives, labels, forms, telemetry, and the source registry.
@zuilib/tokens0.2.1The shared color, type, spacing, density, motion, dark-mode, print, and theme contract.
@zuilib/cli0.4.0Owned-source add, diff, update, and status; organization registries; theme checks; and AppSpec checks.

All packages are ESM with TypeScript types under the @zuilib scope. Install only the capabilities that appear in your registry. Implementation libraries install transitively; React and React DOM remain peers so every package shares the host application's React runtime. Optional integration peers are called out by the package that exposes them.

Common starting sets

You needStart with
A customizable analytics viewApps + Charts + Data Grid
A multi-page internal applicationThe analytics set, then Builder when users need authoring
Approvals or writebackAdd Workflows to the Apps registry
AI interfaces inside the applicationAdd AI
Rich documents or generated narrative reportsAdd Text Editor
Individually owned component sourceUse the CLI registry workflow

ZUI Cloud is optional managed Cloud or Cloud Private infrastructure. Its Config Store, PDF Export, and Scheduled Delivery modules are not requirements for running the open-source library.