@nxgt/material 3.83.0 → 3.84.1

package/dist/lib/components/ui/widgets/event-calendar/event-calendar-context.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import { EventChipVariant } from '../../display/event-chip/event-chip.classes.js';
 import { TemplateContext } from './template.types.js';
-import { CalendarEvent, EventCalendarRenderEvent, EventCalendarSlot, EventCalendarView } from './types.js';
+import { CalendarEvent, EventCalendarPreviewField, EventCalendarRenderEvent, EventCalendarSlot, EventCalendarView } from './types.js';
 import { EventCalendarModel } from './use-event-calendar.js';
 export type EventCalendarContextValue = EventCalendarModel & {
     /** The events as stored, true instants; `events` is what is drawn (the zone's wall clock). */
@@ -18,6 +18,11 @@ export type EventCalendarContextValue = EventCalendarModel & {
     scrollToHour?: number;
     onEventClick?: (event: CalendarEvent) => void;
     onSlotClick?: (slot: EventCalendarSlot) => void;
+    /** The preview popover opens on an event click (default true). */
+    eventPreview?: boolean;
+    previewFields?: EventCalendarPreviewField[];
+    onEventEdit?: (event: CalendarEvent) => void;
+    onEventDelete?: (event: CalendarEvent) => void;
     renderEvent?: EventCalendarRenderEvent;
 };
 export declare function EventCalendarProvider({ value, children, }: {

package/dist/lib/components/ui/widgets/event-calendar/event-calendar-shell.d.ts

@@ -12,4 +12,4 @@ export type EventCalendarShellProps = EventCalendarProps & {
  * mini-month side panel and a phone layout of its own. Events are props; the
  * chrome (search, focus, the last move's direction) lives in a slice.
  */
-export declare function EventCalendarShell({ template, visible, onEventClick, onSlotClick, className, renderEvent, toolbar, searchable, views, phoneView, sidebar, eventVariant, scrollToHour, ...options }: EventCalendarShellProps): import("react").JSX.Element;
+export declare function EventCalendarShell({ template, visible, onEventClick, onSlotClick, eventPreview, previewFields, onEventEdit, onEventDelete, className, renderEvent, toolbar, searchable, views, phoneView, sidebar, eventVariant, scrollToHour, ...options }: EventCalendarShellProps): import("react").JSX.Element;

package/dist/lib/components/ui/widgets/event-calendar/index.d.ts

@@ -2,5 +2,5 @@ export type { EventCalendarProps } from './event-calendar.js';
 export { EventCalendar } from './event-calendar.js';
 export { EventCalendarProvider, useEventCalendarContext, } from './event-calendar-context.js';
 export type { EventCalendarLane, EventCalendarTemplateChange, EventCalendarTemplateEvent, EventCalendarTemplateProps, EventCalendarTemplateSlot, EventCalendarWeekday, } from './template.types.js';
-export type { CalendarEvent, EventCalendarChange, EventCalendarDensity, EventCalendarRenderEvent, EventCalendarResource, EventCalendarSlot, EventCalendarView, } from './types.js';
+export type { CalendarEvent, EventCalendarChange, EventCalendarDensity, EventCalendarPreviewField, EventCalendarRenderEvent, EventCalendarResource, EventCalendarSlot, EventCalendarView, } from './types.js';
 export { useEventCalendar } from './use-event-calendar.js';

package/dist/lib/components/ui/widgets/event-calendar/partials/event-preview-title.d.ts

@@ -3,9 +3,13 @@ import { CalendarEvent, EventCalendarResource } from '../types.js';
  * The popover's first line: the event's colour (its resource's tone when it
  * sets none), the title to edit in place and the delete button.
  */
-export declare function EventPreviewTitle({ event, owner, locked, onDelete, }: {
+export declare function EventPreviewTitle({ event, owner, locked, showTitle, onEdit, onDelete, }: {
     event: CalendarEvent;
     owner?: EventCalendarResource;
     locked: boolean;
+    /** The colour dot and the title to edit; off, only the actions remain. */
+    showTitle?: boolean;
+    /** Set when the app edits the event itself: an Edit button. */
+    onEdit?: () => void;
     onDelete: () => void;
-}): import("react").JSX.Element;
+}): import("react").JSX.Element | null;

package/dist/lib/components/ui/widgets/event-calendar/partials/event-preview.d.ts

@@ -1,5 +1,7 @@
 import { CalendarEvent, EventCalendarResource } from '../types.js';
-export declare function EventPreview({ event, owner, }: {
+export declare function EventPreview({ event, owner, onClose, }: {
     event: CalendarEvent;
     owner?: EventCalendarResource;
+    /** Closes the popover (the app took over with its edit or delete). */
+    onClose?: () => void;
 }): import("react").JSX.Element;

package/dist/lib/components/ui/widgets/event-calendar/template.types.d.ts

@@ -41,7 +41,7 @@ export type EventCalendarTemplateChange = {
  * slots and changes are keyed by weekday and time. The month, day and agenda
  * views do not apply: `view` is `week` (the default) or `workweek`.
  */
-export type EventCalendarTemplateProps = Pick<EventCalendarProps, 'disabled' | 'className' | 'toolbar' | 'searchable' | 'density' | 'eventVariant' | 'startHour' | 'endHour' | 'hourHeight' | 'slotDurationMinutes' | 'scrollToHour'> & {
+export type EventCalendarTemplateProps = Pick<EventCalendarProps, 'disabled' | 'className' | 'toolbar' | 'searchable' | 'density' | 'eventVariant' | 'startHour' | 'endHour' | 'hourHeight' | 'slotDurationMinutes' | 'scrollToHour' | 'eventPreview' | 'previewFields'> & {
     mode: 'template';
     events?: EventCalendarTemplateEvent[];
     defaultEvents?: EventCalendarTemplateEvent[];
@@ -49,6 +49,10 @@ export type EventCalendarTemplateProps = Pick<EventCalendarProps, 'disabled' | '
     /** After a move, a resize or an edit, with the previous event. */
     onChange?: (change: EventCalendarTemplateChange) => void;
     onEventClick?: (event: EventCalendarTemplateEvent) => void;
+    /** An "Edit" button in the preview calls this with the event; the app opens its own editor. */
+    onEventEdit?: (event: EventCalendarTemplateEvent) => void;
+    /** The preview's delete button calls this instead of the built-in confirmation and removal. */
+    onEventDelete?: (event: EventCalendarTemplateEvent) => void;
     /** A click or a drag across an empty slot: where, as weekday and time. */
     onSlotClick?: (slot: EventCalendarTemplateSlot) => void;
     /** `week` (7 days, the default) or `workweek` (Monday to Friday). */

package/dist/lib/components/ui/widgets/event-calendar/types.d.ts

@@ -56,6 +56,8 @@ export type EventCalendarChromeState = {
     /** The resource the phone's switcher shows; `null` is the first. */
     resourceId: string | null;
 };
+/** A field of the event preview popover. */
+export type EventCalendarPreviewField = 'title' | 'color' | 'description';
 export type EventCalendarRenderEvent = (event: CalendarEvent) => ReactNode;
 export type EventCalendarProps = {
     /** `dated` (the default): real dates. See `mode="template"` for a recurring week. */
@@ -66,6 +68,24 @@ export type EventCalendarProps = {
     onChange?: (change: EventCalendarChange) => void;
     onEventClick?: (event: CalendarEvent) => void;
     onSlotClick?: (slot: EventCalendarSlot) => void;
+    /**
+     * Opens the preview popover on an event click. Default `true`; `false` skips
+     * it, so `onEventClick` alone handles the click.
+     */
+    eventPreview?: boolean;
+    /**
+     * The fields the preview popover edits in place: `'title'`, `'color'`,
+     * `'description'`. Default all three; `[]` leaves the time range and the
+     * actions. A field left out is not drawn.
+     */
+    previewFields?: EventCalendarPreviewField[];
+    /** An "Edit" button in the preview calls this with the event; the app opens its own editor. */
+    onEventEdit?: (event: CalendarEvent) => void;
+    /**
+     * The preview's delete button calls this with the event instead of the
+     * built-in confirmation and removal: the app confirms and deletes.
+     */
+    onEventDelete?: (event: CalendarEvent) => void;
     view?: EventCalendarView;
     defaultView?: EventCalendarView;
     onViewChange?: (view: EventCalendarView) => void;

package/dist/lib/components/ui/widgets/event-calendar/use-template-calendar.d.ts

@@ -6,7 +6,7 @@ import { CalendarEvent, EventCalendarChange, EventCalendarSlot } from './types.j
  * into weekday and time. The dated calendar owns no copy: the list given
  * is always the template list, mapped.
  */
-export declare function useTemplateCalendar({ events, defaultEvents, onEventsChange, onChange, onEventClick, onSlotClick, lanes, lane: laneProp, defaultLane, onLaneChange, }: EventCalendarTemplateProps): {
+export declare function useTemplateCalendar({ events, defaultEvents, onEventsChange, onChange, onEventClick, onSlotClick, onEventEdit, onEventDelete, lanes, lane: laneProp, defaultLane, onLaneChange, }: EventCalendarTemplateProps): {
     dated: CalendarEvent[];
     back: (event: CalendarEvent) => EventCalendarTemplateEvent;
     template: TemplateContext;
@@ -14,5 +14,7 @@ export declare function useTemplateCalendar({ events, defaultEvents, onEventsCha
     onEventsChange: (next: CalendarEvent[]) => void;
     onChange: ((change: EventCalendarChange) => void) | undefined;
     onEventClick: ((event: CalendarEvent) => void) | undefined;
+    onEventEdit: ((event: CalendarEvent) => void) | undefined;
+    onEventDelete: ((event: CalendarEvent) => void) | undefined;
     onSlotClick: ((slot: EventCalendarSlot) => void) | undefined;
 };

package/dist/lib/hooks/index.d.ts

@@ -13,6 +13,7 @@ export * from './use-mobile.js';
 export * from './use-navigation.js';
 export * from './use-number-formatter.js';
 export * from './use-options.js';
+export * from './use-poll.js';
 export * from './use-react-router-block.js';
 export * from './use-scroll-away.js';
 export * from './use-search-param.js';

package/dist/lib/hooks/poll.d.ts

@@ -0,0 +1,26 @@
+export type PollOptions = {
+    /** Milliseconds between two reads. */
+    ms: number;
+    /** One read; the next tick waits for it to end. */
+    read: () => void | Promise<void>;
+    /** The read happens only while this is true; default: always. */
+    active?: () => boolean;
+    /** False while the page is hidden; default: `document.visibilityState`. */
+    visible?: () => boolean;
+    /** Called with what a read threw or rejected; the poll goes on. */
+    onError?: (error: unknown) => void;
+    /**
+     * The in-flight flag, to share between polls that must not overlap (a
+     * restart while a read is pending); default: one per call.
+     */
+    flight?: {
+        current: boolean;
+    };
+};
+/**
+ * The framework-free loop behind `usePoll`: calls `read` every `ms`, one read
+ * at a time, skipping (not queueing) a tick while `active()` or `visible()`
+ * is false. Returns its stop. A read that throws or rejects never stops it, and after the stop its error
+ * is no longer reported.
+ */
+export declare function startPoll({ ms, read, active, visible, onError, flight, }: PollOptions): () => void;

package/dist/lib/hooks/use-poll.d.ts

@@ -0,0 +1,30 @@
+export { type PollOptions, startPoll } from './poll.js';
+export type UsePollOptions = {
+    /** Milliseconds between two reads. A new value restarts the interval. */
+    ms: number;
+    /** Poll only while true (a sync under way, a pending state); default `true`. */
+    enabled?: boolean;
+    /** One read; the next tick waits for it to end, so two never overlap. */
+    read: () => void | Promise<void>;
+    /** Called with what a read threw or rejected; the poll goes on. */
+    onError?: (error: unknown) => void;
+};
+/**
+ * Reads again every `ms` while `enabled` and the page is visible
+ * (`document.visibilityState === 'visible'`), one read at a time. A tick
+ * that falls while the page is hidden or a read is still running is skipped,
+ * not queued. The timer is cleared on unmount and when `enabled` turns
+ * false. The first read comes after `ms`; call `read` yourself for an
+ * immediate one. Does nothing on the server. A restart (a new `ms`, `enabled` back on) while a
+ * read is pending does not start a second one.
+ *
+ * `read` and `onError` may change on every render: the latest are used
+ * without restarting the interval.
+ *
+ * @example
+ * ```tsx
+ * const { data, revalidate } = useJob(id);
+ * usePoll({ ms: 3000, enabled: data?.status === 'running', read: revalidate });
+ * ```
+ */
+export declare function usePoll({ ms, enabled, read, onError }: UsePollOptions): void;

package/dist/lib/i18n/resources/en/en.d.ts

@@ -1811,6 +1811,7 @@ export declare const en: {
             title: string;
             description: string;
             color: string;
+            edit: string;
             delete: string;
             "delete-confirm": string;
             "open-day": string;

package/dist/lib/i18n/resources/en/material.json.d.ts

@@ -1801,6 +1801,7 @@ declare const _default: {
 		"title": "Title",
 		"description": "Add description",
 		"color": "Color",
+		"edit": "Edit event",
 		"delete": "Delete event",
 		"delete-confirm": "This event will be removed.",
 		"open-day": "Open {date}",

package/dist/lib/i18n/resources/fr/fr.d.ts

@@ -1811,6 +1811,7 @@ export declare const fr: {
             title: string;
             description: string;
             color: string;
+            edit: string;
             delete: string;
             "delete-confirm": string;
             "open-day": string;

package/dist/lib/i18n/resources/fr/material.json.d.ts

@@ -1801,6 +1801,7 @@ declare const _default: {
 		"title": "Titre",
 		"description": "Ajouter une description",
 		"color": "Couleur",
+		"edit": "Modifier l'événement",
 		"delete": "Supprimer l'événement",
 		"delete-confirm": "Cet événement sera retiré.",
 		"open-day": "Ouvrir le {date}",

package/dist/lib/i18n/resources/resources.d.ts

@@ -1809,6 +1809,7 @@ export declare const resources: {
                 title: string;
                 description: string;
                 color: string;
+                edit: string;
                 delete: string;
                 "delete-confirm": string;
                 "open-day": string;
@@ -5325,6 +5326,7 @@ export declare const resources: {
                 title: string;
                 description: string;
                 color: string;
+                edit: string;
                 delete: string;
                 "delete-confirm": string;
                 "open-day": string;