@nxgt/material 3.68.0 → 3.71.0

package/dist/lib/components/ui/feedback/confirm-dialog/action-refusal.d.ts

@@ -0,0 +1,24 @@
+import { ReactNode } from 'react';
+/** An action offered beside a message: a link (`href`, a full page load) or a handler (`onAction`, for client-side navigation), with its label. `onAction` wins when both are given. */
+export type RecordAction = {
+    label: string;
+    href?: string;
+    onAction?: () => void;
+};
+/**
+ * A refusal that carries an action ("Remove the 3 invoices", "View what
+ * blocks it") and optional details. An `onConfirm` (or a record action's `send`) rejects with it; a plain
+ * `Error` keeps showing its message only.
+ */
+export declare class ActionRefusal extends Error {
+    readonly action: RecordAction;
+    readonly details?: ReactNode;
+    constructor(message: string, options: {
+        action: RecordAction;
+        details?: ReactNode;
+    });
+}
+/** Whether `thrown` is an `ActionRefusal` (also one from another copy of the package). */
+export declare function isActionRefusal(thrown: unknown): thrown is ActionRefusal;
+/** The action a refusal carries, if any. */
+export declare function refusalActionOf(thrown: unknown): RecordAction | undefined;

package/dist/lib/components/ui/feedback/confirm-dialog/confirm-alert.d.ts

@@ -0,0 +1,17 @@
+import { ReactNode } from 'react';
+/** What `ConfirmDialog`'s `refusal` receives when `onConfirm` has refused. */
+export interface ConfirmRefusalContext {
+    /** The thrown error's message, or the translated `material.confirm-dialog.failed` text. */
+    message: string;
+    /** What `onConfirm` threw. */
+    cause: unknown;
+    /** Closes the dialog, so a link in the refusal can dismiss it on navigation. */
+    close: () => void;
+}
+/**
+ * The error alert of a refused confirm: the message, or what `refusal` makes
+ * of it.
+ */
+export declare function ConfirmAlert({ message, cause, close, refusal, }: ConfirmRefusalContext & {
+    refusal?: (refusal: ConfirmRefusalContext) => ReactNode;
+}): import("react").JSX.Element;

package/dist/lib/components/ui/feedback/confirm-dialog/confirm-description.d.ts

@@ -0,0 +1,10 @@
+import { ReactNode } from 'react';
+/**
+ * What describes a confirm dialog (`aria-describedby`): the description and
+ * the `details` note. A plain string alone is a paragraph; block content or a
+ * note goes in a `div`, so block children are valid HTML.
+ */
+export declare function ConfirmDescription({ children, details, }: {
+    children: ReactNode;
+    details?: ReactNode;
+}): import("react").JSX.Element;

package/dist/lib/components/ui/feedback/confirm-dialog/confirm-dialog.d.ts

@@ -1,9 +1,23 @@
+import { ReactNode } from 'react';
 import { ButtonVariant } from '../../actions/button/button.js';
+import { ConfirmRefusalContext } from './confirm-alert.js';
+export type { ConfirmRefusalContext };
 export interface ConfirmDialogProps {
     open: boolean;
     onOpenChange: (open: boolean) => void;
     title: string;
-    description: string;
+    /**
+     * The text under the title. A string renders in a paragraph; any other node
+     * (several paragraphs, a list, a link) renders in a `div`, so block children
+     * are valid HTML. Either way it names the dialog (`aria-describedby`).
+     */
+    description: ReactNode;
+    /**
+     * A note under the description, for what the user should know before
+     * confirming (what else is affected, what cannot be undone). It is part of
+     * what describes the dialog.
+     */
+    details?: ReactNode;
     confirmLabel?: string;
     cancelLabel?: string;
     /**
@@ -28,6 +42,14 @@ export interface ConfirmDialogProps {
      * dialog reopens. Off by default: the refused action may be retried.
      */
     lockOnRefusal?: boolean;
+    /**
+     * Renders the refusal inside the dialog's error alert instead of the plain
+     * message, so it can carry a link (to the records that block a delete, for
+     * example). Receives the message, what `onConfirm` threw and `close()`. The alert keeps `role="alert"`.
+     * By default an `ActionRefusal` thrown by `onConfirm` shows its details and
+     * its action under the message; any other error shows its message.
+     */
+    refusal?: (refusal: ConfirmRefusalContext) => ReactNode;
     /**
      * Called as the dialog closes, before the focus goes back to what opened
      * it. `event.preventDefault()` places the focus yourself, for example
@@ -36,4 +58,4 @@ export interface ConfirmDialogProps {
      */
     onCloseAutoFocus?: (event: Event) => void;
 }
