@joanroucoux/cairn-ui 0.9.2 → 0.10.1

package/types/joanroucoux-cairn-ui-async.d.ts

@@ -6,14 +6,14 @@ type AsyncState = (typeof ASYNC_STATES)[number];
 /** Looks of the error block. */
 export declare const ASYNC_VARIANTS: readonly ["elevated", "plain", "emphasis", "inline"];
 type AsyncVariant = (typeof ASYNC_VARIANTS)[number];
-/** Alignments of the error block; `auto` is centred from 64rem. */
+/** Alignments of the error block; `auto` is centered from 64rem. */
 export declare const ASYNC_ALIGNS: readonly ["start", "center", "auto"];
 type AsyncAlign = (typeof ASYNC_ALIGNS)[number];
 /**
  * The three states of a block that depends on a service call, next to the ready content.
  *
  * @example
- * <ui-async [state]="totalState()" errorTitle="Total could not be loaded" errorMessage="The server did not answer." retryLabel="Retry" (retry)="reload()">
+ * <ui-async [state]="totalState()" errorTitle="The total couldn’t be loaded" errorMessage="The server didn’t respond." retryLabel="Try again" (retry)="reload()">
  *   <span asyncLoading><ui-skeleton shape="figure" /></span>
  *   <span asyncEmpty>Add a holding to see your total.</span>
  *   <span>{{ total() }}</span>
@@ -25,7 +25,7 @@ export declare class UiAsync {
   readonly errorTitle: import("@angular/core").InputSignal<string | undefined>;
   readonly errorMessage: import("@angular/core").InputSignal<string | undefined>;
   readonly retryLabel: import("@angular/core").InputSignal<string | undefined>;
-  /** Draws the rotate icon in the retry button. Only the `inline` variant honours `false`. */
+  /** Draws the rotate icon in the retry button. Only the `inline` variant honors `false`. */
   readonly retryIcon: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
   readonly variant: import("@angular/core").InputSignal<"elevated" | "plain" | "emphasis" | "inline">;
   readonly align: import("@angular/core").InputSignal<"start" | "center" | "auto">;

package/types/joanroucoux-cairn-ui-choice-chips.d.ts

