@nibapp/ui 0.0.0-stage → 0.1.0

package/dist/i18n/strings/index.d.ts

@@ -0,0 +1,314 @@
+declare const en: {
+    money: {
+        spokenDust: (p: {
+            amount: string;
+        }) => string;
+    };
+    imageViewer: {
+        open: (p: {
+            alt: string;
+        }) => string;
+        untitled: string;
+        position: (p: {
+            index: number;
+            total: number;
+        }) => string;
+        previous: string;
+        next: string;
+        zoomIn: string;
+        zoomOut: string;
+        fit: string;
+        actualSize: string;
+        copy: string;
+        copied: string;
+        copyFailed: string;
+        save: string;
+        loading: string;
+        failed: string;
+        tooLarge: (p: {
+            size?: string | undefined;
+        }) => string;
+        remote: (p: {
+            host: string;
+        }) => string;
+        remoteHost: (p: {
+            host: string;
+        }) => string;
+        openInBrowser: string;
+    };
+    time: {
+        now: string;
+        yesterday: string;
+        millisecondsShort: (p: {
+            value: string;
+        }) => string;
+        secondsShort: (p: {
+            value: string;
+        }) => string;
+        minutesSecondsShort: (p: {
+            minutes: string;
+            seconds: string;
+        }) => string;
+        hoursMinutesShort: (p: {
+            hours: string;
+            minutes: string;
+        }) => string;
+        minutesShort: (p: {
+            value: string;
+        }) => string;
+        hoursShort: (p: {
+            value: string;
+        }) => string;
+        daysShort: (p: {
+            value: string;
+        }) => string;
+        minutes: (p: {
+            count: number;
+        }) => string;
+        hours: (p: {
+            count: number;
+        }) => string;
+        days: (p: {
+            count: number;
+        }) => string;
+    };
+    alertDialog: {
+        confirm: string;
+        cancel: string;
+    };
+    combobox: {
+        clearSelection: string;
+        showOptions: string;
+        remove: string;
+        removeItem: (p: {
+            label: string;
+        }) => string;
+        noMatches: string;
+    };
+    commandPalette: {
+        placeholder: string;
+        label: string;
+        loadingResults: string;
+        searching: string;
+        noResults: string;
+        nothingMatches: (p: {
+            query: string;
+        }) => string;
+        hints: {
+            navigate: string;
+            select: string;
+            close: string;
+        };
+    };
+    kbd: {
+        keys: {
+            ctrl: string;
+            alt: string;
+            shift: string;
+            enter: string;
+            esc: string;
+            tab: string;
+            space: string;
+        };
+        spoken: {
+            command: string;
+            control: string;
+            option: string;
+            alt: string;
+            shift: string;
+            return: string;
+            enter: string;
+            escape: string;
+            tab: string;
+            space: string;
+            upArrow: string;
+            downArrow: string;
+            leftArrow: string;
+            rightArrow: string;
+            delete: string;
+            backspace: string;
+            forwardDelete: string;
+            repeated: (p: {
+                key: string;
+                count: number;
+            }) => string;
+        };
+    };
+    progress: {
+        indeterminate: string;
+    };
+    blockStack: {
+        reorder: (p: {
+            title: string;
+        }) => string;
+        grip: string;
+        reorderHint: string;
+        moved: (p: {
+            title: string;
+            position: number;
+            count: number;
+        }) => string;
+    };
+    toast: {
+        notifications: string;
+        close: string;
+    };
+    shortcutRecorder: {
+        change: string;
+        recording: string;
+        off: string;
+        needsModifier: (p: {
+            modifiers: string;
+        }) => string;
+        needsModifierOrFunctionKey: (p: {
+            modifiers: string;
+        }) => string;
+    };
+    codeBlock: {
+        copy: string;
+        copied: string;
+        copiedAnnouncement: string;
+        copyCommand: (p: {
+            command: string;
+        }) => string;
+        copyLabelledCommand: (p: {
+            label: string;
+            command: string;
+        }) => string;
+        copyCode: string;
+    };
+    diffView: {
+        changeKinds: {
+            new: string;
+            deleted: string;
+            renamed: string;
+        };
+        stats: (p: {
+            additions: number;
+            deletions: number;
+        }) => string;
+        expandFile: (p: {
+            path: string;
+        }) => string;
+        collapseFile: (p: {
+            path: string;
+        }) => string;
+        copyFile: string;
+        copyPatch: string;
+        showUnchangedLines: string;
+        showAllLines: string;
+        collapseUnchangedLines: string;
+        softWrap: string;
+        wrapLines: string;
+        unwrapLines: string;
+        splitView: string;
+        unifiedView: string;
+        switchToSplit: string;
+        switchToUnified: string;
+        expandLines: {
+            up: string;
+            down: string;
+            both: string;
+        };
+        noChanges: string;
+        nothingToCompare: string;
+        hunk: {
+            label: (p: {
+                index: number;
+            } & {
+                total: number;
+            }) => string;
+            position: (p: {
+                index: number;
+            } & {
+                total: number;
+            }) => string;
+            ask: string;
+            askLabel: (p: {
+                index: number;
+            }) => string;
+            comment: string;
+            commentLabel: (p: {
+                index: number;
+            }) => string;
+            revert: string;
+            revertLabel: (p: {
+                index: number;
+            }) => string;
+            accept: string;
+            acceptLabel: (p: {
+                index: number;
+            }) => string;
+            accepted: string;
+            reverted: string;
+        };
+        comment: {
+            you: string;
+            line: (p: {
+                line: number;
+            }) => string;
+            remove: (p: {
+                line: number;
+            }) => string;
+            onOldLine: (p: {
+                line: number;
+            }) => string;
+            onNewLine: (p: {
+                line: number;
+            }) => string;
+            placeholder: string;
+            toAdd: (p: {
+                keys: string;
+            }) => string;
+            cancel: string;
+            submit: string;
+        };
+    };
+    markdown: {
+        taskDone: string;
+        taskTodo: string;
+        remoteImage: (p: {
+            host: string;
+        }) => string;
+        remoteImageNamed: (p: {
+            alt: string;
+            host: string;
+        }) => string;
+        loadImage: string;
+        linkCheck: {
+            title: string;
+            description: string;
+            open: string;
+            copy: string;
+            copied: string;
+            cancel: string;
+        };
+    };
+    primitives: {
+        close: string;
+        dismiss: string;
+        clearSearch: string;
+        showMore: string;
+        showLess: string;
+        avatarStatus: {
+            online: string;
+            busy: string;
+            away: string;
+            offline: string;
+        };
+        moreAvatars: (p: {
+            count: number;
+        }) => string;
+        trail: string;
+    };
+};
+type AnyFunction = (...args: never[]) => unknown;
+/** A table's type as its readers see it: every level read-only, functions as they are. */
+export type DeepReadonly<T> = T extends AnyFunction ? T : T extends object ? {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+} : T;
+/** Every user-facing string of the kit's components, by namespace. */
+export type UiStrings = DeepReadonly<typeof en>;
+/** The English strings: the shape every other language's table matches in full. */
+export declare const EN_UI_STRINGS: UiStrings;
+export {};

