Schema Root

Root schema type: FluiKitConfig.

Properties

Property	Type	Required	Default	Description
`resource`	`string`	Yes	-	Resource key used by table, form, actions, messages, and endpoints.
`version`	`string`	No	normalized value	Schema version metadata.
`title`	`string`	No	generated from resource	Display title.
`description`	`string`	No	-	Display description.
`mode`	`"static" \| "server" \| "readonly"`	No	static/server runtime mode	High-level config mode.
`dataMode`	`"static" \| "server"`	No	from `mode` if static/server, else `"server"`	Data loading mode. Falls back to `mode` when `mode` is `"static"` or `"server"`; if neither `dataMode` nor a static/server `mode` is set (for example `mode` is `"readonly"` or omitted), `dataMode` resolves to `"server"`.
`uiMode`	`"interactive" \| "readonly"`	No	interactive	UI interaction mode.
`adapter`	`string \| FluiKitAdapterConfig`	No	-	Adapter key or adapter config.
`identity`	`FluiKitIdentityConfig`	No	normalized	Row identity and endpoint param config.
`endpoint`	`FluiKitEndpointConfig`	No	-	Endpoint string or operation map.
`provider`	`FluiKitDataProviderConfig`	No	-	Provider type/name config.
`handlers`	`FluiKitHandlersConfig`	No	-	Handler key map for operations.
`theme`	`FluiKitThemeConfig`	No	default theme	Theme config.
`layout`	`FluiKitLayoutConfig`	No	-	Root layout config.
`dashboard`	`FluiKitDashboardConfig`	No	-	Dashboard/cards config.
`table`	`FluiKitTableConfig`	No	enabled by default	Table config.
`form`	`FluiKitFormConfig`	No	enabled by default	Form config.
`detail`	`FluiKitDetailConfig`	No	normalized	Detail config.
`actions`	`boolean \| FluiKitActionsConfig`	No	normalized defaults	Built-in, row, bulk, and toolbar actions.
`permissions`	`FluiKitPermissionsConfig`	No	-	Permission key metadata/resolution config.
`hooks`	`FluiKitHooksConfig`	No	-	Lifecycle hook keys.
`transform`	`FluiKitTransformConfig`	No	-	Request/response transform keys.
`registry`	`FluiKitRegistryConfig`	No	-	Declarative list of required registry keys.
`persist`	`FluiKitPersistConfig`	No	-	Table state persistence config.
`messages`	`FluiKitMessagesConfig`	No	default messages	Message config.
`feedback`	`FluiKitFeedbackConfig`	No	enabled modal	Feedback config.
`events`	`FluiKitEventsConfig`	No	-	Event handler keys.
`debug`	`boolean \| FluiKitDebugConfig`	No	disabled	Debug/inspector metadata.
`resources`	`FluiKitConfig[]`	No	-	Child resources for multi-resource screens. Rendered as tabs or stacked sections depending on `layout.type` — see `Layout Config`.
`ai`	`FluiKitAIMetadata`	No	-	Optional descriptive metadata for documentation, review, or generation workflows. It does not affect UI rendering.

Example

export const usersSchema = {
  resource: "users",
  title: "Users",
  table: {
    columns: ["name", "email", "status"]
  }
} as const;