@ilamy/calendar 0.2.1 → 0.3.0

package/README.md

@@ -2,18 +2,38 @@
 
 A powerful, full-featured React calendar component library built with TypeScript, Tailwind CSS, and modern React patterns. Features multiple calendar views, drag-and-drop support, recurring events, and comprehensive internationalization.
 
-<img width="1648" height="883" alt="Screenshot 2025-07-21 at 4 26 22 PM" src="https://github.com/user-attachments/assets/2fedaec6-bafc-4a29-b045-8b0c5117b486" />
+<img width="1643" height="873" alt="Screenshot 2025-08-05 at 9 46 41 AM" src="https://github.com/user-attachments/assets/d289f034-0d26-4a1c-a997-dfa1ad26aa7a" />
 
 ## Features
 
-- 🗓️ **Multiple Views**: Month, Week, Day, and Year views
-- 🎯 **Drag & Drop**: Move events between dates and time slots
-- 🔄 **Recurring Events**: Support for complex recurring patterns
-- 🌍 **Internationalization**: 100+ locales with dayjs
-- 🎨 **Customizable**: Flexible styling with Tailwind CSS
-- ⚡ **Performance**: Optimized rendering with React patterns
-- 📱 **Responsive**: Works seamlessly across devices
-- 🔧 **TypeScript**: Full type safety and IntelliSense support
+- 🗓️ **Multiple Views**: Month, Week, Day, and Year views with smooth transitions
+- 🎯 **Drag & Drop**: Move events between dates and time slots with collision detection
+- 🔄 **RFC 5545 Recurring Events**: Full RRULE support with Google Calendar-style operations
+  - **RRULE Patterns**: Daily, Weekly, Monthly, Yearly with complex frequencies
+  - **Smart Operations**: Edit "this event", "this and following", or "all events"
+  - **Exception Handling**: EXDATE exclusions and modified instance support
+  - **rrule.js Integration**: Battle-tested library for robust recurrence generation
+- 📤 **iCalendar Export**: RFC 5545 compliant .ics file export with proper recurring event handling
+- 🌍 **Internationalization**: 100+ locales with dayjs and configurable week start days
+- 🎨 **Customizable Styling**:
+  - Flexible theming with Tailwind CSS and CSS variables
+  - Custom event rendering with render props
+  - Configurable colors, fonts, and spacing
+- ⚡ **Performance Optimized**:
+  - On-demand recurring event generation
+  - Efficient date range calculations
+  - Minimal re-renders with optimized React patterns
+- 📱 **Responsive Design**: Adaptive layouts for desktop, tablet, and mobile
+- 🔧 **Developer Experience**:
+  - Full TypeScript support with comprehensive type definitions
+  - IntelliSense and autocompletion
+  - Extensive JSDoc documentation
+  - Test-driven development with 100% test coverage
+- 🎛️ **Advanced Event Management**:
+  - All-day events with proper timezone handling
+  - Multi-day events with smart positioning
+  - Event validation and error handling
+  - Bulk operations and batch updates
 
 ## Documentation
 

package/dist/index.d.ts