package/dist/i18n/strings/index.js

@@ -0,0 +1,43 @@
+/**
+ * The kit's English strings, one file per namespace: every word its components show, aria-labels and
+ * tooltips included, plus the shared formatter words (`time`, `money`). Adding a namespace: create
+ * `strings/<kebab-name>.ts` exporting a camelCase const (`export const fooBar = { … }`, no `as const`,
+ * so values widen to `string` and functions keep their param types), import it below and add it to
+ * `en`. Strings are plain strings; anything parameterised is a function taking ONE params object
+ * (`(p: { count: number }) => string`). Another language is a complete `UiStrings` table
+ * (`@nibapp/ui/locales/ru`), handed to `UiI18nProvider`.
+ */
+import { alertDialog } from "./alert-dialog.js";
+import { blockStack } from "./block-stack.js";
+import { codeBlock } from "./code-block.js";
+import { combobox } from "./combobox.js";
+import { commandPalette } from "./command-palette.js";
+import { diffView } from "./diff-view.js";
+import { imageViewer } from "./image-viewer.js";
+import { kbd } from "./kbd.js";
+import { markdown } from "./markdown.js";
+import { money } from "./money.js";
+import { primitives } from "./primitives.js";
+import { progress } from "./progress.js";
+import { shortcutRecorder } from "./shortcut-recorder.js";
+import { time } from "./time.js";
+import { toast } from "./toast.js";
+const en = {
+    money,
+    imageViewer,
+    time,
+    alertDialog,
+    combobox,
+    commandPalette,
+    kbd,
+    progress,
+    blockStack,
+    toast,
+    shortcutRecorder,
+    codeBlock,
+    diffView,
+    markdown,
+    primitives,
+};
+/** The English strings: the shape every other language's table matches in full. */
+export const EN_UI_STRINGS = en;

