Skip to content

basalt / admin/src / Field

Interface: Field ​

Defined in: admin/src/fields.ts:6

A single form/column descriptor derived from a Zod schema.

Properties ​

label ​

> label: string

Defined in: admin/src/fields.ts:8


name ​

> name: string

Defined in: admin/src/fields.ts:7


optionLabels? ​

> optional optionLabels?: Record<string, string>

Defined in: admin/src/fields.ts:21

Display text per option value, present only when configured.

Deliberately separate from options rather than replacing it with value/label pairs: the values are what the form submits and the schema validates, and a renderer that has never heard of this field keeps showing exactly what it shows today. Read it through optionLabel.


options? ​

> optional options?: string[]

Defined in: admin/src/fields.ts:12

Present for enum fields — the stored values, unchanged by any labelling.


required ​

> required: boolean

Defined in: admin/src/fields.ts:10


type ​

> type: FieldType

Defined in: admin/src/fields.ts:9

Released under the MIT License.