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

Error message to display when validation fails

Inherited fromโ€‹

StringFieldPropsBase.error


helpText?โ€‹

readonly optional helpText?: string;

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

Help text to provide guidance to users

Inherited fromโ€‹

StringFieldPropsBase.helpText


idโ€‹

readonly id: string;

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

Unique identifier for the field (required for accessibility)

Inherited fromโ€‹

StringFieldPropsBase.id


labelโ€‹

readonly label: string;

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

Label text to display for the field

Inherited fromโ€‹

StringFieldPropsBase.label


required?โ€‹

readonly optional required?: boolean;

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

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

Whether the field is disabled.

Inherited fromโ€‹

StringFieldPropsBase.disabled


onChangeโ€‹

readonly onChange: (value: string) => void;

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

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

Current field value.

Inherited fromโ€‹

StringFieldPropsBase.value