Options for the appointment picker, a part of the state that represents basic settings that control what parts of the UI are show or what texts are displayed.

Hierarchy

Index

Properties

closable

closable: boolean

Whether the appointment picker can be closed.

Regarding displayMode:

  • When displayMode = disabled / read-only, a single input with the currently selected slot (if any) is shown; regardless of closable.
  • When closable = false and displayMode = open / "close", the picker is always shown.
  • When closable = true and displayMode = open, the picker with the calendar is shown.
  • When closable = true and displayMode = close, a single input with the currently selected slot (if any) is shown.

dateFormat

dateFormat: string

The date format to use for displaying dates. Currently, this is the format as used by JQueryUI datepicker.

dateTimeFormat

dateTimeFormat: string

The date time format to use for displaying a date with a time. Use %1 for the date and %2 for the time.

dayNames

dayNames: keyof string[]

The list of long day names, starting from Sunday, for use as requested via the dateFormat option.

dayNamesMin

dayNamesMin: keyof string[]

The list of very short day names, starting from Sunday, for use as column headers within the appointment picker.

dayNamesShort

dayNamesShort: keyof string[]

The list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat option.

firstDayOfWeek

firstDayOfWeek: number

The day at which a week should be considered to start. This affects e.g. the columns of the calendar.

monthNames

monthNames: keyof string[]

The list of month names, starting from January, for use as requested via the dateFormat option.

monthNamesShort

monthNamesShort: keyof string[]

The list of abbreviated month names, starting from January, for use as requested via the dateFormat option.

showCapacity

showCapacity: boolean

Whether to show the capacity for each slot as well, in addition to the start time.

showClearSlotButton

showClearSlotButton: boolean

Whether to show the button to clear the selected slot.

showEndTime

showEndTime: boolean

Whether to show the end time for each slot as well, in addition to the start time.

textAvailableCapacity

textAvailableCapacity: string

The text to use for indicating the capacity of a slot. Use the placeholder %1 to insert the capacity.

textClosePicker

textClosePicker: string

Text to show for the button to close the appointment picker (only when the picker is opened).

textNextMonth

textNextMonth: string

The text for the button to switch to the next month.

textNoAvailableSlots

textNoAvailableSlots: string

The text to show when the selected date has no available free slots. Use the placeholder `%1 to insert the date.

textNoSlotSelected

textNoSlotSelected: string

The text to show when no slot is selected (when a slot is selected, the date and time is shown).

textNoneSelected

textNoneSelected: string

The text to show when the picker is closed and no appointment is selected.

textOpenPicker

textOpenPicker: string

Text to show for the button to open the appointment picker (only when the picker is closed).

textPrevMonth

textPrevMonth: string

The text for the button to switch to the previous month.

textSlotAtDisabledDate

textSlotAtDisabledDate: string

The text to use when a slot is selected that is not available.

textTimeZone

textTimeZone: string

The text for the header that indicates the time zone.

textUnavailableSlot

textUnavailableSlot: string

The text to use when a slot is selected that is not available.

textUnselectSlot

textUnselectSlot: string

The text to show for the button to unselect the selected slot.