calendarkit-prov2 2.0.6 → 2.0.8

package/README.md

@@ -318,6 +318,7 @@ const sidebarMenus: SidebarMenuItem[] = [
 - [Documentation](https://react-calendarkit-prov2.vercel.app/)
 - [GitHub Repository](https://github.com/Sayzera/calendarkit-prov2)
 - [npm Package](https://www.npmjs.com/package/calendarkit-prov2)
+- [Publishing to npm](PUBLISHING.md)
 - [Issues](https://github.com/Sayzera/calendarkit-prov2/issues)
 
 ---

package/dist/index.d.mts

@@ -62,6 +62,21 @@ interface EventReminder {
     time: number;
     label?: string;
 }
+/**
+ * Optional badge rendered on timed event cards (e.g. Week view).
+ * Shown in the top-left corner when both icon and name are provided.
+ */
+interface EventBadge {
+    /** Icon node (e.g. Lucide icon or any JSX). */
+    icon: React.ReactNode;
+    /** Short label displayed next to the icon. */
+    name: string;
+}
+/**
+ * Built-in badge identifiers for common lesson / session types.
+ * Prefer sending `badgeId` from the backend (JSON-safe) over a full `badge` object.
+ */
+type BuiltInEventBadgeId = 'privateLesson' | 'groupLesson' | 'packageLesson' | 'online' | 'inPerson' | 'homeVisit' | 'trial' | 'makeup' | 'exam' | 'workshop' | 'priority' | 'holiday' | 'cancelled' | 'listening';
 interface CalendarEvent {
     id: string;
     title: string;
@@ -74,6 +89,16 @@ interface CalendarEvent {
     resourceId?: string;
     type?: string;
     icon?: string;
+    /**
+     * Optional corner badge (icon + name) for timed event cards.
+     * Prefer `badgeId` when data comes from a JSON API — icons cannot travel over the wire.
+     */
+    badge?: EventBadge;
+    /**
+     * Built-in badge key from the backend (e.g. "packageLesson").
+     * Resolved to icon + label on the client via `getEventBadge` / `resolveEventBadge`.
+     */
+    badgeId?: BuiltInEventBadgeId;
     attachments?: EventAttachment[];
     guests?: string[];
     reminders?: EventReminder[];
@@ -239,6 +264,11 @@ interface CalendarProps {
     isDarkMode?: boolean;
     onThemeToggle?: () => void;
     hideViewSwitcher?: boolean;
+    /**
+     * When true, hides the mobile floating action button (FAB) used to create events.
+     * Defaults to false (FAB is shown on viewports under 768px when not read-only).
+     */
+    hideFab?: boolean;
     /**
      * Hour (0–23) the Day and Week views initially scroll to on mount.
      * Defaults to 8 (08:00 AM).
@@ -319,10 +349,30 @@ interface CalendarProps {
     customViews?: CustomView[];
 }
 
+/** Icon node for each built-in badge id. */
+declare const EVENT_BADGE_ICONS: Record<BuiltInEventBadgeId, React.ReactNode>;
+/** Type guard for backend string → BuiltInEventBadgeId. */
+declare function isBuiltInEventBadgeId(id: string): id is BuiltInEventBadgeId;
+/**
+ * Build a localized EventBadge for a built-in id.
+ * Optional `name` overrides the localized default label.
+ */
+declare function getEventBadge(id: BuiltInEventBadgeId, language?: LanguageCode, name?: string): EventBadge;
+/**
+ * Resolve the display badge for an event.
+ * Priority: explicit `badge` object → `badgeId` from the backend.
+ */
+declare function resolveEventBadge(event: Pick<CalendarEvent, 'badge' | 'badgeId'>, language?: LanguageCode): EventBadge | undefined;
+/**
+ * Ready-made badges with Turkish labels (package default language).
+ * Prefer `badgeId` + `resolveEventBadge` when data comes from an API.
+ */
+declare const EVENT_BADGES: Record<BuiltInEventBadgeId, EventBadge>;
+
 declare function cn(...inputs: ClassValue[]): string;
 
 declare const Scheduler: React.FC<CalendarProps>;
 /** Primary export — backward-compatible alias for v1 `@calendarkit/react` consumers. */
 declare const ProScheduler: React.FC<CalendarProps>;
 
-export { type CalendarEvent, type CalendarProps, type CalendarTheme, type CalendarTranslations, type CustomView, DATE_FNS_LOCALES, type EventAttachment, type EventReminder, type EventType, LANGUAGE_META, LOCALES, type LanguageCode, ProScheduler, type CalendarProps as ProSchedulerProps, type Resource, Scheduler, type SidebarMenuItem, type ThemeColors, type ViewType, cn, getTranslations };
+export { type BuiltInEventBadgeId, type CalendarEvent, type CalendarProps, type CalendarTheme, type CalendarTranslations, type CustomView, DATE_FNS_LOCALES, EVENT_BADGES, EVENT_BADGE_ICONS, type EventAttachment, type EventBadge, type EventReminder, type EventType, LANGUAGE_META, LOCALES, type LanguageCode, ProScheduler, type CalendarProps as ProSchedulerProps, type Resource, Scheduler, type SidebarMenuItem, type ThemeColors, type ViewType, cn, getEventBadge, getTranslations, isBuiltInEventBadgeId, resolveEventBadge };

package/dist/index.d.ts

@@ -62,6 +62,21 @@ interface EventReminder {
     time: number;
     label?: string;
 }
+/**
+ * Optional badge rendered on timed event cards (e.g. Week view).
+ * Shown in the top-left corner when both icon and name are provided.
+ */
+interface EventBadge {
+    /** Icon node (e.g. Lucide icon or any JSX). */
+    icon: React.ReactNode;
+    /** Short label displayed next to the icon. */
+    name: string;
+}
+/**
+ * Built-in badge identifiers for common lesson / session types.
+ * Prefer sending `badgeId` from the backend (JSON-safe) over a full `badge` object.
+ */
+type BuiltInEventBadgeId = 'privateLesson' | 'groupLesson' | 'packageLesson' | 'online' | 'inPerson' | 'homeVisit' | 'trial' | 'makeup' | 'exam' | 'workshop' | 'priority' | 'holiday' | 'cancelled' | 'listening';
 interface CalendarEvent {
     id: string;
     title: string;
@@ -74,6 +89,16 @@ interface CalendarEvent {
     resourceId?: string;
     type?: string;
     icon?: string;
+    /**
+     * Optional corner badge (icon + name) for timed event cards.
+     * Prefer `badgeId` when data comes from a JSON API — icons cannot travel over the wire.
+     */
+    badge?: EventBadge;
+    /**
+     * Built-in badge key from the backend (e.g. "packageLesson").
+     * Resolved to icon + label on the client via `getEventBadge` / `resolveEventBadge`.
+     */
+    badgeId?: BuiltInEventBadgeId;
     attachments?: EventAttachment[];
     guests?: string[];
     reminders?: EventReminder[];
@@ -239,6 +264,11 @@ interface CalendarProps {
     isDarkMode?: boolean;
     onThemeToggle?: () => void;
     hideViewSwitcher?: boolean;
+    /**
+     * When true, hides the mobile floating action button (FAB) used to create events.
+     * Defaults to false (FAB is shown on viewports under 768px when not read-only).
+     */
+    hideFab?: boolean;
     /**
      * Hour (0–23) the Day and Week views initially scroll to on mount.
      * Defaults to 8 (08:00 AM).
@@ -319,10 +349,30 @@ interface CalendarProps {
     customViews?: CustomView[];
 }
 
+/** Icon node for each built-in badge id. */
+declare const EVENT_BADGE_ICONS: Record<BuiltInEventBadgeId, React.ReactNode>;
+/** Type guard for backend string → BuiltInEventBadgeId. */
+declare function isBuiltInEventBadgeId(id: string): id is BuiltInEventBadgeId;
+/**
+ * Build a localized EventBadge for a built-in id.
+ * Optional `name` overrides the localized default label.
+ */
+declare function getEventBadge(id: BuiltInEventBadgeId, language?: LanguageCode, name?: string): EventBadge;
+/**
+ * Resolve the display badge for an event.
+ * Priority: explicit `badge` object → `badgeId` from the backend.
+ */
+declare function resolveEventBadge(event: Pick<CalendarEvent, 'badge' | 'badgeId'>, language?: LanguageCode): EventBadge | undefined;
+/**
+ * Ready-made badges with Turkish labels (package default language).
+ * Prefer `badgeId` + `resolveEventBadge` when data comes from an API.
+ */
+declare const EVENT_BADGES: Record<BuiltInEventBadgeId, EventBadge>;
+
 declare function cn(...inputs: ClassValue[]): string;
 
 declare const Scheduler: React.FC<CalendarProps>;
 /** Primary export — backward-compatible alias for v1 `@calendarkit/react` consumers. */
 declare const ProScheduler: React.FC<CalendarProps>;
 
-export { type CalendarEvent, type CalendarProps, type CalendarTheme, type CalendarTranslations, type CustomView, DATE_FNS_LOCALES, type EventAttachment, type EventReminder, type EventType, LANGUAGE_META, LOCALES, type LanguageCode, ProScheduler, type CalendarProps as ProSchedulerProps, type Resource, Scheduler, type SidebarMenuItem, type ThemeColors, type ViewType, cn, getTranslations };
+export { type BuiltInEventBadgeId, type CalendarEvent, type CalendarProps, type CalendarTheme, type CalendarTranslations, type CustomView, DATE_FNS_LOCALES, EVENT_BADGES, EVENT_BADGE_ICONS, type EventAttachment, type EventBadge, type EventReminder, type EventType, LANGUAGE_META, LOCALES, type LanguageCode, ProScheduler, type CalendarProps as ProSchedulerProps, type Resource, Scheduler, type SidebarMenuItem, type ThemeColors, type ViewType, cn, getEventBadge, getTranslations, isBuiltInEventBadgeId, resolveEventBadge };