Skip to main content

FormChipsInput

Stentor API Reference

Stentor API Reference / stentor-models/src / FormChipsInput

Interface: FormChipsInput

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

Close/Open style chips selection field.

Displays items as chips that can be selected/deselected. Header plus open symbol reveals the chips.

Extends​

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

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

type​

type: "CHIPS"

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

Type of the input

Overrides​

FormInput.type

radio?​

optional radio?: boolean

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

When true, allows only single selection (radio button behavior). When false or undefined, allows multiple selections.

defaultOpen?​

optional defaultOpen?: boolean

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

Whether the chips are shown by default or collapsed

minRequired?​

optional minRequired?: number

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

Minimum number of items that must be selected

maxAllowed?​

optional maxAllowed?: number

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

Maximum number of items that can be selected

items​

items: (SelectableItem | ActionableItem)[]

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

List of selectable or actionable items to display as chips