API reference
Every public entry of the four packages, generated from the declarations npm users get.
These pages are generated from the packages' published type declarations at every docs build, so they say what the code says, JSDoc included. A member or declaration marked "experimental" may still change before the 1.0 API freeze; at the freeze the marks go and the public API from then on only grows.
| Entry | What it holds | Runs in |
|---|---|---|
@hapio/calendar-core | dates, zones, views, events, rules, the store, getVisibleRange | anywhere, Server Components included |
@hapio/calendar-core/interaction | the interaction engines (selection(), editing(), externalDrops()) | client modules |
@hapio/calendar-core/dom | the pointer engine and the drag manager the engines use | the browser |
@hapio/calendar-core/layout | the layout algorithms (time axis, packing, background projection) | anywhere |
@hapio/calendar-core/series | seriesSupport, for recurrence engines of your own | client modules |
@hapio/calendar-core/locales/sv | the Swedish strings (/locales/en: the English ones) | anywhere |
@hapio/calendar-core/testing | clocks, DST vectors and data generators for tests | tests |
@hapio/calendar-react | the hooks and the block's prop types; re-exports the whole core | client components |
@hapio/calendar-react/interaction | the interaction hooks; re-exports @hapio/calendar-core/interaction | client components |
@hapio/calendar-react/testing | runConformance, checkContract, renderCalendar | tests in a browser |
@hapio/calendar-recurrence | rrule(), expandRecurrences, planSeriesEdit, describeRule | anywhere |
@hapio/calendar-compat, /react | the migration component's options and types; useCompatProps | client components (/react) |
HapioCalendar
Every prop of the block, and the registry's wrappers.
Core
Views, events, rules, callbacks, formats, strings, the store.
React
useCalendar, the view hooks and their getters.
Interaction
The engines, the interaction hooks, ./dom, ./layout, ./series.
Recurrence
Series, the engine, server expansion and planning.
Compat
The migration component's options, callbacks and controller.
Testing
runConformance, the contract checker, test clocks.