hashbrown

UiComponentDefinition

A component's contract with the model, without its implementation.

Pass the same object to exposeComponent in the browser and to {@link createUiJsonSchema} on the server, and both sides agree on the shape of the UI the model streams.

API

interface UiComponentDefinition  {
children?: 'any' | 'text' | false | readonly UiComponentDefinition[];
description: string;
name: string;
props?: Record<string, s.HashbrownType | s.StandardJSONSchemaV1>;
}
children
'any' | 'text' | false | readonly UiComponentDefinition[]

What the component accepts as children: any component in the kit, text, nothing, or a fixed list of child component definitions.

description
string

What the component shows and when the model should use it.

name
string

The tag name the model uses for this component.

props

Skillet or Standard JSON Schema schemas for each prop.