ObjectUI Documentation

ObjectUI is a schema-driven UI engine for React. It renders JSON metadata into accessible, themeable components built with Tailwind CSS, Shadcn UI, and Radix primitives.

Use it when your application needs server-driven pages, metadata-defined forms, reusable enterprise views, or an embeddable renderer that stays independent from any single backend.

Start Here

1. Quick Start - install ObjectUI and render a first schema.
2. Schema Rendering - learn how JSON becomes React UI.
3. Data Connectivity - connect a backend through the DataSource contract.
4. Schema Reference - inspect the supported schema shapes.

A Small Schema

{
  "type": "data-table",
  "caption": "Users",
  "className": "rounded-lg border",
  "columns": [
    {
      "header": "Name",
      "accessorKey": "name",
      "sortable": true
    },
    {
      "header": "Email",
      "accessorKey": "email"
    }
  ],
  "data": [
    {
      "name": "Ada Lovelace",
      "email": "ada@example.com"
    },
    {
      "name": "Grace Hopper",
      "email": "grace@example.com"
    }
  ]
}

That schema renders through SchemaRenderer after the component package is imported once for registration side effects.

Build Paths

Render Schemas

• Schema Renderer explains the runtime component.
• Component Registry explains how type maps to React components.
• Expressions covers visibility, disabled state, and dynamic values.

Build Applications

• App Schema defines app navigation, branding, and layout.
• Layout Guide covers page structure and layout primitives.
• Building a CRUD App walks through a full task manager.

Connect Data

• Data Connectivity covers the backend adapter contract.
• ObjectStack Adapter connects ObjectUI to ObjectStack backends.
• User State Persistence covers favorites and recent items.

Extend ObjectUI

• Plugin Guide explains lazy-loaded feature packages.
• Plugin Development walks through a custom plugin.
• Theming covers design tokens, Tailwind, and runtime themes.

Reference

• Components - core renderers grouped by category.
• Fields - field widgets and cell renderers.
• Plugins - heavier views such as grids, kanban, charts, maps, and reports.
• Utilities - CLI, runner, plugin scaffolding, and editor tooling.

Console

The ObjectUI Console is the reference application for rendering ObjectStack metadata as an admin UI. Start with Console, then use Console Architecture and Metadata Diagnostics when integrating a real backend.