Switch Field

checked / defaultChecked

boolean

Default: —

Controlled / uncontrolled checked state.

checkedText / uncheckedText

ReactNode

Default: "On" / "Off"

Text shown for each state (when showStateText).

label

ReactNode

Default: —

Field label.

description

ReactNode

Default: —

Helper text below the control.

error

ReactNode | boolean

Default: —

Error message, or true for an invalid state with no message.

onChange

(next: boolean) => void

Default: —

Called with the next checked state.

showStateText

boolean

Default: false

Shows inline "On/Off"-style text next to the track.

disabled

boolean

Default: false

Disables the control.

required

boolean

Default: false

Marks the field required.

stateTextPlacement

"before" | "after" | "both"

Default: "after"

Where to render state text relative to the track.

labelPlacement

"top" | "left" | "right" | "floating"

Default: "top"

Label position relative to the control.

colSpan

number

Default: —

Sets `grid-column: span N` on the field wrapper — a real home for a layout hint in a spread config object (instead of leaking to the <input>).

size

"xs" | "xs-sm" | "sm" | "md" | "lg" | "xl"

Default: "md"

Control size.

variant

"bordered" | "soft" | "filled" | "underlined"

Default: "bordered"

Visual variant. "filled" (text types) is borderless with a neutral fill at rest, border + ring on focus; other field types fall back to "bordered". "default"/"underline" are legacy aliases.

color

"default" | "primary" | "secondary" | "info" | "success" | "warning" | "danger" | string

Default: "default"

Semantic tone.

colorDepth

number

Default: 500

Shade depth for color.

wrapperClassName

string

Default: —

Class on the field wrapper (the element that also carries colSpan), separate from `className` on the control.

className

string

Default: —

Class applied to the root element.

style

CSSProperties

Default: —

Inline styles for the root element.

children

ReactNode

Default: —

FormFieldSet fields and other form content.

validationMode

"blur" | "change"

Default: "blur"

When fields are (re-)validated.

showErrorsOn

"blur" | "change"

Default: "blur"

When validation errors start showing.

validateOnMount

boolean

Default: false

Runs validation immediately on mount.

initialValues

FormData

Default: {}

Initial values for uncontrolled fields.

disableAutofill

boolean

Default: true

Adds autocomplete/autofill-defeating attributes to the form.

onSubmit

(formData: FormData) => void | Promise<void>

Default: —

Called with collected field values on submit (required).

onError

(errors: FormErrors) => void

Default: —

Called when submit is blocked by validation errors.

className

string

Default: ""

Class applied to the form element.