AI Source Map

Use this page first when an AI agent reads VibeFlui documentation through search, crawling, retrieval, or a long-context prompt.

Do not rely on general web search for schema keys or runtime behavior. Use the current docs and the current @vibeflui/core package source. If a key, value, adapter, plugin, or behavior is not listed here or in the linked reference page, do not generate it as available.

Root schema map

The current root schema type is FluiKitConfig.

Key	Purpose	Read next
`resource`	Required resource key used by table, form, actions, messages, and endpoints.	`Root Schema`, `Schema Root`
`version`	Schema version metadata.	`Root Schema`, `Schema Root`
`title`	Display title for the generated UI.	`Root Schema`
`description`	Short display description for the generated UI.	`Root Schema`
`mode`	Compact runtime mode: static, server, or readonly.	`Root Schema`, `Static Mode`, `Server Mode`
`dataMode`	Explicit data loading mode.	`Static Mode`, `Server Mode`
`uiMode`	Interactive or readonly UI behavior.	`Root Schema`, `Actions`
`adapter`	UI adapter key or adapter config.	`Adapters And Plugins`, `Runtime Config`
`identity`	Row identity and endpoint parameter mapping.	`Endpoints`, `Resource Config`
`endpoint`	Endpoint string or operation map.	`Endpoints`, `Endpoint Config`
`provider`	Data provider type and metadata.	`Provider Config`, `Provider Config`
`handlers`	Operation-to-handler string mappings.	`Registry Handlers`, `Action Execution`
`theme`	Theme config, class name slots, presets, and variants.	`Theming`, `Theme Config`
`layout`	Root layout, sections, tabs, wizard, and surface configuration.	`Layout Schema`, `Layout`
`dashboard`	Dashboard card configuration.	`Dashboard Layout`, `Dashboard Config`
`table`	Table columns, search, filters, sorting, pagination, state, row actions, and bulk actions.	`Table Schema`, `Tables`, `Table Config`
`form`	Form mode, fields, layout, validation, options, submit, and transforms.	`Form Schema`, `Forms`, `Form Config`
`detail`	Detail view configuration.	`Detail Layout`, `Detail Config`
`actions`	Built-in, row, bulk, toolbar, submit, and custom actions.	`Action Schema`, `Actions`, `Action Config`
`permissions`	Permission keys, conditions, and frontend action visibility.	`Permission Resolvers`, `Action Permissions`
`hooks`	Lifecycle hook string keys.	`Hooks And Events`
`transform`	Request, response, and submit transform keys.	`Transformers`, `Computed Values And Transforms`
`registry`	Declarative list of string keys required at runtime.	`Registry Keys`, `Registry`, `Registry Config`
`persist`	Table state persistence configuration.	`Table Persistence`
`messages`	Message defaults and message resolver keys.	`Message Resolvers`, `Message Resolution`
`feedback`	Feedback modes, status resolution, icons, class names, and disabled feedback.	`Feedback Schema`, `Feedback`, `Feedback Config`
`events`	Event handler string keys.	`Hooks And Events`
`debug`	Debug and inspector metadata.	`Runtime Config`
`resources`	Child schemas for multi-resource screens.	`Resources`, `Multi Resource Layout`
`ai`	AI and documentation metadata.	`Root Schema`, `Schema Root`

Task routing

Goal	Read before generating
Basic table	`Simple Table`, `Tables`
Basic form	`Simple Form`, `Forms`
Form and table CRUD page	`Simple Form And Table`, `Response Contract`
Mapping a real backend's response shape into schema/handlers (which key holds rows, which key is the success flag)	List Response Mapping, Mutation Response Mapping, `Response Contract`
Advanced form and table	`Advanced Form And Table`, `Forms`, `Tables`
Data fetched from a backend API (VibeFlui `server` mode, called from the browser)	`Server Side Example`, `Server Mode`, `Endpoint Config`
Custom row action behavior	`Row Actions`, `Handler Actions`, `Registry Handlers`
Table row selection and bulk actions	`Row Selection And Bulk Actions`, `Bulk Actions`
Table custom filter with React Select	`Adapter Examples`, `Search, Filters, And Sort`, `React Select Plugin`
Custom cell renderer	`Registry Renderers`, `Styling And Renderers`
Custom form field or field adapter	`Registry Components`, `Field Adapters`, `Custom Fields And Adapters`
Theme customization	`Theming`, `Theme Config`
Adapter usage	`Adapters And Plugins`, `Adapter Examples`
Migration from regular React	`Migration Prompts`, `Migration From Manual React`
Code review of generated output	`Review Checklist`

Generation rules for crawler agents

Read this page before generating VibeFlui code.
Follow the linked reference page for exact keys and values before writing a schema.
Use switch for toggle/on-off/slide controls, checkbox for a normal checkbox, checkbox-group for multiple selections, and radio or radio-group for single selection. Do not generate checkbox-toggle.
Do not invent schema keys, action values, provider values, plugin claims, or response statuses.
Prefer status: true for success and status: false with a 400..499 code for expected business or validation responses. Recognized string statuses such as "rejected", "accepted", and "failed" are also supported when they match the source response contract.
Use code: 200 for examples unless the page is specifically explaining REST creation semantics.
Keep schema, registry, custom components, reusable handlers, and page wiring in separate files.
Do not inline JSX inside createRegistry.
Do not inline async handlers inside <FluiKit> or <FluiKitForm>.
Declare registry string keys in schema and register the matching functions or components at runtime.
For custom table filters, use table filter configuration with filter.type: "custom" and a registry component. Do not use form field adapter syntax for table filters.
For row action behavior, use actions.row with a handler key and implement that key in registry.actionHandlers. Reuse the built-in action button structure instead of rebuilding row buttons manually.