Skip to main content

FormTextInput

Stentor API Reference

Stentor API Reference / stentor-models/src / FormTextInput

Interface: FormTextInput

Defined in: packages/stentor-models/src/Form/FormField.ts:159

Text input field with optional validation and formatting.

Supports both single-line and multi-line text input with various format validators (phone, email, address, zip code).

Extends​

Extended by​

Properties​

name​

name: string

Defined in: packages/stentor-models/src/Form/FormField.ts:79

Name of the form input, this is not human readable and is used to identify the field.

For example: "SERVICE" or "FULL_NAME"

Inherited from​

FormInput.name

title?​

optional title?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:83

Optional title used to display on the input

Inherited from​

FormInput.title

type​

type: "CARD" | "TEXT" | "DROPDOWN" | "CHECK" | "CHIPS" | "DATE" | "DATERANGE"

Defined in: packages/stentor-models/src/Form/FormField.ts:87

Type of the input

Inherited from​

FormInput.type

shape?​

optional shape?: "ROUND" | "SQUARE"

Defined in: packages/stentor-models/src/Form/FormField.ts:91

Optional, used to shape the input. Not applicable to all inputs.

Inherited from​

FormInput.shape

condition?​

optional condition?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:98

A condition that must be met for the field to be shown.

For example: "issue === 'service_repair'" - issue is a field name in this example

Inherited from​

FormInput.condition

mandatory?​

optional mandatory?: boolean

Defined in: packages/stentor-models/src/Form/FormField.ts:102

Is the field required.

Inherited from​

FormInput.mandatory

mandatoryError?​

optional mandatoryError?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:106

Error message to show when the field is required but not filled out.

Inherited from​

FormInput.mandatoryError

mandatoryGroup?​

optional mandatoryGroup?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:110

Group fields together where one of the fields in the group is required.

Inherited from​

FormInput.mandatoryGroup

style?​

optional style?: object

Defined in: packages/stentor-models/src/Form/FormField.ts:116

React.CSSProperties style object to apply to the field.

For example: {{ width: '300px', height: '150px' }}

Inherited from​

FormInput.style

multiline?​

optional multiline?: boolean

Defined in: packages/stentor-models/src/Form/FormField.ts:163

When true, renders as a textarea instead of a single-line input

format?​

optional format?: "EMAIL" | "ADDRESS" | "PHONE" | "ZIP_CODE"

Defined in: packages/stentor-models/src/Form/FormField.ts:167

Format validation to apply to the input. Default is free text with no validation.

placeholder?​

optional placeholder?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:171

Placeholder text shown when the input is empty

label?​

optional label?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:175

Accessible label for the input field

rows?​

optional rows?: number

Defined in: packages/stentor-models/src/Form/FormField.ts:179

Number of rows for textarea (only applicable when multiline is true)

rowsMax?​

optional rowsMax?: number

Defined in: packages/stentor-models/src/Form/FormField.ts:183

Maximum number of rows for textarea (only applicable when multiline is true)

maxLength?​

optional maxLength?: number

Defined in: packages/stentor-models/src/Form/FormField.ts:187

Maximum character length allowed for the input