FormInput

Stentor API Reference

---

Stentor API Reference / stentor-models/src / FormInput

Interface: FormInput

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

Form field base class

Extended by

• FormTextInput
• FormDropdownInput
• FormChipsInput
• FormSelectInput
• FormCardInput
• FormDateInput
• FormDateRangeInput

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"

---

title?

optional title: string

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

Optional title used to display on the input

---

type

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

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

Type of the input

---

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.

---

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

---

mandatory?

optional mandatory: boolean

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

Is the field required.

---

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.

---

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.

---

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' }}