package/dist/i18n/strings/kbd.d.ts

@@ -0,0 +1,42 @@
+/**
+ * `kbd.*`: keycap words (non-Apple platforms; Apple uses ⌘ ⌥ ⇧ ↵ glyphs) and the spoken key names
+ * a screen reader hears for a shortcut ("Command K", "Control Shift F").
+ */
+export declare const kbd: {
+    keys: {
+        ctrl: string;
+        alt: string;
+        shift: string;
+        enter: string;
+        esc: string;
+        tab: string;
+        space: string;
+    };
+    spoken: {
+        command: string;
+        control: string;
+        option: string;
+        alt: string;
+        shift: string;
+        /** Apple's name for Enter. */
+        return: string;
+        enter: string;
+        escape: string;
+        tab: string;
+        space: string;
+        upArrow: string;
+        downArrow: string;
+        leftArrow: string;
+        rightArrow: string;
+        /** Apple's ⌫. */
+        delete: string;
+        backspace: string;
+        /** Apple's ⌦. */
+        forwardDelete: string;
+        /** A key pressed several times in a row ("Escape twice"). */
+        repeated: (p: {
+            key: string;
+            count: number;
+        }) => string;
+    };
+};

package/dist/i18n/strings/kbd.js

@@ -0,0 +1,39 @@
+/**
+ * `kbd.*`: keycap words (non-Apple platforms; Apple uses ⌘ ⌥ ⇧ ↵ glyphs) and the spoken key names
+ * a screen reader hears for a shortcut ("Command K", "Control Shift F").
+ */
+export const kbd = {
+    keys: {
+        ctrl: "Ctrl",
+        alt: "Alt",
+        shift: "Shift",
+        enter: "Enter",
+        esc: "Esc",
+        tab: "Tab",
+        space: "Space",
+    },
+    spoken: {
+        command: "Command",
+        control: "Control",
+        option: "Option",
+        alt: "Alt",
+        shift: "Shift",
+        /** Apple's name for Enter. */
+        return: "Return",
+        enter: "Enter",
+        escape: "Escape",
+        tab: "Tab",
+        space: "Space",
+        upArrow: "Up arrow",
+        downArrow: "Down arrow",
+        leftArrow: "Left arrow",
+        rightArrow: "Right arrow",
+        /** Apple's ⌫. */
+        delete: "Delete",
+        backspace: "Backspace",
+        /** Apple's ⌦. */
+        forwardDelete: "Forward delete",
+        /** A key pressed several times in a row ("Escape twice"). */
+        repeated: (p) => p.count === 2 ? `${p.key} twice` : `${p.key} ${p.count} times`,
+    },
+};

package/dist/i18n/strings/markdown.d.ts

@@ -0,0 +1,23 @@
+/** `markdown.*`: <Markdown>'s task-list checkboxes (read-only, so only their state is named). */
+export declare const markdown: {
+    taskDone: string;
+    taskTodo: string;
+    /** A remote image waiting for the reader (not fetched until "Load image"). */
+    remoteImage: (p: {
+        host: string;
+    }) => string;
+    remoteImageNamed: (p: {
+        alt: string;
+        host: string;
+    }) => string;
+    loadImage: string;
+    /** A link whose words aren't its address, before it opens (`LinkPolicy` `check`). */
+    linkCheck: {
+        title: string;
+        description: string;
+        open: string;
+        copy: string;
+        copied: string;
+        cancel: string;
+    };
+};

package/dist/i18n/strings/markdown.js

@@ -0,0 +1,18 @@
+/** `markdown.*`: <Markdown>'s task-list checkboxes (read-only, so only their state is named). */
+export const markdown = {
+    taskDone: "Done",
+    taskTodo: "To do",
+    /** A remote image waiting for the reader (not fetched until "Load image"). */
+    remoteImage: (p) => `Image from ${p.host}`,
+    remoteImageNamed: (p) => `${p.alt} · ${p.host}`,
+    loadImage: "Load image",
+    /** A link whose words aren't its address, before it opens (`LinkPolicy` `check`). */
+    linkCheck: {
+        title: "Open this link?",
+        description: "It goes to this address:",
+        open: "Open",
+        copy: "Copy address",
+        copied: "Copied",
+        cancel: "Cancel",
+    },
+};

package/dist/i18n/strings/money.d.ts