-export declare function ConfirmDialog({ open, onOpenChange, title, description, confirmLabel, cancelLabel, cancelVariant, onConfirm, variant, loading, confirmDisabled, lockOnRefusal, onCloseAutoFocus, }: ConfirmDialogProps): import("react").JSX.Element;
+export declare function ConfirmDialog({ open, onOpenChange, title, description, details, confirmLabel, cancelLabel, cancelVariant, onConfirm, variant, loading, confirmDisabled, lockOnRefusal, refusal, onCloseAutoFocus, }: ConfirmDialogProps): import("react").JSX.Element;

package/dist/lib/components/ui/feedback/confirm-dialog/confirm-refusal.d.ts

@@ -0,0 +1,7 @@
+import { ConfirmRefusalContext } from './confirm-alert.js';
+/**
+ * The default refusal of `ConfirmDialog`: the message, and for an
+ * `ActionRefusal` its details and its action. Any other error is its
+ * message alone.
+ */
+export declare function ConfirmRefusal({ message, cause, close, }: ConfirmRefusalContext): import("react").JSX.Element;

package/dist/lib/components/ui/feedback/confirm-dialog/index.d.ts

@@ -1 +1,2 @@
+export { ActionRefusal, isActionRefusal, type RecordAction, } from './action-refusal.js';
 export * from './confirm-dialog.js';

package/dist/lib/components/ui/feedback/confirm-dialog/use-confirm-action.d.ts

@@ -11,6 +11,12 @@ export declare function useConfirmAction({ open, onOpenChange, onConfirm, }: {
 }): {
     pending: boolean;
     error: string | null;
+    cause: unknown;
     handleOpenChange: (value: boolean) => void;
     handleConfirm: (event: MouseEvent<HTMLButtonElement>) => Promise<void>;
 };
+/**
+ * A ref for a modal's content that takes the focus while `pending`: the
+ * buttons it disables would otherwise drop the focus to the page behind it.
+ */
+export declare function useKeepFocusWhile(pending: boolean): import('react').RefObject<HTMLDivElement | null>;

package/dist/lib/components/ui/feedback/index.d.ts

@@ -18,6 +18,7 @@ export * from './progress/index.js';
 export * from './scroll-progress/index.js';
 export * from './skeleton/index.js';
 export * from './spinner/index.js';
+export * from './stale-notice/index.js';
 export * from './step-dots/index.js';
 export * from './step-up-dialog/index.js';
 export * from './toast/index.js';

package/dist/lib/components/ui/feedback/stale-notice/index.d.ts

@@ -0,0 +1 @@
+export * from './stale-notice.js';

package/dist/lib/components/ui/feedback/stale-notice/stale-notice.d.ts

@@ -0,0 +1,15 @@
+export interface StaleNoticeProps {
+    /** Runs on "Reload the record": read the record again. */
+    onReload: () => void;
+    /** Shows the reload button as loading while the record is read again. */
+    busy?: boolean;
+    /** Replaces the description (translated by default). */
+    message?: string;
+    className?: string;
+}
+/**
+ * Another write came first (a `stale-version` refusal): what was typed stays,
+ * a warning alert takes the focus and scrolls into view when it mounts, and
+ * the only way out is to read the record again. There is no "overwrite".
+ */
+export declare function StaleNotice({ onReload, busy, message, className, }: StaleNoticeProps): import("react").JSX.Element;