llms.txt
Compare with other sites' llms.txt files →# CalendarJS
> Complete documentation for CalendarJS - a lightweight JavaScript library with Calendar, Schedule, and Timeline components. Works with React, Vue, Angular. MIT licensed.
Free and open source (MIT). Install with `npm install @calendarjs/ce` (React: `npm install @calendarjs/react`) or load from a CDN:
```html
<script src="https://cdn.jsdelivr.net/npm/lemonadejs/dist/lemonade.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@calendarjs/ce/dist/index.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@calendarjs/ce/dist/style.min.css" />
```
Source: https://github.com/componade/calendarjs. Package: https://www.npmjs.com/package/@calendarjs/ce.
Machine-readable artifacts on this domain:
- https://calendarjs.com/llms-full.txt: every docs page below, concatenated as markdown
- Append `.md` to any docs URL for its markdown source (`/docs/calendar` -> `https://calendarjs.com/docs/calendar.md`)
## Getting started
- [CalendarJS Documentation - JavaScript Calendar Components](https://calendarjs.com/docs): Complete documentation for CalendarJS - a lightweight JavaScript library with Calendar, Schedule, and Timeline components. Works with React, Vue, Angular. MIT licensed.
- [Getting Started with CalendarJS - Installation & Quick Start Guide](https://calendarjs.com/docs/getting-started): Learn how to install and set up CalendarJS in your project. Step-by-step guide for vanilla JS, React, Vue, and Angular with CDN and NPM options.
- [Date Helpers - JavaScript Date Utilities & Formatting Functions](https://calendarjs.com/docs/helpers): Lightweight date utility functions for JavaScript. Convert dates, format strings, validate inputs, and display relative time like "2 hours ago".
- [CalendarJS Changelog - Release Notes & Version History](https://calendarjs.com/docs/changelog): Complete release history for CalendarJS. Track new features, improvements, bug fixes, and breaking changes across all versions.
## Calendar
- [JavaScript Calendar - Date Picker & Range Selection Component](https://calendarjs.com/docs/calendar): Lightweight JavaScript date picker with single date, range selection, and time picking. Supports React, Vue, Angular. Keyboard accessible with popup and inline modes.
- [Date Formats - Custom Date Formatting & Display Options](https://calendarjs.com/docs/calendar/date-formats): Configure custom date formats with tokens like YYYY-MM-DD, DD/MM/YYYY, and more. Support for regional formats, Excel serial numbers, and ISO dates.
- [Calendar Events - Handle Date Selection & User Interactions](https://calendarjs.com/docs/calendar/events): Handle calendar events like onchange, onopen, onclose, and onupdate. Complete guide with examples for React, Vue, and vanilla JavaScript.
- [Calendar Internationalization - Multi-Language & Locale Support](https://calendarjs.com/docs/calendar/international): Translate calendar to any language with custom dictionaries. Configure first day of week and regional settings. Examples for Spanish, French, and more.
- [Programmatic Calendar Control - Methods & JavaScript API](https://calendarjs.com/docs/calendar/programmatic-control): Control the calendar with JavaScript methods. Navigate months, set values, open/close popup, and switch views programmatically. Complete API reference.
- [Date Range Picker - Select Start & End Dates](https://calendarjs.com/docs/calendar/ranges): Implement date range selection for booking systems and filters. Select start and end dates with visual feedback. Examples for React, Vue, and vanilla JS.
- [Date Validation - Restrict Selectable Dates & Valid Ranges](https://calendarjs.com/docs/calendar/validation): Restrict selectable dates with validRange. Set minimum and maximum dates, block specific dates, and validate user selections.
- [Calendar Web Component - Native HTML Custom Element](https://calendarjs.com/docs/calendar/web-components): Use CalendarJS as a native web component with the lm-calendar tag. No framework required. Works with any HTML page or web application.
## Schedule
- [JavaScript Schedule - Event Scheduler & Appointment Calendar](https://calendarjs.com/docs/schedule): Lightweight event scheduler with day, week, and weekdays views. Drag-and-drop events, time slot management, and undo/redo. Works with React, Vue, Angular.
- [Event Management - Add, Update & Delete Schedule Events](https://calendarjs.com/docs/schedule/event-management): Manage schedule events programmatically with addEvents, updateEvent, deleteEvents methods. Includes modal event form for user editing with undo/redo support.
- [Schedule Events - Callbacks for Create, Update & Delete](https://calendarjs.com/docs/schedule/events): Handle schedule events with callbacks for create, update, delete, and double-click. Complete examples for React, Vue, and vanilla JavaScript.
- [Schedule Form Integration - Custom Event Creation Forms](https://calendarjs.com/docs/schedule/form): Integrate custom forms for creating and editing schedule events. Handle double-click editing and new event creation with prompt or modal dialogs.
- [Time Configuration - Grid Intervals, Working Hours & Restrictions](https://calendarjs.com/docs/schedule/time-configuration): Configure schedule time settings including grid intervals (15, 30, 60 min), working hours range, and read-only time blocks for breaks and off-hours.
- [Schedule Web Component - Native HTML Custom Element](https://calendarjs.com/docs/schedule/web-components): Use CalendarJS Schedule as a native web component with the lm-schedule tag. No framework required. Works with any HTML page.
- [Weekly Mode - Recurring Schedules Without Specific Dates](https://calendarjs.com/docs/schedule/weekly-mode): Create weekly recurring schedules using weekday numbers instead of dates. Perfect for class timetables, work shifts, and repeating weekly patterns.
## Timeline
- [JavaScript Timeline - Chronological Event Display Component](https://calendarjs.com/docs/timeline): Lightweight javascript timeline component for event logs, roadmaps, and chronological displays. Monthly grouping, sorting options, and custom styling. React, Vue, Angular support.
- [Timeline Controls - Methods, Properties & Navigation](https://calendarjs.com/docs/timeline/controls): Control timeline programmatically with methods and properties. Navigate months, change alignment, toggle sort order, and refresh the display.
- [Timeline Editable - Show Edit Icons on Items](https://calendarjs.com/docs/timeline/editable): Display an editable icon on timeline items to indicate they can be modified. Combine with events to handle edit actions with examples for React, Vue, and vanilla JS.
- [Timeline Events - Handle Updates & User Interactions](https://calendarjs.com/docs/timeline/events): Handle timeline updates with the onupdate callback. Track data changes and user interactions with complete examples for React, Vue, and vanilla JS.
- [Timeline Data Management - Add, Update & Remove Entries](https://calendarjs.com/docs/timeline/management): Manage timeline entries programmatically. Add new items, update existing entries, and remove items with automatic refresh. React and Vue examples included.
- [Timeline Tags - Add Labels & Categories to Items](https://calendarjs.com/docs/timeline/tags): Add colored tags to timeline items for categorization and labeling. Configure tag colors and click handlers with complete examples for React, Vue, and vanilla JS.
- [Timeline Web Component - Native HTML Custom Element](https://calendarjs.com/docs/timeline/web-components): Use CalendarJS Timeline as a native web component with the lm-timeline tag. No framework required. Works with any HTML page.
## React
- [Getting Started with CalendarJS for React - Install, Import, First Component](https://calendarjs.com/react/getting-started): Install @calendarjs/react, import named components, and render your first controlled Calendar, Schedule, or Timeline. Hooks-friendly with ref forwarding.
- [React Hooks for CalendarJS - useCalendar, useSchedule, useTimeline](https://calendarjs.com/react/hooks): Use the useCalendar, useSchedule, and useTimeline hooks instead of manual refs. Returns a callback ref plus a reactive instance — null before mount, the live instance after.
- [TypeScript with CalendarJS for React - Input Types, Typed Refs, App Metadata](https://calendarjs.com/react/typescript): TypeScript guide for @calendarjs/react. Use loose EventInput/ItemInput types for inputs, strict Event/Item types for callback outputs, and attach app-specific metadata without casts.
- [React Date Helpers - Utility Functions for CalendarJS React](https://calendarjs.com/react/helpers): Lightweight date utility functions shipped with @calendarjs/react. Convert dates, format strings, validate inputs, and display relative time like "2 hours ago".
- [CalendarJS React Changelog - Release Notes & Version History](https://calendarjs.com/react/changelog): Complete release history for @calendarjs/react and the underlying components. Track new features, improvements, bug fixes, and breaking changes.
- [React Calendar - Date Picker & Range Selection Component](https://calendarjs.com/react/calendar): Lightweight React date picker with single date, range selection, and time picking. Idiomatic React API with controlled components, hooks, and ref forwarding. Keyboard accessible with popup and inline modes.
- [React Calendar Date Formats - Custom Date Formatting & Display Options](https://calendarjs.com/react/calendar/date-formats): Configure custom date formats with tokens like YYYY-MM-DD, DD/MM/YYYY, and more in the React Calendar. Support for regional formats, Excel serial numbers, and ISO dates.
- [React Calendar Events - Handle Date Selection & User Interactions](https://calendarjs.com/react/calendar/events): Handle React Calendar events like onChange, onOpen, onClose, and onUpdate. Complete guide with hooks-based examples and camelCase callback props.
- [React Calendar Internationalization - Multi-Language & Locale Support](https://calendarjs.com/react/calendar/international): Translate the React Calendar to any language with custom dictionaries. Configure first day of week and regional settings. Examples for Spanish, French, and more.
- [React Calendar Programmatic Control - Methods & Imperative API via Refs](https://calendarjs.com/react/calendar/programmatic-control): Control the React Calendar imperatively via forwarded refs. Navigate months, set values, open/close popup, and switch views. Complete API reference.
- [React Date Range Picker - Select Start & End Dates](https://calendarjs.com/react/calendar/ranges): Implement date range selection in React for booking systems and filters. Select start and end dates with visual feedback and hooks-based state.
- [React Calendar Date Validation - Restrict Selectable Dates & Valid Ranges](https://calendarjs.com/react/calendar/validation): Restrict selectable dates in the React Calendar with validRange. Set minimum and maximum dates, block specific dates, and validate user selections.
- [React Schedule - Event Scheduler & Appointment Calendar Component](https://calendarjs.com/react/schedule): Lightweight React event scheduler with day, week, and weekdays views. Drag-and-drop events, time slot management, undo/redo, hooks-friendly with forwarded refs.
- [React Event Management - Add, Update & Delete Schedule Events](https://calendarjs.com/react/schedule/event-management): Manage React schedule events programmatically with addEvents, updateEvent, deleteEvents methods via forwarded refs. Includes modal event form for user editing with undo/redo support.
- [React Schedule Events - Callbacks for Create, Update & Delete](https://calendarjs.com/react/schedule/events): Handle React schedule events with camelCase callback props for create, update, delete, and double-click. Hooks-friendly examples with @calendarjs/react.
- [React Schedule Form Integration - Custom Event Creation Forms](https://calendarjs.com/react/schedule/form): Integrate custom forms for creating and editing React schedule events. Handle double-click editing and new event creation with prompt or modal dialogs.
- [React Schedule Time Configuration - Grid Intervals, Working Hours & Restrictions](https://calendarjs.com/react/schedule/time-configuration): Configure React schedule time settings including grid intervals (15, 30, 60 min), working hours range, and read-only time blocks for breaks and off-hours.
- [React Schedule Weekly Mode - Recurring Schedules Without Specific Dates](https://calendarjs.com/react/schedule/weekly-mode): Create weekly recurring React schedules using weekday numbers instead of dates. Perfect for class timetables, work shifts, and repeating weekly patterns.
- [React Timeline - Chronological Event Display Component](https://calendarjs.com/react/timeline): Lightweight React timeline component for event logs, roadmaps, and chronological displays. Monthly grouping, sorting options, and custom styling with idiomatic React ergonomics.
- [React Timeline Controls - Methods, Properties & Navigation](https://calendarjs.com/react/timeline/controls): Control the React Timeline component programmatically with methods and properties via a forwarded ref. Navigate months, change alignment, toggle sort order, and refresh the display.
- [React Timeline Editable - Show Edit Icons on Items](https://calendarjs.com/react/timeline/editable): Display an editable icon on React Timeline items to indicate they can be modified. Combine with events to handle edit actions in your React app.
- [React Timeline Events - Handle Updates & User Interactions](https://calendarjs.com/react/timeline/events): Handle React Timeline updates with the onUpdate callback. Track data changes and user interactions with idiomatic React props.
- [React Timeline Data Management - Add, Update & Remove Entries](https://calendarjs.com/react/timeline/management): Manage React Timeline entries programmatically. Add new items, update existing entries, and remove items using React state with automatic refresh.
- [React Timeline Tags - Add Labels & Categories to Items](https://calendarjs.com/react/timeline/tags): Add colored tags to React Timeline items for categorization and labeling. Configure tag colors and click handlers in your React app.
## Optional
Demos and the interactive playground (examples, not reference):
- [CalendarJS Demo Page](https://calendarjs.com/demo): This section brings working examples and demos using CalendarJS components.
- [CalendarJS Demo Calendar](https://calendarjs.com/demo/calendar): JavaScript date picker demo: inline calendar with date range selection, keyboard navigation and change events. Vanilla JS, React and Vue.
- [CalendarJS Demo Schedule](https://calendarjs.com/demo/schedule): JavaScript scheduler demo: a weekly schedule with drag-and-drop events, resizing and change callbacks. Vanilla JS, React and Vue.
- [CalendarJS Demo Timeline](https://calendarjs.com/demo/timeline): JavaScript timeline demo: chronological events with colours, subtitles and descriptions, grouped by month. Vanilla JS, React and Vue.
- [CalendarJS Playground - Interactive Component Examples](https://calendarjs.com/playground): Explore live CalendarJS demos. See Calendar date pickers, Schedule event management, and Timeline components in action with working examples.