@ciridae/ui 0.17.0 → 1.0.1

package/dist/components/locale.d.ts

@@ -0,0 +1,463 @@
+import { type ReactNode } from "react";
+/** Pieces of a sentence a label puts in order, so a translation can move the name or the time. */
+export type NotificationSentenceParts = {
+    actor: ReactNode;
+    action: ReactNode;
+};
+export type NotificationMetaParts = {
+    record: ReactNode;
+    time: ReactNode;
+};
+export type ActivityUpdateParts = {
+    actor: ReactNode;
+    actions: ReactNode;
+    time: ReactNode;
+};
+/**
+ * Every word the kit draws, in English. A string is used as is; a function builds a parametric
+ * string, or, where a sentence mixes a name with what it did, orders the parts it is given.
+ */
+export declare const englishLabels: {
+    common: {
+        close: string;
+        cancel: string;
+        done: string;
+        dismiss: string;
+        loading: string;
+        clear: string;
+        search: string;
+        searchPlaceholder: string;
+        noResults: string;
+        noMatches: string;
+        retry: string;
+        tryAgain: string;
+        working: string;
+        progress: string;
+        expand: string;
+        collapse: string;
+        remove: (name: string) => string;
+        copy: (what: string) => string;
+        copyValue: (what: string, value: string) => string;
+        copied: string;
+        copyAction: string;
+        moreActions: string;
+        moreTabs: string;
+        dismissNotification: string;
+        moreCount: (count: number) => string;
+        /** A control's name with the count its badge shows, such as a bell's unread count. */
+        withCount: (label: string, count: number) => string;
+        /** Between the items of a list, such as the actions one update line joins. */
+        listSeparator: string;
+    };
+    shell: {
+        menu: string;
+        breadcrumb: string;
+        parentPages: string;
+        environment: (label: string) => string;
+    };
+    pagination: {
+        label: string;
+        previous: string;
+        next: string;
+    };
+    calendar: {
+        previousMonth: string;
+        nextMonth: string;
+    };
+    select: {
+        placeholder: string;
+        label: string;
+        searchLabel: string;
+        filters: string;
+    };
+    commandMenu: {
+        title: string;
+    };
+    keyboard: {
+        shortcuts: string;
+        /** The group of a shortcut registered without one. */
+        general: string;
+        openCommandMenu: string;
+        openChat: string;
+        list: string;
+        nextRow: string;
+        previousRow: string;
+        selectRow: string;
+        selectRange: string;
+        clearSelection: string;
+        panel: string;
+        previousItem: string;
+        nextItem: string;
+        closePanel: string;
+        record: string;
+        editField: string;
+        /** `KeyboardShortcutSettings`. */
+        change: string;
+        reset: string;
+        unassigned: string;
+        pressKeys: string;
+        usedBy: (name: string) => string;
+    };
+    dates: {
+        today: string;
+        yesterday: string;
+        earlier: string;
+    };
+    dropzone: {
+        dropToAttach: string;
+        /** "Drop files or [browse]": the browse button is a slot. */
+        dropOrBrowse: (browse: ReactNode) => ReactNode;
+        browse: string;
+        uploading: (name: string) => string;
+        attachFiles: string;
+    };
+    userChip: {
+        copyEmail: string;
+    };
+    activity: {
+        show: string;
+        all: string;
+        comments: string;
+        updates: string;
+        noActivity: string;
+        noComments: string;
+        noUpdates: string;
+        comment: string;
+        postComment: string;
+        tag: string;
+        tags: string;
+        updateCount: (count: number) => string;
+        /** The actors a folded run names, then how many more acted. */
+        runActors: (names: string, more: number) => string;
+        updateLine: ({ actor, actions, time }: ActivityUpdateParts) => ReactNode;
+    };
+    notifications: {
+        title: string;
+        markAllRead: string;
+        allCaughtUp: string;
+        show: string;
+        all: string;
+        mentions: string;
+        assigned: string;
+        noNotifications: string;
+        noMentions: string;
+        nothingAssigned: string;
+        today: string;
+        earlier: string;
+        sentence: ({ actor, action }: NotificationSentenceParts) => ReactNode;
+        meta: ({ record, time }: NotificationMetaParts) => ReactNode;
+        /** The row's accessible name. */
+        rowLabel: (actor: string, action: string, record: string) => string;
+    };
+    feedback: {
+        sendTitle: string;
+        sentTitle: string;
+        newTab: string;
+        sentTab: string;
+        type: string;
+        where: string;
+        whatHappened: string;
+        whatHappenedPlaceholder: string;
+        includeScreenshot: string;
+        preview: string;
+        attachments: string;
+        kindWrong: string;
+        kindIdea: string;
+        kindQuestion: string;
+        typeBug: string;
+        typeFeature: string;
+        typeGeneral: string;
+        statusReceived: string;
+        statusInProgress: string;
+        statusNeedsReply: string;
+        statusDone: string;
+        statusClosed: string;
+        statusWithdrawn: string;
+        needsWords: string;
+        fileTooLarge: (name: string, limit: string) => string;
+        fileEmpty: (name: string) => string;
+        tooManyFiles: (count: number) => string;
+        sent: string;
+        sendAnother: string;
+        sending: string;
+        send: string;
+        sendFailed: string;
+        loadListFailed: string;
+        loadItemFailed: string;
+        replyFailed: string;
+        withdrawFailed: string;
+        noneSent: string;
+        back: string;
+        copyId: string;
+        withdraw: string;
+        withdrawing: string;
+        actions: string;
+        reply: string;
+        sendReply: string;
+        annotate: string;
+        annotateCount: (count: number) => string;
+        addPointer: string;
+        screenshot: string;
+        pointerNote: (index: number) => string;
+        removePointer: (index: number) => string;
+    };
+    lightbox: {
+        previous: string;
+        next: string;
+        openInNewTab: string;
+        download: string;
+        position: (index: number, total: number) => string;
+        preview: (name: string) => string;
+    };
+    chat: {
+        message: string;
+        sendMessage: string;
+        stopped: string;
+        failed: string;
+        notSent: string;
+        typing: string;
+        resize: string;
+        openFullPage: string;
+        dock: string;
+        undock: string;
+        attachFile: string;
+        mentions: string;
+        assistantName: string;
+        answered: (answers: string) => string;
+        allow: string;
+        deny: string;
+        conversations: string;
+        searchConversations: string;
+        newChat: string;
+        running: string;
+        previousWeek: string;
+        approve: string;
+        waitingOnYou: string;
+    };
+    projectCard: {
+        default: string;
+        dedicated: string;
+        archived: string;
+        created: (when: ReactNode) => ReactNode;
+        lastEdited: (when: ReactNode) => ReactNode;
+    };
+    table: {
+        nothingToShow: string;
+        noResults: string;
+        selectAll: string;
+        selectRow: (name: string) => string;
+        actions: string;
+        sortAscending: string;
+        sortDescending: string;
+        filterBy: (column: string) => string;
+        hideColumn: string;
+        columns: string;
+        reset: string;
+        alwaysShown: string;
+        reorderHint: string;
+        density: string;
+        densityDefault: string;
+        densityCompact: string;
+        selectedCount: (count: number) => string;
+        selectAllCount: (total: string) => string;
+        clearSelection: string;
+        selectedItems: string;
+    };
+    sidePanel: {
+        previous: string;
+        next: string;
+    };
+    checklist: {
+        search: string;
+        selectAll: string;
+        selectMatches: string;
+        clear: string;
+        clearMatches: string;
+        /** The bulk actions' group, which acts on the items shown. */
+        bulkActions: string;
+        selectedCount: (selected: number, total: number) => string;
+        noMatches: (search: string) => string;
+    };
+    filters: {
+        addFilter: string;
+        clearAll: string;
+        filterBy: string;
+        noFields: string;
+        backToFields: string;
+        searchValues: (field: string) => string;
+        noValues: string;
+        value: string;
+        from: string;
+        to: string;
+        selectedCount: (count: number) => string;
+        updatesAsYouPick: string;
+        remove: (field: string) => string;
+        /** The operator as the builder offers it. */
+        operators: {
+            is: string;
+            is_not: string;
+            is_any_of: string;
+            is_none_of: string;
+            contains: string;
+            does_not_contain: string;
+            equals: string;
+            greater_than: string;
+            less_than: string;
+            between: string;
+            before: string;
+            after: string;
+        };
+        /** The operator as a chip reads it, before the values. */
+        chipOperators: {
+            is: string;
+            is_not: string;
+            is_any_of: string;
+            is_none_of: string;
+            contains: string;
+            does_not_contain: string;
+            equals: string;
+            greater_than: string;
+            less_than: string;
+            between: string;
+            before: string;
+            after: string;
+        };
+        betweenValues: (from: string, to: string) => string;
+    };
+    dateRange: {
+        label: string;
+        today: string;
+        yesterday: string;
+        last7Days: string;
+        last30Days: string;
+        thisMonth: string;
+        lastMonth: string;
+        pickDates: string;
+        range: (start: string, end: string) => string;
+    };
+    secret: {
+        title: string;
+        titleFor: (name: string) => string;
+    };
+    record: {
+        /** A stacked record page's tabs: the work, and the side column of details and activity. */
+        mainTab: string;
+        asideTab: string;
+        stages: string;
+        notSure: string;
+        undo: string;
+        /** A folded run of stages on the strip: its short word, and its name for assistive tech. */
+        runDone: string;
+        runToGo: string;
+        runDoneLabel: (count: number) => string;
+        runToGoLabel: (count: number) => string;
+        checklistProgress: (done: number, total: number) => string;
+    };
+    settings: {
+        navigation: string;
+    };
+    navigation: {
+        navigation: string;
+        more: string;
+        less: string;
+    };
+    documentViewer: {
+        document: string;
+        pages: string;
+        page: (number: number) => string;
+        pageOf: (number: number, total: number) => string;
+        previousPage: string;
+        nextPage: string;
+        zoomIn: string;
+        zoomOut: string;
+        /** The fit menu's face while the zoom is a step of its own. */
+        fit: string;
+        fitPage: string;
+        fitWidth: string;
+        actualSize: string;
+        rotate: string;
+        fullScreen: string;
+        exitFullScreen: string;
+    };
+    themeCustomizer: {
+        palette: string;
+        paletteName: (name: string) => string;
+        colorTheme: string;
+        system: string;
+        light: string;
+        dark: string;
+        displayFont: string;
+        sansFont: string;
+        monoFont: string;
+    };
+    profileHeader: {
+        email: string;
+    };
+    editableField: {
+        edit: (label: string) => string;
+        saving: string;
+        saved: string;
+        saveHint: string;
+        pickHint: string;
+        undo: string;
+        effectiveValue: string;
+    };
+};
+export type CiridaeLabels = typeof englishLabels;
+/** Labels a product rewords: any group, and within it any label; the rest stay English. */
+export type CiridaeLabelOverrides = {
+    [Group in keyof CiridaeLabels]?: Partial<CiridaeLabels[Group]>;
+};
+export type DateInput = Date | number | string;
+/** Epoch milliseconds, a Date, or an ISO string; a string without a zone is UTC. */
+export declare function toDate(value: DateInput): Date;
+export type MoneyFormatOptions = {
+    /** An ISO 4217 code: "USD", "EUR", "JPY", ... Defaults to USD. */
+    currency?: string;
+    /** Abbreviate to K, M and B. */
+    compact?: boolean;
+    /** Show minor units; defaults to true unless compact. */
+    cents?: boolean;
+};
+/** Plural forms keyed by `Intl.PluralRules` category; `#` stands for the formatted count. */
+export type PluralForms = Partial<Record<Intl.LDMLPluralRule, string>> & {
+    other: string;
+};
+export type CiridaeLocale = {
+    locale: string;
+    dir: "ltr" | "rtl";
+    labels: CiridaeLabels;
+    /** A date: `{ dateStyle: "medium" }` unless options say otherwise. */
+    formatDate: (value: DateInput, options?: Intl.DateTimeFormatOptions) => string;
+    /** A time of day: `{ timeStyle: "short" }` unless options say otherwise. */
+    formatTime: (value: DateInput, options?: Intl.DateTimeFormatOptions) => string;
+    /** A date and its time of day, short. */
+    formatDateTime: (value: DateInput, options?: Intl.DateTimeFormatOptions) => string;
+    /** "3 hours ago", "in 2 days", "yesterday", against `now`. */
+    formatRelative: (value: DateInput, now?: number) => string;
+    formatNumber: (value: number, options?: Intl.NumberFormatOptions) => string;
+    formatMoney: (amount: number, options?: MoneyFormatOptions) => string;
+    /** `12 kB`, `1.4 MB`, in units of 1024. */
+    formatFileSize: (bytes: number) => string;
+    /** Items as a list, joined by the `common.listSeparator` label, keeping each item's content. */
+    formatList: (items: readonly ReactNode[]) => ReactNode;
+    /** The form for `count`, with `#` replaced by the formatted count. */
+    plural: (count: number, forms: PluralForms) => string;
+};
+/** The locale value `useCiridaeLocale` returns, for use outside React or in tests. */
+export declare function createCiridaeLocale(locale: string, { labels, dir }?: {
+    labels?: CiridaeLabelOverrides;
+    dir?: "ltr" | "rtl";
+}): CiridaeLocale;
+export type CiridaeLocaleProviderProps = {
+    /** A BCP 47 tag such as `de-DE`; the browser's language when left out. */
+    locale?: string;
+    /** Labels the product rewords or translates; anything left out stays English. */
+    labels?: CiridaeLabelOverrides;
+    /** The text direction; also steers Base UI's keyboard handling and popup placement. */
+    dir?: "ltr" | "rtl";
+    children: ReactNode;
+};
+export declare function CiridaeLocaleProvider({ locale, labels, dir, children, }: CiridaeLocaleProviderProps): import("@types/react").JSX.Element;
+/** The locale's labels and formatters; English for the browser's language outside a provider. */
+export declare function useCiridaeLocale(): CiridaeLocale;