llms.txt
Compare with other sites' llms.txt files →# GolemUI
> Declarative, serializable form engine. Docs in raw Markdown for LLMs.
**Default to the programmatic `gui.*` (dx) DSL — build with it unless the user explicitly asks for the JSON DSL.** Links below use `/dx/`; the JSON DSL is the same engine for serialized / no-code contexts — to use it, swap the `/dx/` prefix for `/json/` in any link.
## Start here — building a form in code (programmatic `gui.*`)
- **For programmatic / code form-building, read [the complete `gui.*` reference](/llms-gui-dx.txt) FIRST.** Every factory with a compile-verified example plus the cross-cutting rules, in one self-contained file. **Read it once and write your whole form from it** — it is self-sufficient for almost every form. Reach for the pages below only for a widget’s exhaustive options.
- [Every docs page in one file](/llms-full.txt), in the programmatic DSL.
## Docs
- [AI-ready from day zero](/dx/blog/cross-framework-benchmark.md): Three Claude models built the same forms with GolemUI, grounded by its MCP, and with mainstream libraries: the same correctness in a third of the code.
- [See you at DevBcn 2026](/dx/blog/golemui-at-devbcn-2026.md): GolemUI just hit v1.0 and we're bringing it to DevBcn 2026 in Barcelona, 16–17 June: build a form by talking to it, see the AI benchmark, grab merch.
- [GolemUI turns v1](/dx/blog/golemui-v1.md)
- [GolemUI v1.2.0: bring your own widget set](/dx/blog/golemui-v1-2.md): GolemUI v1.2: ship your design system as a widget set with its own gui.* namespace, plus a full accessibility pass and validators that fail loudly.
- [GolemUI v1.3.0: JSON schemas for your own widget set](/dx/blog/golemui-v1-3.md): GolemUI v1.3: widget sets publish their own JSON schema tree, scaffolded by the new @golemui/schemas CLI, so JSON forms get editor completion and validation.
- [GolemUI v1.4.0: dramatically faster core, multi-select widgets, and editable range pills](/dx/blog/golemui-v1-4.md): GolemUI v1.4: Multi List and Multi Dropdown widgets, range widgets that edit a committed range in place, and a core that renders large forms much faster.
- [GolemUI v1.5.0: server-side rendering and file uploads](/dx/blog/golemui-v1-5.md): GolemUI v1.5: server-side rendering for React, Angular, Lit and Vue, including Next.js, Analog, Astro and Nuxt, plus File Upload and Multi File Upload widgets.
- [GolemUI v1.5.1: strict CSP and file upload fixes](/dx/blog/golemui-v1-5-1.md): GolemUI v1.5.1: client-rendered forms run under a strict style-src CSP, file upload fixes with a cleanup contract, and packages that declare every import.
- [GolemUI v1.6.0: forms from a JSON Schema](/dx/blog/golemui-v1-6.md): GolemUI v1.6: fromJsonSchema turns a JSON Schema of your data into a form definition, at runtime or from the CLI, with $ref, allOf, oneOf and if/then/else.
- [GolemUI v2.0.0: Introducing GolemUI Components](/dx/blog/golemui-v2.md): GolemUI 2.0: the Components behind every form become a library of their own for plain HTML, React, Angular, Vue and Lit. Your form definitions keep working.
- [GolemUI v2.1.0: overlays, sliders, one-time codes and row events](/dx/blog/golemui-v2-1.md): GolemUI 2.1: dialogs, drawers, popovers, menus, tooltips and toasts in GolemUI Components, one-time codes and sliders, repeater row events, safer expressions and headless React forms.
- [GolemUI v2.1.1: validation and repeater fixes, and a deprecation schedule](/dx/blog/golemui-v2-1-1.md): GolemUI v2.1.1: validation and repeater fixes, tags that skip repeats by default, limits as validator rules, form definition errors in formHealth and a v3.0.0 deprecation schedule.
- [The age of token efficiency, the age of libraries](/dx/blog/the-age-of-token-efficiency.md): Sooner or later someone will ask whether we spend our AI tokens efficiently. Our bet: let the libraries spend them, and own the bugs too.
- [Turn a Tiptap document into a database with GolemUI](/dx/blog/turn-a-tiptap-document-into-a-database-with-golemui.md): Tiptap wants to be the document layer around the database. GolemUI helps by running real, validated forms inside Tiptap's document editor.
- [Why GolemUI](/dx/blog/why-golemui.md): GolemUI does not compete with the form library you already use. It replaces the in-house engine teams build on top of it to render forms from data.
- [Item Renderers](/dx/extending/item-renderers.md): Implement and register custom item renderers for dropdowns, lists, multi-selects, and other choice widgets.
- [Custom Middlewares](/dx/extending/middlewares.md): Write your own middleware to intercept the form's reactive store.
- [Custom Validators](/dx/extending/validators.md): Implement application-specific validation rules and register them via formConfig.customValidators.
- [Authoring pipeline](/dx/extending/widget-sets/authoring-pipeline.md): Use @golemui/dx to declare widget types and build a typed authoring namespace and selector chain for your own widget set.
- [Framework form components](/dx/extending/widget-sets/form-components.md): Turn a widget set into a ready-to-use form component with createFormComponent, or with provideWidgetSet in Angular.
- [Generating a schema tree](/dx/extending/widget-sets/generating-a-schema-tree.md): Scaffold and regenerate your widget set's JSON schema tree from a widget manifest with the golemui-schemas CLI.
- [JSON schemas](/dx/extending/widget-sets/json-schemas.md): Publish a JSON schema tree for your widget set so JSON form definitions get editor completion and validation.
- [Widget Sets Overview](/dx/extending/widget-sets/overview.md): Build a complete widget set with its own authoring namespace and form components, using the same pipeline that builds gui itself.
- [Creating an action widget](/dx/extending/widgets/action-widget.md): Build a custom action widget that emits events to your application.
- [Creating a display widget](/dx/extending/widgets/display-widget.md): Build a read-only display widget that renders custom content.
- [Sending events with your widgets](/dx/extending/widgets/events.md): Emit named events from custom widgets and pass an optional detail payload.
- [Creating an input widget](/dx/extending/widgets/input-widget.md): Build a custom input widget that reads and writes form data through the engine.
- [Creating a layout widget](/dx/extending/widgets/layout-widget.md): Build a custom layout widget that wraps its children with bespoke markup.
- [Custom Widgets Overview](/dx/extending/widgets/overview.md): Learn how to create your own widgets and plug them into the GolemUI form engine.
- [Sizing custom widgets](/dx/extending/widgets/sizing.md): The grid cell around a custom widget applies its size, and four classes line it up with the fields beside it.
- [Dependencies](/dx/features/dependencies.md): Inject third-party helpers (markdown parsers, upload transports) at the form level.
- [Form Events](/dx/features/events.md): Capture events emitted by widgets and react in your application code.
- [Form Chunks](/dx/features/form-chunks.md): Split a JSON form definition across several files and inline them at load time with $ref chunk references.
- [Host Functions](/dx/features/host-functions.md): Expose pure functions from your application to reactive expressions through the $fn namespace.
- [i18n](/dx/features/i18n.md): Localize labels, placeholders, validators, dates, and currency by plugging any i18n library that implements the I18nTranslator interface.
- [Item Renderers](/dx/features/item-renderers.md): Provide custom item templates for dropdowns, lists, multi-selects, and other choice widgets.
- [Forms from JSON Schema](/dx/features/json-schema.md): Convert a JSON Schema of your form data into a GolemUI form definition with fromJsonSchema, at runtime or from the command line.
- [Middlewares](/dx/features/middlewares.md): Intercept the form's reactive store to add logging, persistence, or schema validation.
- [Features Overview](/dx/features/overview.md): How the GolemUI form component works, and a quick tour of every feature you can plug into it.
- [Runtime Methods](/dx/features/runtime-methods.md): Imperatively update form data or meta from outside the component.
- [States](/dx/features/states.md): Declare named conditions and reuse them across your form to gate widgets, override properties, and compose behavior.
- [Composing states](/dx/features/states/composing.md): Combine multiple state expressions with AND / OR semantics, and chain states hierarchically with the colon syntax.
- [Include & Exclude](/dx/features/states/include-exclude.md): Gate which widgets render based on named states.
- [Inline when](/dx/features/states/inline-when.md): Express one-off conditional rules without naming a state.
- [Properties per state](/dx/features/states/properties.md): Override widget props when a named state is active.
- [String Interpolation](/dx/features/string-interpolation.md): Embed live form data, metadata, validation errors, and expressions directly in widget text props using {{...}} template slots.
- [Validators](/dx/features/validators.md): Validate form data with declarative rules and localized error messages.
- [Widget Loaders](/dx/features/widget-loaders.md): Register the UI widgets the form can render.
- [Custom Widgets](/dx/form-definition/custom-widgets.md): Plug your own widgets into the form definition with gui.<group>.custom().
- [Events](/dx/form-definition/events.md): Wire widget events through onClick, onChange, onLoad, onFilter, onBlur — plus actionType submit.
- [How it works](/dx/form-definition/how-it-works.md): A user-facing tour of the gui.* surface — why it exists, what its building blocks are, and where to read more.
- [Form Definition API](/dx/form-definition/overview.md): A tour of the gui.* programmatic API — the canonical way to define forms with GolemUI.
- [Reference](/dx/form-definition/reference.md): Exhaustive signature reference for every gui.* shortcut and gui.selectors method.
- [gui.actions reference](/dx/form-definition/reference/gui-actions.md): Every action shortcut.
- [gui.displays reference](/dx/form-definition/reference/gui-displays.md): Every display shortcut.
- [gui.inputs reference](/dx/form-definition/reference/gui-inputs.md): Every input shortcut, with signature and link to the widget reference.
- [gui.layouts reference](/dx/form-definition/reference/gui-layouts.md): Every layout shortcut.
- [gui.selectors reference](/dx/form-definition/reference/gui-selectors.md): Every selector method, organized by chain position, with config shape and examples.
- [Runtime Functions](/dx/form-definition/runtime-functions.md): Make any prop reactive — pass a callback instead of a static value and the engine re-evaluates it on every form-data change.
- [Selectors](/dx/form-definition/selectors.md): The behavior layer — decorate widgets by type, tag, or uid without touching the form structure.
- [Chaining](/dx/form-definition/selectors/chaining.md): Compose selectors by chaining scope operators before the leaf method.
- [Multi-value scopes](/dx/form-definition/selectors/multi-value-scopes.md): Match widgets carrying multiple tags with AND or OR semantics.
- [Precedence](/dx/form-definition/selectors/precedence.md): How sensible defaults, selectors, shortcut props, and per-state overrides combine.
- [Scope operators](/dx/form-definition/selectors/scope-operators.md): Restrict a selector match to a tag or to an active state.
- [Sensible defaults](/dx/form-definition/selectors/sensible-defaults.md): What the engine fills in for you, and how to opt out.
- [Type selectors](/dx/form-definition/selectors/type-selectors.md): Match every widget of a given type and apply a decorator.
- [States](/dx/form-definition/states.md): Declare named conditions that the engine evaluates against form data.
- [Tags](/dx/form-definition/tags.md): Label widgets so you can target a whole subset from the selector layer in one place.
- [Getting started with AI](/dx/getting-started/build-with-ai.md): Build GolemUI forms by describing them in plain English. The skill and the MCP ground your AI assistant in the real API, so it writes correct, typed forms.
- [Installation](/dx/getting-started/installation.md): Scaffold a project, install GolemUI, and render your first form.
- [Rent a car: Parts of the form](/dx/getting-started/rent-a-car-form.md): Lay out every input widget the Rent a Car form needs, using grid layouts for rows.
- [Rent a car: Introduction](/dx/getting-started/rent-a-car-introduction.md): An end-to-end tutorial that builds a real Rent a Car form with conditional logic, custom item renderers, async data, and submission.
- [Rent a car: Validation errors](/dx/getting-started/rent-a-car-messages.md): Wire validators to every required field, then replace the default Zod messages with friendlier copy.
- [Rent a car: A custom item renderer](/dx/getting-started/rent-a-car-renderer.md): Display each car in the dropdown with an emoji thumbnail, the model name, and the price.
- [Rent a car: Search as you type](/dx/getting-started/rent-a-car-search.md): Load the car list from a service, filter server-side as the user types, and debounce the dropdown input to avoid flooding the network.
- [Rent a car: States and conditional rendering](/dx/getting-started/rent-a-car-states.md): Hide the return-office dropdown and the discount-code input until their toggles are on, and keep the submit button disabled until the form is valid.
- [Rent a car: Submitting the form](/dx/getting-started/rent-a-car-submitting.md): Capture the submit event, read the form data, and pop a confirmation.
- [GolemUI in five claims](/dx/golemui-in-five-claims.md): Five claims that set GolemUI apart, each shown with working code.
- [Angular](/dx/integration/angular.md): Set up GolemUI with Angular.
- [Configuration](/dx/integration/configuration.md): Every input the form component accepts, what it does, and how it differs between Programmatic and JSON forms.
- [Lit](/dx/integration/lit.md): Set up GolemUI with Lit.
- [Integration Overview](/dx/integration/overview.md): Install GolemUI for React, Angular, Lit, Vue, or vanilla JS and render your first form.
- [React](/dx/integration/react.md): Set up GolemUI with React.
- [Analog](/dx/integration/ssr/analog.md): Server-render GolemUI forms with Analog: preload the widgets in main.server.ts and main.ts, share provideClientHydration, and set formName for stable ids.
- [Angular SSR](/dx/integration/ssr/angular.md): Server-render GolemUI forms with @angular/platform-server: preload the widgets on both sides, enable client hydration, and set formName for matching ids.
- [Astro](/dx/integration/ssr/astro.md): Server-render GolemUI forms in Astro with @golemui/lit/ssr: the frontmatter renders the whole form to HTML and a client script resumes it in the browser.
- [Lit SSR](/dx/integration/ssr/lit.md): Server-render GolemUI forms with @golemui/lit/ssr on any Node server: renderTemplate emits the whole form and resumeServerRenderedForm takes over.
- [Next.js](/dx/integration/ssr/nextjs.md): Server-render GolemUI forms in the Next.js App Router: preload the widgets in a client provider, keep the config at module scope, and hydrate gui-* elements.
- [Nuxt](/dx/integration/ssr/nuxt.md): Server-render GolemUI forms in Nuxt: preload the widgets in a Nuxt plugin, load the stylesheet from nuxt.config.ts, and hydrate the gui-* elements.
- [Server-Side Rendering Overview](/dx/integration/ssr/overview.md): Render GolemUI forms on the server with React, Angular, Lit or Vue, or with Next.js, Analog, Astro or Nuxt, and keep server and client markup identical.
- [React SSR](/dx/integration/ssr/react.md): Server-render GolemUI forms with React on any Node server: preload the widgets before renderToString and hydrateRoot, and keep the config at module scope.
- [Vue SSR](/dx/integration/ssr/vue.md): Server-render GolemUI forms with Vue on any Node server: preload the widgets before createSSRApp on both sides, then let Vue hydrate the gui-* elements.
- [Vanilla JS](/dx/integration/vanilla.md): Set up GolemUI with vanilla JavaScript.
- [Vue](/dx/integration/vue.md): Set up GolemUI with Vue.
- [Privacy Policy](/dx/legal/privacy.md): How GolemUI handles your data on golemui.com.
- [Terms of Use](/dx/legal/terms.md): Terms governing the GolemUI website and software.
- [Generating from a schema](/dx/mcp/generating-from-a-schema.md): Generate a validated GolemUI form from a JSON Schema or an OpenAPI operation, end to end.
- [MCP Server](/dx/mcp/overview.md): An MCP server that lets AI coding assistants generate and validate GolemUI form definitions deterministically.
- [Setup](/dx/mcp/setup.md): Connect the GolemUI MCP server to Claude Code, Cursor, Windsurf, or any MCP-capable IDE.
- [Tools Reference](/dx/mcp/tools-reference.md): Inputs, outputs, and usage notes for the eight tools the GolemUI MCP server exposes.
- [From 1.x to 2.0](/dx/migrating/v1-to-v2.md): Upgrade a GolemUI Forms app from 1.x to 2.0: the stylesheet, cascade layers, the new grid layout, custom widgets and widget sets, and Lit SSR, before and after.
- [Agent Skill](/dx/skill.md): An installable agent skill that grounds AI coding assistants in the real GolemUI API — no MCP connector required.
- [Customization](/dx/styling/customization.md): Override GolemUI styles with CSS variables, class selectors, design tokens, and custom icons.
- [Going Headless](/dx/styling/going-headless.md): Drop the courtesy CSS layer and build a theme from scratch, step by step.
- [Styling Overview](/dx/styling/overview.md): How GolemUI styles work — headless CSS with a courtesy layer, responsive scaling, and right-to-left support.
- [Theming](/dx/styling/theming.md): Load the default theme, switch to the bundled Clay theme, and build your own — including scoped themes for multiple looks on the same page.
- [Alert](/dx/widgets-reference/display-fields/alert.md): A Display widget for showing status messages, notifications, or feedback to the user
- [Markdown Text](/dx/widgets-reference/display-fields/markdown-text.md): A Display widget for rendering Markdown content
- [Display Widgets Overview](/dx/widgets-reference/display-fields/overview.md): Read-only widgets that present information without binding to form data.
- [Renderer](/dx/widgets-reference/display-fields/renderer.md): A display widget that renders raw framework markup from a callback.
- [Calendar](/dx/widgets-reference/input-fields/calendar.md): A Calendar widget to allow user to select a single date from an interactive calendar interface
- [Checkbox](/dx/widgets-reference/input-fields/checkbox.md): A Checkbox widget to allow user to toggle boolean values
- [Currency](/dx/widgets-reference/input-fields/currency.md): A Currency widget to allow user to enter monetary values
- [Date Picker](/dx/widgets-reference/input-fields/date-picker.md): A Date Picker widget to allow user to enter a date via keyboard or by picking from an interactive calendar
- [Date Input](/dx/widgets-reference/input-fields/dateinput.md): A Date Input widget to allow user to enter a date directly via keyboard using segmented inputs
- [Date Time Calendar](/dx/widgets-reference/input-fields/datetimecalendar.md): A Date Time Calendar widget to allow user to select a date and a time from an interactive calendar
- [Date Time Input](/dx/widgets-reference/input-fields/datetimeinput.md): A Date Time Input widget to allow user to enter a date and a time directly via keyboard using segmented inputs
- [Date Time Picker](/dx/widgets-reference/input-fields/datetimepicker.md): A Date Time Picker widget to allow user to enter a date and a time via keyboard or by picking from an interactive calendar with time slots
- [Dropdown](/dx/widgets-reference/input-fields/dropdown.md): A Dropdown widget that allows users to pick an item from a list or search by typing
- [File Upload](/dx/widgets-reference/input-fields/file-upload.md): A File Upload widget that uploads one file through your own service and keeps the server response, never the file, in the form data
-