Skip to main content

Interface: TextFieldProperties

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

Properties for the TextField component.

Extends​

Properties​

error?​

readonly optional error: string

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

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:139

Help text to provide guidance to users

Inherited from​

StringFieldPropsBase.helpText

id​

readonly id: string

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

Unique identifier for the field (required for accessibility)

Inherited from​

StringFieldPropsBase.id

label​

readonly label: string

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

Label text to display for the field

Inherited from​

StringFieldPropsBase.label

required?​

readonly optional required: boolean

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

Whether the field is required for form submission

Inherited from​

StringFieldPropsBase.required

max?​

readonly optional max: number

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

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

min?​

readonly optional min: number

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

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

placeholder?​

readonly optional placeholder: string

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

Placeholder text displayed when input is empty

type?​

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

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

Input type - text, url, or number

disabled?​

readonly optional disabled: boolean

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

Whether the field is disabled.

Inherited from​

StringFieldPropsBase.disabled

onChange()​

readonly onChange: (value: string) => void

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

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:27

Current field value.

Inherited from​

StringFieldPropsBase.value