clean-jsdoc-theme TypeDoc APIv0.0.0

TextFieldProps

interface TextFieldProps extends module:components/Form.FormFieldProps { autoComplete?: string; children?: unknown; className?: string; defaultValue?: unknown; disabled?: boolean; error?: string; helpText?: string; id?: string; label?: string; maxLength?: number; minLength?: number; name: string; onBlur?: () => void; onChange?: (value: unknown) => void; onFocus?: () => void; placeholder?: string; readOnly?: boolean; required?: boolean; rules?: ValidationRule[]; style?: Record<string, string | number>; type?: 'text' | 'email' | 'password' | 'tel' | 'url'; value?: unknown; visible?: boolean; }

Source: Form.ts:358

Text input field props

Hierarchy


Properties

autoComplete: string

Auto-complete setting

children: unknown

Inherited from children

Child components or content

className: string

Inherited from className

CSS class names

defaultValue: unknown

Inherited from defaultValue

Default value

disabled: boolean

Inherited from disabled

Whether component is disabled

error: string

Inherited from error

Error message to display

helpText: string

Inherited from helpText

Help text displayed below field

id: string

Inherited from id

Unique component identifier

label: string

Inherited from label

Field label

maxLength: number

Maximum length

minLength: number

Minimum length

name: string

Inherited from name

Field name

onBlur: () => void

Inherited from onBlur

Blur handler

onChange: (value: unknown) => void

Inherited from onChange

Value change handler

onFocus: () => void

Inherited from onFocus

Focus handler

placeholder: string

Inherited from placeholder

Placeholder text

readOnly: boolean

Inherited from readOnly

Whether field is read-only

required: boolean

Inherited from required

Whether field is required

rules: ValidationRule[]

Inherited from rules

Validation rules

style: Record<string, string | number>

Inherited from style

Inline styles

type: 'text' | 'email' | 'password' | 'tel' | 'url'

Input type

value: unknown

Inherited from value

Field value

visible: boolean

Inherited from visible

Whether component is visible