Skip to main content

Interface: TextFieldProperties

Defined in: src/components/AddSiteForm/TextField.tsx:72

Properties for the TextField component.

Hierarchy​

View Summary

Extends​

Properties​

error?​

readonly optional error?: string

Defined in: shared/types/componentProps.ts:170

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message to display when validation fails

Inherited from​

StringFieldPropsBase.error

helpText?​

readonly optional helpText?: string

Defined in: shared/types/componentProps.ts:172

Help text to provide guidance to users

Inherited from​

StringFieldPropsBase.helpText

id​

readonly id: string

Defined in: shared/types/componentProps.ts:174

Unique identifier for the field (required for accessibility)

Inherited from​

StringFieldPropsBase.id

label​

readonly label: string

Defined in: shared/types/componentProps.ts:176

Label text to display for the field

Inherited from​

StringFieldPropsBase.label

required?​

readonly optional required?: boolean

Defined in: shared/types/componentProps.ts:178

Whether the field is required for form submission

Inherited from​

StringFieldPropsBase.required

max?​

readonly optional max?: number

Defined in: src/components/AddSiteForm/TextField.tsx:74

Maximum value for number inputs (ignored for text/url types)

min?​

readonly optional min?: number

Defined in: src/components/AddSiteForm/TextField.tsx:76

Minimum value for number inputs (ignored for text/url types)

placeholder?​

readonly optional placeholder?: string

Defined in: src/components/AddSiteForm/TextField.tsx:78

Placeholder text displayed when input is empty

type?​

readonly optional type?: "number" | "url" | "text"

Defined in: src/components/AddSiteForm/TextField.tsx:80

Input type - text, url, or number

disabled?​

readonly optional disabled?: boolean

Defined in: src/components/AddSiteForm/fields/fieldFactories.tsx:59

Whether the field is disabled.

Inherited from​

StringFieldPropsBase.disabled

onChange​

readonly onChange: (value: string) => void

Defined in: src/components/AddSiteForm/fields/fieldFactories.tsx:61

Change handler invoked with the new string value.

Parameters​

value​

string

Returns​

void

Inherited from​

StringFieldPropsBase.onChange

value​

readonly value: string

Defined in: src/components/AddSiteForm/fields/fieldFactories.tsx:63

Current field value.

Inherited from​

StringFieldPropsBase.value