z-cal documentation
Start with the README quickstarts. These guides describe the current repository
API. For a version-specific snapshot, browse the repository tag matching your installed package
(for example, z-cal@0.1.0). Each npm release carries its own README and built type declarations;
releases made with the current packaging workflow also include docs/ and llms.txt.
Learn and build
- Installation: npm, React dependencies, CSS, Temporal, CDN, runtime support.
- Configuration: views, toolbars, sizing, responsive weeks, localization, resources, business hours.
- Events and interaction: date semantics, remote sources, mutations, selection, constraints and overlap, persistence.
- React: props, instance access, custom toolbars, content slots, server rendering.
- Styling: layout, colors, theme tokens, business hours shading, custom event icons.
Look up and troubleshoot
- Migrating from FullCalendar: duration units, API mappings, and unsupported features.
- API reference: public entry points, instance methods, callbacks, and option categories.
- Troubleshooting: symptoms, causes, and concrete fixes.
- Agent guide: integration sequence, source pointers, and completion checks.
- Contributing: repository development and releases.
- Inspiration: reference calendar implementations and what each is worth studying for.
The TypeScript code blocks in the README and these guides are checked by bun run docs:check
against the built package, rebuilding it first when it is stale. HTTP endpoints in examples belong to your application; implement them
and validate their responses before deploying. The demo stores new events in memory.