FormChipsInput

Stentor API Reference

---

Stentor API Reference / stentor-models/src / FormChipsInput

Interface: FormChipsInput

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

Close/Open style chips selection. Header plus open symbol reveals the chips.

Extends

• FormInput

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

---

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

---

type

type: "CHIPS"

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

Type of the input

Overrides

FormInput.type

---

radio?

optional radio: boolean

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

---

defaultOpen?

optional defaultOpen: boolean

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

---

minRequired?

optional minRequired: number

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

---

maxAllowed?

optional maxAllowed: number

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

---

items

items: (SelectableItem | ActionableItem)[]

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