Phone Field

value / defaultValue

{ code: string; phone: string }

Default: —

Controlled / uncontrolled value.

countryOptions

Array<{ code; name?; label?; flag?; shortCode?; key? }>

Default: built-in list

Override the available countries.

placeholder

string

Default: —

Placeholder for the phone input (phonePlaceholder is a legacy alias).

countryCodeAriaLabel

string

Default: "Country code"

Accessible label for the country code select.

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

(value: { code; phone }) => void

Default: —

Called with the resolved value.

defaultCountryCode

string

Default: "+1"

Fallback calling code.

countryCodeMode

"select" | "hidden"

Default: "select"

Show or hide the calling-code UI.

numbersOnly

boolean

Default: true

Strips non-digits from the phone portion.

disabled

boolean

Default: false

Disables the control.

required

boolean

Default: false

Marks the field required.

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.

radius

"none" | "xs" | "xs-sm" | "sm" | "md" | "lg" | "full"

Default: "md"

Corner radius. `rounded` is a legacy alias.

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>).

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.