Skip to main content
zerotal

Documentation


Documentation / @zerotal/flow-ui / index / FieldProps

Interface: FieldProps

Defined in: flow-ui/src/components/Field.tsx:22

Indexable

[key: string]: unknown

Properties

label?

optional label?: unknown

Defined in: flow-ui/src/components/Field.tsx:23


description?

optional description?: unknown

Defined in: flow-ui/src/components/Field.tsx:25

Helper text under the label, before the control.


error?

optional error?: unknown

Defined in: flow-ui/src/components/Field.tsx:27

Validation message. Its presence is what marks the field invalid.


required?

optional required?: boolean

Defined in: flow-ui/src/components/Field.tsx:29

Show the required marker and set aria-required on the control.


id?

optional id?: string

Defined in: flow-ui/src/components/Field.tsx:31

Explicit id for the control. Generated when omitted.


orientation?

optional orientation?: "horizontal" | "vertical"

Defined in: flow-ui/src/components/Field.tsx:33

Lay the label beside the control instead of above it.


class?

optional class?: string

Defined in: flow-ui/src/components/Field.tsx:34


children?

optional children?: unknown

Defined in: flow-ui/src/components/Field.tsx:35