@@ -10,10 +10,10 @@ type ChoiceChipOption = {
  * with `[formField]`.
  *
  * @example
- * <ui-choice-chips label="Envelope" [options]="envelopes" [(value)]="envelope" />
+ * <ui-choice-chips label="Wrapper" [options]="wrappers" [(value)]="wrapper" />
  *
  * @example
- * <ui-choice-chips label="Envelope" [options]="envelopes" [formField]="form.envelope" />
+ * <ui-choice-chips label="Wrapper" [options]="wrappers" [formField]="form.wrapper" />
  */
 export declare class UiChoiceChips implements UiControl {
   #private;

package/types/joanroucoux-cairn-ui-dialog.d.ts

@@ -1,6 +1,7 @@
 import * as i0 from "@angular/core";
 import { OutputEmitterRef, Signal } from "@angular/core";
 type SharedReason = 'escape' | 'backdrop' | 'cross' | 'programmatic';
+/** @internal */
 type ModalCloseConfig<R extends string> = {
   readonly open: Signal<boolean>;
   readonly busy: Signal<boolean>;
@@ -14,6 +15,8 @@ type ModalCloseConfig<R extends string> = {
  * Escape and a press-and-release on the veil close it unless `busy`, `dismissed` reports a close the user asked for
  * and `closed` its reason once the exit transition has played. `opening` runs just before `showModal()`. Must be
  * created in an injection context.
+ *
+ * @internal Shared by `ui-dialog` and `ui-drawer`, not meant for applications.
  */
 export declare class ModalClose<R extends string> {
   #private;

package/types/joanroucoux-cairn-ui-donut.d.ts

@@ -29,7 +29,7 @@ declare function positionSlices(slices: RankedSlice[]): PositionedSlice[];
  * activating a legend row highlights its slice.
  *
  * @example
- * <ui-donut [slices]="byAssetClass()" label="Par classe d'actif" othersLabel="Autres" [valueFormat]="formatEur" [shareFormat]="formatShare" (sliceSelect)="goToHoldings($event)" />
+ * <ui-donut [slices]="byAssetClass()" label="By asset class" othersLabel="Other" [valueFormat]="formatEur" [shareFormat]="formatShare" (sliceSelect)="goToHoldings($event)" />
  */
 export declare class UiDonut {
   readonly slices: import("@angular/core").InputSignal<DonutSlice[]>;

package/types/joanroucoux-cairn-ui-drawer.d.ts

@@ -10,7 +10,7 @@ type DrawerCloseReason = (typeof DRAWER_CLOSE_REASONS)[number];
  * With both, `label` names the panel and the heading stays its visible title.
  *
  * @example
- * <ui-drawer heading="Northwind Monde" closeLabel="Fermer le détail" [open]="open()" (dismissed)="open.set(false)">
+ * <ui-drawer heading="Northwind World" closeLabel="Close the detail" [open]="open()" (dismissed)="open.set(false)">
  *   <p>Body</p>
  * </ui-drawer>
  */

package/types/joanroucoux-cairn-ui-empty.d.ts

@@ -1,10 +1,10 @@
 import * as i0 from "@angular/core";
 /**
- * Centred empty state: a title, a hint and an action slot, such as a search that matches nothing.
+ * Centered empty state: a title, a hint and an action slot, such as a search that matches nothing.
  *
  * @example
- * <ui-empty heading="Aucune ligne ne correspond à « zzz »" hint="La recherche porte sur le nom et l'ISIN.">
- *   <button ui-button variant="outline" size="md" type="button">Ajouter une ligne</button>
+ * <ui-empty heading="No holding matches “zzz”" hint="Search covers the name and the ISIN.">
+ *   <button ui-button variant="outline" size="md" type="button">Add a holding</button>
  * </ui-empty>
  */
 export declare class UiEmpty {

package/types/joanroucoux-cairn-ui-fact.d.ts

@@ -2,7 +2,7 @@ import * as i0 from "@angular/core";
 /** Available fact row sizes. */
 export declare const FACT_SIZES: readonly ["md", "sm", "auto", "recap"];
 type FactSize = (typeof FACT_SIZES)[number];
-/** Colour of the line under a fact value. `stale` flags an out-of-date figure. */
+/** Color of the line under a fact value. `stale` flags an out-of-date figure. */
 export declare const FACT_SUB_TONES: readonly ["subtle", "stale"];
 type FactSubTone = (typeof FACT_SUB_TONES)[number];
 /**

package/types/joanroucoux-cairn-ui-group-header.d.ts

@@ -8,7 +8,7 @@ import * as i0 from "@angular/core";
  * changes nothing (a filter holds the group open). `controls` is the id of the body it folds.
  *
  * @example
- * <ui-group-header name="Northwind PEA" meta="PEA · 3 lignes" collapsible [(expanded)]="open">
+ * <ui-group-header name="Northwind PEA" meta="PEA · 3 holdings" collapsible [(expanded)]="open">
  *   <ui-amount [value]="total" />
  * </ui-group-header>
  */

package/types/joanroucoux-cairn-ui-icon-toggle.d.ts

@@ -0,0 +1,13 @@
+import * as i0 from "@angular/core";
+/**
+ * Round icon button that switches something on and off, such as the header eye that hides the amounts.
+ * The state lives in `aria-pressed`, which also draws the soft fill. Only the press scale transitions:
+ * the fill changes at once.
+ *
+ * @example
+ * <button uiIconToggle aria-label="Hide amounts" [attr.aria-pressed]="hidden"><svg>...</svg></button>
+ */
+export declare class UiIconToggle {
+  static ɵfac: i0.ɵɵFactoryDeclaration<UiIconToggle, never>;
+  static ɵdir: i0.ɵɵDirectiveDeclaration<UiIconToggle, "button[uiIconToggle]", never, {}, {}, never, never, true, never>;
+}

package/types/joanroucoux-cairn-ui-input.d.ts

@@ -3,10 +3,13 @@ import * as i0 from "@angular/core";
 /** Available control sizes. */
 export declare const CONTROL_SIZES: readonly ["sm", "md", "lg", "xl"];
 type ControlSize = (typeof CONTROL_SIZES)[number];
+/** @internal Shared with `select` and `choice-chips`. */
 export declare const CONTROL_BASE_CLASSES = "w-full rounded-control px-3 text-body text-(--foreground) shadow-[inset_0_0_0_1px_var(--border)] placeholder:text-(--muted-foreground) focus-visible:shadow-[inset_0_0_0_2px_var(--ring)] aria-invalid:shadow-[inset_0_0_0_2px_var(--negative)] disabled:cursor-not-allowed disabled:opacity-50";
 export declare const CONTROL_SURFACES: readonly ["background", "card"];
 type ControlSurface = (typeof CONTROL_SURFACES)[number];
+/** @internal Shared with `select` and `choice-chips`. */
 export declare const CONTROL_SURFACE_CLASSES: Record<ControlSurface, string>;
+/** @internal Shared with `select` and `choice-chips`. */
 export declare const CONTROL_SIZE_CLASSES: Record<ControlSize, string>;
 /**
  * Styled native text input. The host stays a plain `<input>`, so every forms flavor and native

package/types/joanroucoux-cairn-ui-menu.d.ts

@@ -4,7 +4,7 @@ import * as i0 from "@angular/core";
  * choice (`menuitemradio`): the current one carries a check mark and `aria-checked="true"`.
  *
  * @example
- * <button uiMenuItem destructive (click)="remove()">Delete the line</button>
+ * <button uiMenuItem destructive (click)="remove()">Delete the holding</button>
  * <button uiMenuItem [checked]="account() === 'pea'" (click)="account.set('pea')">Northwind PEA</button>
  */
 export declare class UiMenuItem {
@@ -37,9 +37,9 @@ export declare class UiMenuItem {
  *
  * @example
  * <button ui-button size="icon" aria-label="More" [uiMenuTrigger]="menu">...</button>
- * <ui-menu #menu label="Line actions">
+ * <ui-menu #menu label="Holding actions">
  *   <button uiMenuItem (click)="edit()">Edit</button>
- *   <button uiMenuItem destructive (click)="remove()">Delete the line</button>
+ *   <button uiMenuItem destructive (click)="remove()">Delete the holding</button>
  * </ui-menu>
  */
 export declare class UiMenu {

package/types/joanroucoux-cairn-ui-result-group.d.ts

@@ -4,10 +4,10 @@ import * as i0 from "@angular/core";
  * message when it has nothing, or an inline error with a retry.
  *
  * @example
- * <ui-result-group label="Yahoo Finance" hint="cours en continu" [state]="state()"
- *   errorMessage="Yahoo Finance n'a pas répondu." retryLabel="Réessayer" (retry)="search()">
+ * <ui-result-group label="Yahoo Finance" hint="live prices" [state]="state()"
+ *   errorMessage="Yahoo Finance didn’t respond." retryLabel="Try again" (retry)="search()">
  *   <button ui-row size="dense" type="button">...</button>
- *   <span resultGroupMessage>Aucun résultat chez Yahoo Finance.</span>
+ *   <span resultGroupMessage>No results from Yahoo Finance.</span>
  * </ui-result-group>
  */
 export declare class UiResultGroup {

package/types/joanroucoux-cairn-ui-row.d.ts

@@ -109,7 +109,7 @@ export declare class UiListRow {
  *
  * @example
  * <div uiRowGroup>
- *   <button ui-row type="button" trailing="chevron">Saisir à la main</button>
+ *   <button ui-row type="button" trailing="chevron">Enter manually</button>
  * </div>
  */
 export declare class UiRowGroup {

package/types/joanroucoux-cairn-ui-stale-link.d.ts

@@ -4,11 +4,11 @@ export declare const STALE_LINK_SIZES: readonly ["caption", "label"];
 type StaleLinkSize = (typeof STALE_LINK_SIZES)[number];
 /**
  * Link in the stale tone, for a caption about data that is late or left out of a total, such as
- * "1 ligne sans cours, non comptée". `chevron` adds a trailing chevron, `size` is `caption` (the
+ * "1 holding without a price, not counted". `chevron` adds a trailing chevron, `size` is `caption` (the
  * default) or `label`.
  *
  * @example
- * <a uiStaleLink chevron size="label" routerLink="/holdings">1 cours en retard</a>
+ * <a uiStaleLink chevron size="label" routerLink="/holdings">1 stale price</a>
  */
 export declare class UiStaleLink {
   readonly chevron: import("@angular/core").InputSignalWithTransform<boolean, unknown>;

package/types/joanroucoux-cairn-ui-table.d.ts

@@ -139,7 +139,12 @@ export declare class UiTh {
     };
   }, {}, never, never, true, never>;
 }
-/** Body cell. Same inputs as `UiTh` bar `tall` and `width`, which must be set on both to match. */
+/**
+ * Body cell. Same inputs as `UiTh` bar `tall` and `width`, which must be set on both to match.
+ *
+ * @example
+ * <td uiTd numeric secondary>12</td>
+ */
 export declare class UiTd {
   readonly numeric: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
   readonly primary: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
@@ -240,10 +245,10 @@ export declare class UiGroupCell {
 /**
  * Makes a link or button the way into its row: by default it stretches over the whole row, so the
  * row is one target. With `[stretch]="false"` only the name is the target. `current` marks the open
- * line. Other controls in the row need `uiRowAction` to stay clickable.
+ * holding. Other controls in the row need `uiRowAction` to stay clickable.
  *
  * @example
- * <td uiTd primary><a uiRowLink href="/lines/42">Ferrari</a></td>
+ * <td uiTd primary><a uiRowLink href="/holdings/42">Ferrari</a></td>
  * <td uiTd primary><a uiRowLink [stretch]="false" href="/accounts/3">Brokerage</a></td>
  */
 export declare class UiRowLink {
@@ -264,7 +269,12 @@ export declare class UiRowLink {
     };
   }, {}, never, never, true, never>;
 }
-/** A control in another cell of a stretched-link row: keeps it clickable above the row-wide link. */
+/**
+ * A control in another cell of a stretched-link row: keeps it clickable above the row-wide link.
+ *
+ * @example
+ * <td uiTd><button uiRowAction type="button">Enter a price</button></td>
+ */
 export declare class UiRowAction {
   static ɵfac: i0.ɵɵFactoryDeclaration<UiRowAction, never>;
   static ɵdir: i0.ɵɵDirectiveDeclaration<UiRowAction, "[uiRowAction]", never, {}, {}, never, never, true, never>;
@@ -277,8 +287,8 @@ type SubTone = (typeof SUB_TONES)[number];
  * back by `secondary` columns.
  *
  * @example
- * <span uiCellSub narrow>10 × 421.26 € · cost 388.10 €</span>
- * <span uiCellSub tone="stale">Quote of 24/09</span>
+ * <span uiCellSub narrow>10 × 421,26 € · Avg. cost 388,10 €</span>
+ * <span uiCellSub tone="stale">Price as of 24/09</span>
  */
 export declare class UiCellSub {
   readonly narrow: import("@angular/core").InputSignalWithTransform<boolean, unknown>;

package/types/joanroucoux-cairn-ui-toast.d.ts

@@ -13,8 +13,8 @@ type Toast = {
  * One-slot message queue read by `ui-toaster`: a confirmation that times out, or an error that stays until closed.
  *
  * @example
- * inject(UiToasts).show('Achat enregistré');
- * inject(UiToasts).showError("Échec de l'import");
+ * inject(UiToasts).show('Purchase recorded');
+ * inject(UiToasts).showError('Import failed');
  */
 export declare class UiToasts {
   private readonly current;
@@ -28,7 +28,7 @@ export declare class UiToasts {
 }
 /**
  * Message shown by `UiToasts`: one at a time, no action. A confirmation (`show`) is gone after `--toast-duration`;
- * an error (`showError`) stays until its cross is clicked. Centred at the bottom of the content area: from `64rem`
+ * an error (`showError`) stays until its cross is clicked. Centered at the bottom of the content area: from `64rem`
  * between `--sidebar-width` (0 when unset) and the right edge.
  * Place it once in the app shell.
  *