Field Config

Type: FluiKitFieldConfig.

Properties

Property	Type	Required	Description
`name`	`string`	Yes	Field key.
`label`	`string`	No	Display label.
`type`	`FluiKitFieldType`	No	Field renderer type.
`valueFrom`	`string`	No	Source path for edit/detail mapping.
`editValueMode`	`"fromRow" \| "empty" \| "default" \| "hidden"`	No	Edit value behavior.
`createValueMode`	`"empty" \| "default" \| "hidden"`	No	Create value behavior.
`defaultValue`	`unknown`	No	Default value.
`hidden`	`boolean`	No	Hides field.
`disabled`	`boolean`	No	Disables input.
`readonly`	`boolean`	No	Renders read-only behavior when supported.
`placeholder`	`string`	No	Input placeholder.
`helperText`	`string`	No	Help text.
`component`	`string`	No	Registry component key.
`adapter`	`string`	No	Field adapter key.
`adapterProps`	`Record<string, unknown>`	No	JSON-friendly config passed through to the field's `adapter`/`component` implementation (for example `@vibeflui/editors`'s `editorjs` adapter). Not read by the core runtime itself.
`validator`	`string`	No	Registry validator key. Runs only after built-in rules (`required`, `min`/`max`, `minLength`/`maxLength`, `pattern`, email format) already pass.
`required`	`boolean`	No	Required validation.
`min` / `max`	`number \| string`	No	Numeric, date, or datetime bounds where applicable.
`minLength` / `maxLength`	`number`	No	String length validation.
`pattern`	`string`	No	Pattern validation.
`validationMessage`	`string`	No	Custom validation message.
`transformer`	`string`	No	Registry transformer key.
`computed`	`string`	No	Registry computed resolver key.
`computedFrom`	`string \| string[]`	No	Source field dependencies used to decide when a computed resolver should run again.
`visibleWhen`	`FluiKitCondition`	No	Conditional visibility.
`options`	`FluiKitFieldOption[]`	No	Static options.
`optionsEndpoint`	`string`	No	Endpoint for options.
`optionsDataPath`	`string`	No	Data path for endpoint options.
`optionLoader`	`string`	No	Registry option loader key.
`optionLabelKey`	`string`	No	Custom option label key.
`optionValueKey`	`string`	No	Custom option value key.
`className`	`string`	No	Field class name.

Field types

type FluiKitFieldType =
  | "text" | "email" | "password" | "number" | "textarea"
  | "select" | "multiselect" | "checkbox" | "checkbox-group"
  | "radio" | "radio-group" | "switch"
  | "date" | "datetime" | "time"
  | "file" | "image" | "hidden" | "color" | "range"
  | "json" | "code" | "richtext" | "markdown"
  | "tags" | "combobox" | "autocomplete" | "custom";

Use switch for toggle, on-off, and slide controls. Use checkbox for a normal checkbox. Use checkbox-group for multiple selections from options. Use radio or radio-group for single selection from options. Do not use checkbox-toggle; it is not part of FluiKitFieldType in the current source.

Example

{
  name: "status",
  label: "Status",
  type: "select",
  options: [
    { label: "Active", value: "active" },
    { label: "Pending", value: "pending" }
  ]
}