TimeOffering
Stentor API Reference / stentor-models/src / TimeOffering
Interface: TimeOffering
Defined in: packages/stentor-models/src/Form/FormField.ts:438
A single entry in the time column of a date/time picker.
Structurally compatible with the time members of SelectableItem, so an offering converts to the item shape the chips field already submits.
Omitting end produces a discrete appointment start ("9:30 AM"); supplying it produces
a window ("Morning, 8:00 AM - 12:00 PM"). A schedule may mix both.
Properties​
label?​
optionallabel?:string
Defined in: packages/stentor-models/src/Form/FormField.ts:444
Display label. When omitted, a label is formatted from start (and end when present).
This is the value submitted for the field, so it is what a CRM or lead consumer receives.
start​
start:
string
Defined in: packages/stentor-models/src/Form/FormField.ts:448
When the appointment starts.
end?​
optionalend?:string
Defined in: packages/stentor-models/src/Form/FormField.ts:452
When the appointment ends. Omit for a discrete start time with no stated end.
group?​
optionalgroup?:string
Defined in: packages/stentor-models/src/Form/FormField.ts:457
Optional heading this offering sits under, used to group a column that mixes named windows with discrete times.