@@ -0,0 +1,7 @@
+/** `money.*`: the words of the shared money formatters (`useFormatters()`): a spoken amount too small to show. */
+export declare const money: {
+    /** A spend too small to show, with the smallest amount in words ("0.01 US dollars"). */
+    spokenDust: (p: {
+        amount: string;
+    }) => string;
+};

package/dist/i18n/strings/money.js

@@ -0,0 +1,5 @@
+/** `money.*`: the words of the shared money formatters (`useFormatters()`): a spoken amount too small to show. */
+export const money = {
+    /** A spend too small to show, with the smallest amount in words ("0.01 US dollars"). */
+    spokenDust: (p) => `less than ${p.amount}`,
+};

package/dist/i18n/strings/primitives.d.ts

@@ -0,0 +1,25 @@
+/** `primitives.*`: the built-in labels of the generic components (a label prop always wins). */
+export declare const primitives: {
+    /** Icon-only close of Dialog, Popover and Sheet. */
+    close: string;
+    /** Alert's dismiss button. */
+    dismiss: string;
+    /** SearchInput's clear button (with `onClear`). */
+    clearSearch: string;
+    /** ClampedText's toggle: the rest of the text, and back. */
+    showMore: string;
+    showLess: string;
+    /** An Avatar's presence, spoken after the name. */
+    avatarStatus: {
+        online: string;
+        busy: string;
+        away: string;
+        offline: string;
+    };
+    /** AvatarGroup's "+N" chip, spoken: the people not shown. */
+    moreAvatars: (p: {
+        count: number;
+    }) => string;
+    /** PageTrail's landmark: the places above a page, each a link back. */
+    trail: string;
+};

package/dist/i18n/strings/primitives.js

@@ -0,0 +1,18 @@
+/** `primitives.*`: the built-in labels of the generic components (a label prop always wins). */
+export const primitives = {
+    /** Icon-only close of Dialog, Popover and Sheet. */
+    close: "Close",
+    /** Alert's dismiss button. */
+    dismiss: "Dismiss",
+    /** SearchInput's clear button (with `onClear`). */
+    clearSearch: "Clear search",
+    /** ClampedText's toggle: the rest of the text, and back. */
+    showMore: "Show more",
+    showLess: "Show less",
+    /** An Avatar's presence, spoken after the name. */
+    avatarStatus: { online: "online", busy: "busy", away: "away", offline: "offline" },
+    /** AvatarGroup's "+N" chip, spoken: the people not shown. */
+    moreAvatars: (p) => `${p.count} more`,
+    /** PageTrail's landmark: the places above a page, each a link back. */
+    trail: "Breadcrumb",
+};

package/dist/i18n/strings/progress.d.ts

@@ -0,0 +1,4 @@
+/** `progress.*`: what a screen reader hears for an indeterminate `Progress`. */
+export declare const progress: {
+    indeterminate: string;
+};

package/dist/i18n/strings/progress.js

@@ -0,0 +1,4 @@
+/** `progress.*`: what a screen reader hears for an indeterminate `Progress`. */
+export const progress = {
+    indeterminate: "indeterminate progress",
+};

package/dist/i18n/strings/shortcut-recorder.d.ts

@@ -0,0 +1,15 @@
+/** `shortcutRecorder.*`: the control that records a keyboard shortcut (dictation, bringing the app forward). */
+export declare const shortcutRecorder: {
+    change: string;
+    /** While recording: the next combination becomes the shortcut. */
+    recording: string;
+    /** No shortcut is set. */
+    off: string;
+    /** After a press that can't be a shortcut; `modifiers` is a list of keys ("⌘ or ⌥"). */
+    needsModifier: (p: {
+        modifiers: string;
+    }) => string;
+    needsModifierOrFunctionKey: (p: {
+        modifiers: string;
+    }) => string;
+};

package/dist/i18n/strings/shortcut-recorder.js

@@ -0,0 +1,11 @@
+/** `shortcutRecorder.*`: the control that records a keyboard shortcut (dictation, bringing the app forward). */
+export const shortcutRecorder = {
+    change: "Change",
+    /** While recording: the next combination becomes the shortcut. */
+    recording: "Press the keys…",
+    /** No shortcut is set. */
+    off: "Off",
+    /** After a press that can't be a shortcut; `modifiers` is a list of keys ("⌘ or ⌥"). */
+    needsModifier: (p) => `Use a combination with ${p.modifiers}.`,
+    needsModifierOrFunctionKey: (p) => `Use a combination with ${p.modifiers}, or a function key.`,
+};

