@forgeroute/ui 0.4.57 → 0.4.58

package/types/forgeroute-ui.d.ts

@@ -1095,7 +1095,7 @@ export declare class SelectComponent implements ControlValueAccessor, Validator,
   readonly error: import("@angular/core").InputSignal<string>;
   /** Reveal the built-in error messages now (e.g. after a failed Save click), without waiting for blur. */
   readonly showErrors: import("@angular/core").InputSignal<boolean>;
-  readonly size: import("@angular/core").InputSignal<"default" | "sm">;
+  readonly size: import("@angular/core").InputSignal<"sm" | "default">;
   readonly _disabledInput: import("@angular/core").InputSignal<boolean>;
   private readonly _cvaDisabled;
   protected readonly disabled: import("@angular/core").Signal<boolean>;
@@ -2152,7 +2152,7 @@ export declare class SidePanelComponent implements OnDestroy {
   readonly cancelLabel: import("@angular/core").InputSignal<string>;
   /** Right-aligned primary action button label. Empty string = hidden. */
   readonly primaryLabel: import("@angular/core").InputSignal<string>;
-  readonly primaryVariant: import("@angular/core").InputSignal<"primary" | "danger" | "warning">;
+  readonly primaryVariant: import("@angular/core").InputSignal<"danger" | "warning" | "primary">;
   readonly primaryLoading: import("@angular/core").InputSignal<boolean>;
   readonly primaryDisabled: import("@angular/core").InputSignal<boolean>;
   /** `data-testid` of the Cancel button; none when empty (default). */
@@ -2260,7 +2260,7 @@ export declare class ModalComponent implements OnInit, OnDestroy {
   readonly title: import("@angular/core").InputSignal<string>;
   readonly description: import("@angular/core").InputSignal<string>;
   readonly maxWidth: import("@angular/core").InputSignal<string>;
-  readonly bodyOverflow: import("@angular/core").InputSignal<"hidden" | "auto" | "visible">;
+  readonly bodyOverflow: import("@angular/core").InputSignal<"auto" | "hidden" | "visible">;
   /** `data-testid` of the dialog element itself (the host `<ui-modal>` is always in the page, the dialog only while open). None when empty. */
   readonly dialogTestId: import("@angular/core").InputSignal<string>;
   /** Hides the header X button (e.g. while a request is running). Escape and a backdrop click still close unless `closable` is false. */
@@ -3963,7 +3963,7 @@ export declare class ButtonComponent {
    * `ghost-start`: a ghost button for list / section toggles - a full-width row with its content aligned to the start, transparent
    * background, hover tint and the normal focus ring. Pair it with `ariaExpanded` / `ariaPressed`; the label may contain a heading element.
    */
-  readonly variant: import("@angular/core").InputSignal<"primary" | "secondary" | "danger" | "warning" | "link" | "ghost" | "ghost-start" | "tab" | "icon" | "icon-danger">;
+  readonly variant: import("@angular/core").InputSignal<"link" | "danger" | "warning" | "primary" | "secondary" | "ghost" | "ghost-start" | "tab" | "icon" | "icon-danger">;
   /** Renders an anchor to this route instead of a button (use with `variant="link"` for an inline text link). `['/settings']` or `'/settings'`. While `disabled` or `loading` it renders a non-clickable `<span role="link" aria-disabled>` with no href (like `href`). */
   readonly routerLink: import("@angular/core").InputSignal<string | readonly unknown[] | null>;
   /** Query params of the `routerLink` (e.g. `{ section: 'deal-defaults' }`). */
@@ -3984,7 +3984,7 @@ export declare class ButtonComponent {
    */
   readonly href: import("@angular/core").InputSignal<string | null>;
   /** Where to open the `href` (`_blank` = a new tab). */
-  readonly target: import("@angular/core").InputSignal<"_self" | "_blank" | "_parent" | "_top" | null>;
+  readonly target: import("@angular/core").InputSignal<"_blank" | "_self" | "_parent" | "_top" | null>;
   /** `rel` of the `href` link. A `_blank` target always gets `noopener noreferrer` added. */
   readonly rel: import("@angular/core").InputSignal<string | null>;
   /** The href when it is allowed (http, https, mailto, tel, sms or a relative URL), else null. */
@@ -4008,8 +4008,8 @@ export declare class ButtonComponent {
   private readonly _narrow;
   readonly color: import("@angular/core").InputSignal<string | undefined>;
   readonly active: import("@angular/core").InputSignal<boolean>;
-  readonly size: import("@angular/core").InputSignal<"sm" | "md" | "lg" | "xs">;
-  readonly type: import("@angular/core").InputSignal<"reset" | "submit" | "button">;
+  readonly size: import("@angular/core").InputSignal<"xs" | "sm" | "md" | "lg">;
+  readonly type: import("@angular/core").InputSignal<"button" | "reset" | "submit">;
   readonly disabled: import("@angular/core").InputSignal<boolean>;
   readonly loading: import("@angular/core").InputSignal<boolean>;
   readonly fullWidth: import("@angular/core").InputSignal<boolean>;
@@ -4957,7 +4957,7 @@ export declare class TextInputComponent implements ControlValueAccessor, Validat
    * `search`, `text`, `none`). Empty (default) = the browser's default for the field, except `type="tel"`, which keeps `tel`.
    * It only picks the keyboard; it does not restrict what can be typed or pasted.
    */
-  readonly inputmode: import("@angular/core").InputSignal<"" | "none" | "text" | "search" | "email" | "tel" | "url" | "decimal" | "numeric">;
+  readonly inputmode: import("@angular/core").InputSignal<"" | "none" | "search" | "text" | "email" | "tel" | "url" | "decimal" | "numeric">;
   readonly readonly: import("@angular/core").InputSignal<boolean>;
   readonly hint: import("@angular/core").InputSignal<string>;
   /** Id(s) of an external element that also describes this control (e.g. one shared error text for a group of fields). Space separated; MERGED after the control's own hint / error id in `aria-describedby`, never replacing it. Empty = unchanged. */
@@ -6424,7 +6424,7 @@ export declare class DropdownComponent {
   readonly loader: import("@angular/core").InputSignal<(() => Promise<DropdownItem[]>) | null>;
   readonly active: import("@angular/core").InputSignal<boolean>;
   readonly activeValue: import("@angular/core").InputSignal<string>;
-  readonly variant: import("@angular/core").InputSignal<"badge" | "button">;
+  readonly variant: import("@angular/core").InputSignal<"button" | "badge">;
   readonly menuWidth: import("@angular/core").InputSignal<string>;
   /**
    * Fixed width of the trigger as a CSS length (e.g. `'280px'`). Empty (default) = the trigger is as wide as its label. When set, the trigger keeps that
@@ -6745,7 +6745,7 @@ export declare class FormRowComponent {
  * child simply takes the full width. Keep a numeric span within the row's `cols` (use `all` for the whole row).
  */
 export declare class FormColSpanDirective {
-  readonly uiColSpan: import("@angular/core").InputSignal<"" | "2" | "3" | 2 | 3 | "all">;
+  readonly uiColSpan: import("@angular/core").InputSignal<"" | "all" | "2" | 2 | "3" | 3>;
   protected readonly _class: import("@angular/core").Signal<string>;
   static ɵfac: i0.ɵɵFactoryDeclaration<FormColSpanDirective, never>;
   static ɵdir: i0.ɵɵDirectiveDeclaration<FormColSpanDirective, "[uiColSpan]", never, {
@@ -7862,9 +7862,9 @@ export declare class ChipGroupComponent {
   readonly spaceAbove: import("@angular/core").InputSignal<"none" | "sm" | "md">;
   /** Space below the chip group. */
   readonly spaceBelow: import("@angular/core").InputSignal<"none" | "sm" | "md">;
-  protected readonly _gap: import("@angular/core").Signal<"6px" | "12px" | "8px">;
-  protected readonly _spaceAbove: import("@angular/core").Signal<"0" | "6px" | "12px">;
-  protected readonly _spaceBelow: import("@angular/core").Signal<"0" | "6px" | "12px">;
+  protected readonly _gap: import("@angular/core").Signal<"12px" | "6px" | "8px">;
+  protected readonly _spaceAbove: import("@angular/core").Signal<"12px" | "0" | "6px">;
+  protected readonly _spaceBelow: import("@angular/core").Signal<"12px" | "0" | "6px">;
   static ɵfac: i0.ɵɵFactoryDeclaration<ChipGroupComponent, never>;
   static ɵcmp: i0.ɵɵComponentDeclaration<ChipGroupComponent, "ui-chip-group", never, {
     "gap": {
@@ -9657,7 +9657,7 @@ export declare class PdfHotspotComponent {
   /** `ready`: clickable; `blocked`: disabled (a prerequisite is missing); `signed`: shows `image`. */
   readonly state: import("@angular/core").InputSignal<"ready" | "blocked" | "signed">;
   /** `warning` gives the ready state an amber look (e.g. for initials), default is blue. */
-  readonly tone: import("@angular/core").InputSignal<"primary" | "warning">;
+  readonly tone: import("@angular/core").InputSignal<"warning" | "primary">;
   /** Text of the ready button (e.g. "Sign Here"). */
   readonly label: import("@angular/core").InputSignal<string>;
   /** Text of the blocked button (e.g. "Add signature above"). */
@@ -12919,4 +12919,251 @@ export declare const DEFAULT_EMAIL_TEMPLATE_VARIABLE_GROUPS: {
  * Content-Security-Policy meta blocks scripts and anything but images / inline styles, and links open nowhere (sandbox, no popups).
  */
 export declare function buildPreviewDocument(bodyHtml: string): string;
+export type ShareOption = 'native' | 'facebook' | 'x' | 'linkedin' | 'email' | 'gmail' | 'outlook' | 'copy';
+interface ShareTile {
+  value: ShareOption;
+  label: string;
+  background: string;
+}
+/**
+ * "Share" control for a public page (an obituary, a blog post, any shareable item). The button opens a floating panel (over the page, so nothing moves)
+ * with one round icon per option and its name underneath, in a row like a phone's share sheet. Phones and tablets get Facebook, X,
+ * LinkedIn, Email (their mail app), Copy link and "More" (the device's own share sheet). Desktops get Gmail and Outlook instead of Email:
+ * a `mailto:` link does nothing on a computer without a mail app, while the webmail compose windows always open. "Link copied" is the library toast. The link is the public page
+ * of the item (never an `?embed=true` widget URL). Theming: `--ui-share-accent` (focus ring and the Copy link tile; default the library `--primary`).
+ *
+ *   <ui-share-menu [url]="pageUrl" [title]="post.title" label="blog post" />
+ */
+export declare class ShareMenuComponent {
+  /** The public page link to share. */
+  readonly url: import("@angular/core").InputSignal<string>;
+  /** The headline: the item's name or title (the X text, the email subject and the share-sheet title). */
+  readonly title: import("@angular/core").InputSignal<string>;
+  /** Used in the accessible name, e.g. "obituary" or "blog post" (→ "Share obituary"). */
+  readonly label: import("@angular/core").InputSignal<string>;
+  /** Unique id of the floating panel (several menus can be on one page). */
+  protected readonly panelId: string;
+  private readonly doc;
+  private readonly toast;
+  private readonly injector;
+  private readonly host;
+  private readonly trigger;
+  private readonly panel;
+  readonly open: import("@angular/core").WritableSignal<boolean>;
+  /** Pixels the panel is moved sideways so it never runs off either edge of the screen (or of the embedding frame). */
+  readonly shiftX: import("@angular/core").WritableSignal<number>;
+  /**
+   * "More" opens the device's own share sheet (Messages, AirDrop, Mail, WhatsApp…). It is offered on touch devices only: a desktop
+   * browser has the other options already, and its share sheet is limited (or absent), so "More" there would look broken.
+   */
+  private readonly isTouchDevice;
+  private readonly canNativeShare;
+  readonly tiles: import("@angular/core").Signal<ShareTile[]>;
+  /** The link each option opens (social sites in a new tab; the mail app in this window). */
+  readonly links: import("@angular/core").Signal<{
+    facebook: string;
+    x: string;
+    linkedin: string;
+    email: string;
+    gmail: string;
+    outlook: string;
+  }>;
+  toggle(event: Event): void;
+  private show;
+  close(returnFocus?: boolean): void;
+  onEscape(): void;
+  onDocumentClick(event: Event): void;
+  onFocusOut(event: FocusEvent): void;
+  /** Left / Right / Home / End move between the options. */
+  onPanelKeydown(event: KeyboardEvent): void;
+  choose(option: ShareOption): void;
+  private nativeShare;
+  /** Phones and tablets: opens the device's mail app with the subject and body filled in. */
+  private email;
+  private copy;
+  private legacyCopy;
+  static ɵfac: i0.ɵɵFactoryDeclaration<ShareMenuComponent, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<ShareMenuComponent, "ui-share-menu", never, {
+    "url": {
+      "alias": "url";
+      "required": true;
+      "isSignal": true;
+    };
+    "title": {
+      "alias": "title";
+      "required": true;
+      "isSignal": true;
+    };
+    "label": {
+      "alias": "label";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {}, never, never, true, never>;
+}
+/**
+ * The links the public Share control builds. Pure functions so the component and its spec produce the exact same text.
+ * Every value is URL-encoded, so a title holding `&`, `#`, quotes or non-ASCII text can never break out of its query parameter.
+ */
+export declare const facebookShareUrl: (url: string) => string;
+export declare const xShareUrl: (url: string, text: string) => string;
+export declare const linkedInShareUrl: (url: string) => string;
+/** Gmail's compose window (a new tab) with the subject and body filled in: for desktop visitors, who often have no mail app for `mailto:`. */
+export declare const gmailShareUrl: (url: string, title: string) => string;
+/** Outlook.com's compose window (a new tab) with the subject and body filled in. */
+export declare const outlookShareUrl: (url: string, title: string) => string;
+/** `mailto:` with the title as the subject and the title plus the link as the body (encodeURIComponent, never `+` for spaces). */
+export declare const emailShareUrl: (url: string, title: string) => string;
+export type SnackbarType = 'success' | 'error' | 'info';
+/** An optional button inside a snackbar (e.g. "View"): clicking it runs `callback` and closes the snackbar. */
+export interface SnackbarAction {
+  label: string;
+  callback: () => void;
+}
+export interface SnackbarMessage {
+  id: number;
+  message: string;
+  type: SnackbarType;
+  action?: SnackbarAction;
+}
+/**
+ * Stacked, top-right notifications: several can be on screen at once, each closes itself after `duration` ms (0 = stays until closed)
+ * and can carry one action button. Render them once, near the root of the app, with `<ui-snackbar />`.
+ * (`ToastService` / `<ui-toast>` is the single bottom-centre message; this is the stack with actions.)
+ */
+export declare class SnackbarService {
+  private readonly _messages;
+  private nextId;
+  private readonly timers;
+  /** The messages on screen, oldest first (a copy). */
+  messages$(): SnackbarMessage[];
+  showSuccess(message: string, duration?: number): void;
+  showError(message: string, duration?: number): void;
+  showInfo(message: string, duration?: number, action?: SnackbarAction): void;
+  private show;
+  dismiss(id: number): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<SnackbarService, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+/**
+ * The on-screen stack of `SnackbarService` messages (top-right, above the page). Put one `<ui-snackbar />` near the root of the app.
+ * Each message is a library `ui-alert` (green success, red error, blue info) with a close button and, when the message has one, an
+ * action button. Test ids: `success-message` / `error-message` / `info-message` on each message, `snackbar-action` on the action button.
+ */
+export declare class SnackbarComponent {
+  private readonly service;
+  /** The messages on screen. */
+  protected readonly messages: import("@angular/core").Signal<SnackbarMessage[]>;
+  protected variant(m: SnackbarMessage): 'success' | 'danger' | 'info';
+  protected dismiss(id: number): void;
+  /** Runs the action, then closes the message. */
+  protected runAction(m: SnackbarMessage, callback: () => void): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<SnackbarComponent, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<SnackbarComponent, "ui-snackbar", never, {}, {}, never, never, true, never>;
+}
+/**
+ * A banner across the top of the page while the browser is offline (`navigator.onLine`, kept current by the window's `online` /
+ * `offline` events). The user can dismiss it; it comes back the next time the connection drops. Put one near the root of the app:
+ *
+ *   <ui-offline-banner />
+ *
+ * `offline` overrides the browser's own state (for an app that does its own connectivity check). Texts can be changed with `title`
+ * and `message`. Test ids: `offline-banner`, `offline-banner-dismiss`.
+ */
+export declare class OfflineBannerComponent {
+  readonly title: import("@angular/core").InputSignal<string>;
+  readonly message: import("@angular/core").InputSignal<string>;
+  /** Forces the state (true = offline); `null` (default) follows the browser. */
+  readonly offline: import("@angular/core").InputSignal<boolean | null>;
+  private readonly browserOffline;
+  private readonly dismissed;
+  protected readonly isOffline: import("@angular/core").Signal<boolean>;
+  protected readonly visible: import("@angular/core").Signal<boolean>;
+  constructor();
+  protected dismiss(): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<OfflineBannerComponent, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<OfflineBannerComponent, "ui-offline-banner", never, {
+    "title": {
+      "alias": "title";
+      "required": false;
+      "isSignal": true;
+    };
+    "message": {
+      "alias": "message";
+      "required": false;
+      "isSignal": true;
+    };
+    "offline": {
+      "alias": "offline";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {}, never, never, true, never>;
+}
+export type ReminderAlertTone = 'danger' | 'warning' | 'info' | 'neutral';
+export interface ReminderAlertAction {
+  /** Reported by `(action)`; also part of the button's test id (`alert-<id>`). */
+  id: string;
+  label: string;
+  variant?: 'primary' | 'secondary' | 'ghost';
+}
+/** One in-app alert: a due reminder, an event starting soon, anything the user should notice now. The HOST decides what is due and what the buttons do. */
+export interface ReminderAlertItem {
+  id: string;
+  tone: ReminderAlertTone;
+  /** Small uppercase line above the title, e.g. "Overdue Reminder". */
+  label: string;
+  title: string;
+  /** Plain lines under the title (case name, description, due date…). */
+  lines?: string[];
+  /** A small purple pill under the title, e.g. the organization that created the item. */
+  badge?: {
+    label: string;
+    ariaLabel?: string;
+    testId?: string;
+  };
+  actions?: ReminderAlertAction[];
+  /** Accessible name of the hide (X) button; default "Hide alert". */
+  hideLabel?: string;
+  /** Test id of the hide button; default `alert-hide`. */
+  hideTestId?: string;
+}
+/**
+ * The stack of in-app alerts in the top-right corner (above the page, newest app state wins: the host passes the list). Each alert is a
+ * library `ui-alert` with a coloured tone, its label / title / lines, an optional badge, action buttons and a hide (X) button:
+ *
+ *   <ui-reminder-alerts [items]="alerts()" (action)="onAction($event)" (hidden)="hide($event)" />
+ *
+ * `(action)` gives `{ item, actionId }`; `(hidden)` gives the item. The component keeps no state: the host removes an item from `items`
+ * to make it go away (hiding, completing, snoozing are the host's rules). Nothing is drawn for an empty list.
+ */
+export declare class ReminderAlertsComponent {
+  readonly items: import("@angular/core").InputSignal<ReminderAlertItem[]>;
+  /** Accessible name of the region. */
+  readonly ariaLabel: import("@angular/core").InputSignal<string>;
+  /** An action button was clicked. */
+  readonly action: import("@angular/core").OutputEmitterRef<{
+    item: ReminderAlertItem;
+    actionId: string;
+  }>;
+  /** The hide (X) button was clicked. */
+  readonly hidden: import("@angular/core").OutputEmitterRef<ReminderAlertItem>;
+  protected variant(item: ReminderAlertItem): AlertVariant;
+  static ɵfac: i0.ɵɵFactoryDeclaration<ReminderAlertsComponent, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<ReminderAlertsComponent, "ui-reminder-alerts", never, {
+    "items": {
+      "alias": "items";
+      "required": false;
+      "isSignal": true;
+    };
+    "ariaLabel": {
+      "alias": "ariaLabel";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {
+    "action": "action";
+    "hidden": "hidden";
+  }, never, never, true, never>;
+}
 export type { CalendarDay, CalendarRange, CalendarViewMode };