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

Text input. Validate according to the format.

Extends​

Extended by​

Properties​

name​

name: string

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

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

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

Type of the input

Inherited from​

FormInput.type

shape?​

optional shape: "ROUND" | "SQUARE"

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

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

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

Is the field required.

Inherited from​

FormInput.mandatory

mandatoryError?​

optional mandatoryError: string

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

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

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

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

format?​

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

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

placeholder?​

optional placeholder: string

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

label?​

optional label: string

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

rows?​

optional rows: number

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

rowsMax?​

optional rowsMax: number

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