Documentation / jalali-js / CalendarEvent

Interface: CalendarEvent

Defined in: event-calendar.ts:105

A consumer-owned calendar event. The library lays events out. The consumer owns storage and editing.

start and end are inclusive date fields in the calendar system the view uses. Timed events may set startTime / endTime. Recurring rules are not expanded here: expand them before you pass the array.

Timeline view also reads optional description, color, and icon.

Properties

allDay?

optional allDay?: boolean

Defined in: event-calendar.ts:111

Default: true when no times are set.

---

color?

optional color?: string

Defined in: event-calendar.ts:117

CSS color for timeline accent (marker and card edge).

---

description?

optional description?: string

Defined in: event-calendar.ts:115

Optional body text for timeline cards.

---

end

end: CalendarDateFields

Defined in: event-calendar.ts:109

---

endTime?

optional endTime?: TimeOfDay

Defined in: event-calendar.ts:113

---

icon?

optional icon?: string

Defined in: event-calendar.ts:119

Short icon for timeline markers (emoji or text).

---

id

id: string

Defined in: event-calendar.ts:106

---

start

start: CalendarDateFields

Defined in: event-calendar.ts:108

---

startTime?

optional startTime?: TimeOfDay

Defined in: event-calendar.ts:112

---

title

title: string

Defined in: event-calendar.ts:107