FormDateRangeInput

Stentor API Reference

---

Stentor API Reference / stentor-models/src / FormDateRangeInput

Interface: FormDateRangeInput

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

Date range picker input field.

Allows users to select a start and end date range.

Extends

• FormInput

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

---

preselecteDates?

optional preselecteDates?: object

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

Date range to preselect when the date picker is displayed

from?

optional from?: Date

Start date of the range

to?

optional to?: Date

End date of the range