@@ -237,6 +237,97 @@ interface CalendarEvent {
 */
 type WeekDays = "sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday";
 import React2 from "react";
+interface Translations {
+	today: string;
+	create: string;
+	update: string;
+	delete: string;
+	cancel: string;
+	event: string;
+	events: string;
+	newEvent: string;
+	title: string;
+	description: string;
+	location: string;
+	allDay: string;
+	startDate: string;
+	endDate: string;
+	startTime: string;
+	endTime: string;
+	color: string;
+	createEvent: string;
+	editEvent: string;
+	addNewEvent: string;
+	editEventDetails: string;
+	eventTitlePlaceholder: string;
+	eventDescriptionPlaceholder: string;
+	eventLocationPlaceholder: string;
+	repeat: string;
+	repeats: string;
+	customRecurrence: string;
+	daily: string;
+	weekly: string;
+	monthly: string;
+	yearly: string;
+	interval: string;
+	repeatOn: string;
+	never: string;
+	count: string;
+	every: string;
+	ends: string;
+	after: string;
+	occurrences: string;
+	on: string;
+	editRecurringEvent: string;
+	deleteRecurringEvent: string;
+	editRecurringEventQuestion: string;
+	deleteRecurringEventQuestion: string;
+	thisEvent: string;
+	thisEventDescription: string;
+	thisAndFollowingEvents: string;
+	thisAndFollowingEventsDescription: string;
+	allEvents: string;
+	allEventsDescription: string;
+	onlyChangeThis: string;
+	changeThisAndFuture: string;
+	changeEntireSeries: string;
+	onlyDeleteThis: string;
+	deleteThisAndFuture: string;
+	deleteEntireSeries: string;
+	month: string;
+	week: string;
+	day: string;
+	year: string;
+	more: string;
+	sunday: string;
+	monday: string;
+	tuesday: string;
+	wednesday: string;
+	thursday: string;
+	friday: string;
+	saturday: string;
+	sun: string;
+	mon: string;
+	tue: string;
+	wed: string;
+	thu: string;
+	fri: string;
+	sat: string;
+	january: string;
+	february: string;
+	march: string;
+	april: string;
+	may: string;
+	june: string;
+	july: string;
+	august: string;
+	september: string;
+	october: string;
+	november: string;
+	december: string;
+}
+type TranslationKey = keyof Translations;
+type TranslatorFunction = (key: TranslationKey | string) => string;
 /**
 * This interface extends the base CalendarEvent but allows more flexible date types
 * for the start and end properties. The component will automatically convert these
@@ -260,6 +351,11 @@ interface IlamyCalendarProps {
 	*/
 	firstDayOfWeek?: WeekDays;
 	/**
+	* The initial view to display when the calendar loads.
+	* Defaults to 'month'.
+	*/
+	initialView?: "month" | "week" | "day" | "year";
+	/**
 	* Custom render function for calendar events.
 	* If provided, it will override the default event rendering.
 	*/
@@ -280,11 +376,41 @@ interface IlamyCalendarProps {
 	*/
 	onViewChange?: (view: "month" | "week" | "day" | "year") => void;
 	/**
+	* Callback when a new event is added to the calendar.
+	* Provides the newly created event object.
+	*/
+	onEventAdd?: (event: CalendarEvent) => void;
+	/**
+	* Callback when an existing event is updated.
+	* Provides the updated event object.
+	*/
+	onEventUpdate?: (event: CalendarEvent) => void;
+	/**
+	* Callback when an event is deleted from the calendar.
+	* Provides the deleted event object.
+	*/
+	onEventDelete?: (event: CalendarEvent) => void;
+	/**
+	* Callback when the current date changes (navigation).
+	* Provides the new current date.
+	*/
+	onDateChange?: (date: dayjs.Dayjs) => void;
+	/**
 	* Locale to use for formatting dates and times.
 	* If not provided, the default locale will be used.
 	*/
 	locale?: string;
 	/**
+	* Translations object for internationalization.
+	* Provide either this OR translator function, not both.
+	*/
+	translations?: Translations;
+	/**
+	* Translator function for internationalization.
+	* Provide either this OR translations object, not both.
+	*/
+	translator?: TranslatorFunction;
+	/**
 	* Timezone to use for displaying dates and times.
 	* If not provided, the local timezone will be used.
 	*/
@@ -320,6 +446,11 @@ interface IlamyCalendarProps {
 	* Useful for adding custom branding or additional controls.
 	*/
 	headerComponent?: React2.ReactNode;
+	/**
+	* Custom class name for the calendar header.
+	* Useful for applying custom styles to the header.
+	*/
+	headerClassName?: string;
 }
 declare const IlamyCalendar: React3.FC<IlamyCalendarProps>;
 /**
@@ -357,4 +488,5 @@ interface GenerateRecurringEventsProps {
 declare const generateRecurringEvents: ({ event, currentEvents, startDate, endDate }: GenerateRecurringEventsProps) => CalendarEvent[];
 import { Frequency, Weekday } from "rrule";
 import { RRule } from "rrule";
-export { useIlamyCalendarContext, isRecurringEvent, generateRecurringEvents, Weekday, WeekDays, UseIlamyCalendarContextReturn, RRuleOptions, RRule, IlamyCalendarProps, IlamyCalendar, Frequency, CalendarEvent };
+declare const defaultTranslations: Translations;
+export { useIlamyCalendarContext, isRecurringEvent, generateRecurringEvents, defaultTranslations, Weekday, WeekDays, UseIlamyCalendarContextReturn, TranslatorFunction, Translations, TranslationKey, RRuleOptions, RRule, IlamyCalendarProps, IlamyCalendar, Frequency, CalendarEvent };