Weekdays
The weekdays property inside a Calendar Configuration defines the repeating cycle of named days that form a week in your world. Custom calendars can feature weeks of any length—from a simple 3-day cycle to complex fantasy weeks spanning dozens of days.
Weekdays are displayed sequentially on the calendar axes, date pickers, and view headers.
Configuration
The weekdays property is a structured object containing an offset and an array of individual weekday definitions.
| Property | Type | Default | Description |
|---|---|---|---|
offset | number | 0 | Shift in days relative to calendar’s Day 0. |
days | Weekday[] | n/a | Ordered array of weekday objects defining the sequence. |
Weekday Object (Weekday)
| Property | Type | Default | Description |
|---|---|---|---|
name | string | n/a | Full name of the weekday. |
short | string (optional) | n/a | Abbreviation used in compact calendar views. |
The sequence of days repeats continuously throughout the calendar starting from Day 0 (adjusted by offset).
Example
Below is the weekdays configuration in a Calendar Configuration demonstrating the root object structure alongside short-name abbreviations:
weekdays:
offset: 0 # 0 -> no offset. 1st day of calendar = 1st day of array
# x -> offset start of week by x days. (1+x)th day of calendar = 1st day of array
days:
- name: Moonday
short: Moo
- name: Godsday
- {name: Waterday, short: Wat}
- name: Marketday
- name: Restday
short: Rst