package/dist/i18n/strings/time.d.ts

@@ -0,0 +1,41 @@
+/**
+ * `time.*`: the words of the shared time formatters (`useFormatters()`): relative times ("now",
+ * "4m", "yesterday"), durations ("850ms", "4.2s", "3m 05s", "2h 05m") and spans ("12m", "3h", "2d", spoken
+ * "12 minutes"). Numbers arrive formatted for the locale.
+ */
+export declare const time: {
+    now: string;
+    yesterday: string;
+    millisecondsShort: (p: {
+        value: string;
+    }) => string;
+    secondsShort: (p: {
+        value: string;
+    }) => string;
+    minutesSecondsShort: (p: {
+        minutes: string;
+        seconds: string;
+    }) => string;
+    hoursMinutesShort: (p: {
+        hours: string;
+        minutes: string;
+    }) => string;
+    minutesShort: (p: {
+        value: string;
+    }) => string;
+    hoursShort: (p: {
+        value: string;
+    }) => string;
+    daysShort: (p: {
+        value: string;
+    }) => string;
+    minutes: (p: {
+        count: number;
+    }) => string;
+    hours: (p: {
+        count: number;
+    }) => string;
+    days: (p: {
+        count: number;
+    }) => string;
+};

package/dist/i18n/strings/time.js

@@ -0,0 +1,20 @@
+import { plural } from "../plural.js";
+/**
+ * `time.*`: the words of the shared time formatters (`useFormatters()`): relative times ("now",
+ * "4m", "yesterday"), durations ("850ms", "4.2s", "3m 05s", "2h 05m") and spans ("12m", "3h", "2d", spoken
+ * "12 minutes"). Numbers arrive formatted for the locale.
+ */
+export const time = {
+    now: "now",
+    yesterday: "yesterday",
+    millisecondsShort: (p) => `${p.value}ms`,
+    secondsShort: (p) => `${p.value}s`,
+    minutesSecondsShort: (p) => `${p.minutes}m ${p.seconds}s`,
+    hoursMinutesShort: (p) => `${p.hours}h ${p.minutes}m`,
+    minutesShort: (p) => `${p.value}m`,
+    hoursShort: (p) => `${p.value}h`,
+    daysShort: (p) => `${p.value}d`,
+    minutes: (p) => plural("en", p.count, { one: "# minute", other: "# minutes" }),
+    hours: (p) => plural("en", p.count, { one: "# hour", other: "# hours" }),
+    days: (p) => plural("en", p.count, { one: "# day", other: "# days" }),
+};

package/dist/i18n/strings/toast.d.ts

@@ -0,0 +1,6 @@
+/** `toast.*`: the `Toaster` region's name and each toast's close button. */
+export declare const toast: {
+    /** The toast stack's landmark region (F6 jumps to it). */
+    notifications: string;
+    close: string;
+};

package/dist/i18n/strings/toast.js

@@ -0,0 +1,6 @@
+/** `toast.*`: the `Toaster` region's name and each toast's close button. */
+export const toast = {
+    /** The toast stack's landmark region (F6 jumps to it). */
+    notifications: "Notifications",
+    close: "Close toast",
+};

package/dist/i18n/time-zones.d.ts

@@ -0,0 +1,20 @@
+/** One choice in the time-zone picker. */
+export interface TimeZoneOption {
+    /** The IANA name the account stores ("Europe/Moscow"). */
+    readonly value: string;
+    /** What the person reads and searches: the city, its zone in their language, the offset now. */
+    readonly label: string;
+    /** The region ("Europe", "America"), for grouping. */
+    readonly group: string;
+}
+/** A zone under its current IANA name ("Asia/Calcutta" → "Asia/Kolkata"). */
+export declare function currentZoneName(zone: string): string;
+/** "Europe/Moscow" → "Moscow"; "America/Argentina/Buenos_Aires" → "Buenos Aires". */
+export declare function zoneCity(zone: string): string;
+/** One zone as the picker labels it in `locale`: "Moscow · Moscow Standard Time (GMT+3)". */
+export declare function zoneLabel(zone: string, locale: string, now?: Date): string;
+/**
+ * Every zone the runtime knows (plus `include`, e.g. the account's when it isn't listed), labelled in
+ * `locale` ({@link zoneLabel}). Sorted by region, then city.
+ */
+export declare function timeZoneOptions(locale: string, include?: string, now?: Date): TimeZoneOption[];