Collection
A shareable, portable bundle of events (a .cdy document is its JSON form).
Inert data: a manifest of the plugins its events need + the events themselves.
Load it with cal.load() after registering the declared plugins.
Properties
Section titled “Properties”$schema?
Section titled “$schema?”
optional$schema?:string
Optional JSON Schema URL for editor/AI validation + autocomplete of the
.cdy document. Point it at the published schema:
"https://calendaryjs.dev/schema/cdy.json". The core ignores it at runtime.
collection?
Section titled “collection?”
optionalcollection?:string
Collection name; used as the group id when id is omitted.
color?
Section titled “color?”
optionalcolor?:string
Group color, applied to every event that lacks its own (event-level wins).
events
Section titled “events”events: (
Buildable|EventConfig)[]
The events — plain configs (as in a .cdy file) or builders.
optionalid?:string
Group id (defaults to collection, else "collection").
optionalname?:string
Group display name.
plugins?
Section titled “plugins?”
optionalplugins?:string[]
Plugin package names the events need — validated on load.
priority?
Section titled “priority?”
optionalpriority?:number
Base priority for every event this collection loads that lacks its own
(event-level wins). Overridable at load time via load(cdy, { priority }).
version?
Section titled “version?”
optionalversion?:string
Collection version (semver-ish, informational).