Enum Configuration
Enum Configuration lets you define how each value in an enum type renders across your entire application. You can set custom display labels, badge colours, and the order values appear in dropdowns and filters.
Configuration applied here affects every field that uses the enum, regardless of which model it belongs to.
Accessing Enum Configuration
Enum Configuration lives in the Enums tab of Tool Settings:
- Open Tool Settings from the sidebar
- Click the Enums tab
- Select an enum from the sidebar
- Configure each value in the panel on the right
You can also reach the Enums tab from the Models tab — selecting a field whose type is an enum shows a button that navigates directly to that enum's configuration.
Configuring enum values
Each value in an enum can be configured independently:
| Option | Description |
|---|---|
| Display value | Label shown in the UI instead of the raw enum value |
| Colour | Badge colour, chosen from the colour picker. Select Auto to use the default |
| Display order | The order this value appears in dropdowns and filters. Drag to reorder |
The Enums tab provides a colour picker for each value. When editing enum colours at action scope (via the tool configuration sidebar), colours are entered as plain hex codes instead.
Example
An OrderStatus enum with values Pending, Dispatched, and Delivered might be configured as:
| Value | Display value | Colour |
|---|---|---|
Pending | Awaiting dispatch | #f59e0b |
Dispatched | In transit | #3b82f6 |
Delivered | Complete | #22c55e |
The display values and badge colours then appear consistently in every table, record view, and filter that uses OrderStatus.
Display order
Drag values in the Enums tab to set the order they appear in dropdowns and filters. This is separate from how values are ordered in your schema.
Display order affects dropdowns and filter selectors throughout your tools. It does not affect the order records are returned from the database.
Relationship with action-level formatting
Action-level field formatting can override the global enum configuration for a specific tool. When viewing enum fields in the tool configuration sidebar with the scope toggle set to Action, the colour inputs accept plain hex codes rather than a picker.
See Model Configuration for the full global field configuration reference, and Field Formatting for tool-level overrides.