@dou-ui/sheet 0.0.0-stage → 0.1.0-alpha.1

package/dist/types/locale.d.ts

@@ -0,0 +1,531 @@
+import type { SheetCondition } from './core/model';
+import type { SheetProtectionRefusal } from './core/protect';
+import type { SheetErrorCode } from './formula/error';
+import { type SheetFunctionHelp } from './formula/help';
+export interface SheetMessages {
+    /** The grid's accessible name when none is given. */
+    sheet: string;
+    /** The corner above the row numbers, which selects everything. */
+    selectAll: string;
+    /** Read out for the cell the keyboard is on: `{cell}` is its name, `{value}` what it shows. */
+    cell: string;
+    /** Read out for an empty cell instead of its value. */
+    empty: string;
+    /** Read out when more than one cell is selected: `{range}`, `{count}` cells. */
+    selected: string;
+    /** The cell editor's name: `{cell}`. */
+    edit: string;
+    /** How to use the grid with keys; read out when it gets focus. */
+    keys: string;
+    /** Read out when the grid can't be changed and something tried to. */
+    readonly: string;
+    /** Read out after clearing: `{range}`. */
+    cleared: string;
+    /** Read out after an edit: `{cell}`, `{value}`. */
+    changed: string;
+    undone: string;
+    /** Said when an extension cancels a change without saying why. */
+    changeCancelled: string;
+    redone: string;
+    /** Menu items. `{count}` is how many rows or columns. */
+    cut: string;
+    copy: string;
+    paste: string;
+    insert: string;
+    delete: string;
+    insertRowsAbove: string;
+    insertRowsBelow: string;
+    insertColsLeft: string;
+    insertColsRight: string;
+    deleteRows: string;
+    deleteCols: string;
+    hideRows: string;
+    hideCols: string;
+    showRows: string;
+    showCols: string;
+    clear: string;
+    mergeCells: string;
+    unmergeCells: string;
+    merged: string;
+    /** Shown after merging cells that had values: `{range}`, `{count}` values cleared. */
+    mergedCleared: string;
+    unmerged: string;
+    /** Read out after copying or cutting: `{range}`. */
+    copied: string;
+    cutDone: string;
+    /** Read out after pasting or filling: `{range}`. */
+    pasted: string;
+    filled: string;
+    /** Read out after rows or columns change: `{count}`. */
+    rowsInserted: string;
+    colsInserted: string;
+    rowsDeleted: string;
+    colsDeleted: string;
+    rowsMoved: string;
+    colsMoved: string;
+    /** Read out after resizing: `{size}` in px. */
+    resized: string;
+    /** Shown when the browser won't let the page read the clipboard: `{key}` pastes instead. */
+    pasteBlocked: string;
+    /** The handle at the corner of the selection, for filling. */
+    fillHandle: string;
+    /** How a check box cell reads. */
+    checked: string;
+    unchecked: string;
+    /** The button on a cell with a list or calendar, which opens it. */
+    openPanel: string;
+    /** The list of a `select` cell, and what it shows when nothing matches. */
+    options: string;
+    noOptions: string;
+    /** Why a value doesn't fit its cell's type, shown on hover and read out. */
+    invalid: string;
+    notDate: string;
+    notOption: string;
+    notChecked: string;
+    /** Why a formula gives an error value, shown on hover and read out. */
+    errors: Record<SheetErrorCode, string>;
+    /** What the built-in functions take and do, by name, for completion and argument hints. */
+    functions: Record<string, SheetFunctionHelp>;
+    /** The formula bar: the box with the cell's address, and the formula box. */
+    nameBox: string;
+    formulaBox: string;
+    /** An address typed in the name box that isn't one: `{text}` is what was typed. */
+    badAddress: string;
+    /** The formula bar's code input: text that isn't a formula. */
+    formulaSyntax: string;
+    unknownFunction: string;
+    /** The list of functions while typing a function's name. */
+    functionList: string;
+    /** Sorting and filtering. */
+    /** The conditions of filters and conditional formats. */
+    ops: Record<SheetCondition['op'], string>;
+    group: SheetGroupMessages;
+    note: SheetNoteMessages;
+    comment: SheetCommentMessages;
+    compare: SheetCompareMessages;
+    /** Cell links: the menu items, the card under a linked cell and the box that edits it. */
+    link: SheetLinkMessages;
+    /** Protecting sheets and the workbook, and why a change to them isn't allowed. */
+    protect: SheetProtectMessages;
+    filter: SheetFilterMessages;
+    /** Conditional formats: the toolbar's menu, the dialog that adds one and the list of them. */
+    formats: SheetFormatsMessages;
+    validation: SheetValidationMessages;
+    /** The name a new sheet gets: `{n}` is a number. */
+    sheetName: string;
+    /** The sheet tabs' accessible name. */
+    sheets: string;
+    /** Read out when another sheet shows: `{name}`. */
+    sheetShown: string;
+    addSheet: string;
+    renameSheet: string;
+    duplicateSheet: string;
+    deleteSheet: string;
+    moveSheetLeft: string;
+    moveSheetRight: string;
+    /** Read out after a sheet is added: `{name}`. */
+    sheetAdded: string;
+    /** Read out after a sheet is deleted: `{name}`. */
+    sheetDeleted: string;
+    /** Read out after a sheet moves: `{name}`, now `{index}` of `{count}`. */
+    sheetMoved: string;
+    /** Shown when a new name is taken: `{name}`. */
+    sheetNameTaken: string;
+    sheetNameEmpty: string;
+    /** How to use the tabs with keys; read out when they get focus. */
+    sheetTabKeys: string;
+    /** The toolbar's name. */
+    toolbar: string;
+    undo: string;
+    redo: string;
+    bold: string;
+    italic: string;
+    underline: string;
+    strike: string;
+    /** Read out after a style is turned on or off with its key: `{name}`. */
+    styleOn: string;
+    styleOff: string;
+    clearFormatting: string;
+    formattingCleared: string;
+    /** The number format menu and its items; `formatCurrency` is the currency's format. */
+    numberFormat: string;
+    formatGeneral: string;
+    formatNumber: string;
+    formatPercent: string;
+    formatCurrency: string;
+    currencyFormat: string;
+    formatDate: string;
+    formatTime: string;
+    formatText: string;
+    formatCustom: string;
+    moreDecimals: string;
+    fewerDecimals: string;
+    textColor: string;
+    fillColor: string;
+    /** The color a style leaves to the sheet. */
+    colorDefault: string;
+    colorCustom: string;
+    toneNeutral: string;
+    tonePrimary: string;
+    toneSuccess: string;
+    toneWarning: string;
+    toneDanger: string;
+    alignLeft: string;
+    alignCenter: string;
+    alignRight: string;
+    verticalAlign: string;
+    alignTop: string;
+    alignMiddle: string;
+    alignBottom: string;
+    wrap: string;
+    freeze: string;
+    /** Freezes the rows (or columns) up to the active cell's: `{n}` rows, up to column `{col}`. */
+    freezeRows: string;
+    freezeCols: string;
+    freezeFirstRow: string;
+    freezeFirstCol: string;
+    unfreeze: string;
+    print: string;
+    /** Find and replace: the commands, and the toggles the panel adds. */
+    find: {
+        find: string;
+        replace: string;
+        next: string;
+        previous: string;
+        /** Only cells whose whole text is the search. */
+        wholeCell: string;
+        /** Look in formulas, not in the values cells show. */
+        formulas: string;
+        /** Look in every sheet, not only the one shown. */
+        workbook: string;
+        /** Added after “replaced” for matches in a formula's result, left as they are: `{count}`. */
+        skippedFormula: string;
+        /** Added after “replaced” for matches in locked cells of a protected sheet: `{count}`. */
+        skippedProtected: string;
+        /** Added after “replaced” for matches whose new value breaks a validation rule: `{count}`. */
+        skippedInvalid: string;
+        /**
+         * Added after “replaced” for matches only in the text a number format
+         * shows, such as a currency sign, which no typed value gives: `{count}`.
+         */
+        skippedShown: string;
+    };
+    /** Files in and out: the export and import menus, and what is read out after. */
+    file: SheetFileMessages;
+}
+/**
+ * Texts to override: any of them, and in a group (error reasons, function
+ * help, …) any of its entries.
+ */
+export type SheetMessagesOverride = {
+    [K in keyof SheetMessages]?: SheetMessages[K] extends string ? string : SheetMessages[K] extends readonly unknown[] ? SheetMessages[K] : SheetMessages[K] extends (...args: never[]) => unknown ? SheetMessages[K] : Partial<SheetMessages[K]>;
+};
+export declare const sheetLocales: Record<string, SheetMessages>;
+/** The texts of exporting and importing files. */
+export interface SheetFileMessages {
+    export: string;
+    import: string;
+    /** The built-in exporters and importers. */
+    csv: string;
+    png: string;
+    svg: string;
+    /** Read out after a file is written or read: `{name}`. */
+    exported: string;
+    imported: string;
+    /** A file that couldn't be read: `{name}`, `{reason}`. */
+    importFailed: string;
+    /** A file no importer takes: `{name}`. */
+    unknownFile: string;
+    /** A file that couldn't be written: `{name}`, `{reason}`. */
+    exportFailed: string;
+    /** What the export menu offers to write, for exporters that can write more than one. */
+    workbook: string;
+    sheet: string;
+    selection: string;
+}
+/** The texts of conditional formats. */
+export interface SheetFormatsMessages {
+    title: string;
+    highlight: string;
+    ranks: string;
+    gt: string;
+    lt: string;
+    between: string;
+    eq: string;
+    contains: string;
+    duplicates: string;
+    formula: string;
+    top: string;
+    bottom: string;
+    above: string;
+    below: string;
+    bar: string;
+    scale: string;
+    clearSelection: string;
+    clearSheet: string;
+    manage: string;
+    /** Dialog fields. */
+    range: string;
+    value: string;
+    and: string;
+    count: string;
+    percent: string;
+    repeated: string;
+    unique: string;
+    look: string;
+    invalidRange: string;
+    needValue: string;
+    cancel: string;
+    apply: string;
+    close: string;
+    edit: string;
+    editTitle: string;
+    condition: string;
+    formulaField: string;
+    formulaHelp: string;
+    needFormula: string;
+    /** A data bar's or a scale's colors. */
+    color: string;
+    /** Keeps a look or color the menus don't offer, when editing a rule. */
+    current: string;
+    /** The looks to pick from. */
+    looks: {
+        danger: string;
+        warning: string;
+        success: string;
+        dangerText: string;
+        bold: string;
+        neutral: string;
+    };
+    /** Color scales, from the smallest number to the largest. */
+    scales: {
+        rag: string;
+        gar: string;
+        diverging: string;
+        blue: string;
+    };
+    /** How the list of formats describes each; `{value}`, `{to}`, `{count}`, `{formula}`. */
+    describe: {
+        when: string;
+        between: string;
+        formula: string;
+        top: string;
+        topPercent: string;
+        bottom: string;
+        bottomPercent: string;
+        above: string;
+        below: string;
+        repeated: string;
+        unique: string;
+        scale: string;
+        bar: string;
+    };
+    empty: string;
+    moveUp: string;
+    moveDown: string;
+    remove: string;
+    /** Read out: `{range}`, `{count}`. */
+    added: string;
+    cleared: string;
+}
+/** The texts of data validation: the dialog, and what is said when a value doesn't fit. */
+export interface SheetValidationMessages {
+    title: string;
+    range: string;
+    allow: string;
+    kinds: {
+        list: string;
+        number: string;
+        integer: string;
+        text: string;
+        formula: string;
+    };
+    condition: string;
+    any: string;
+    value: string;
+    and: string;
+    options: string;
+    optionsHelp: string;
+    formula: string;
+    formulaHelp: string;
+    prompt: string;
+    promptHelp: string;
+    message: string;
+    messageHelp: string;
+    strict: string;
+    strictHelp: string;
+    invalidRange: string;
+    needValue: string;
+    needOptions: string;
+    needFormula: string;
+    remove: string;
+    cancel: string;
+    apply: string;
+    /** A rule in words, said when a value doesn't fit: `{cond}`, `{formula}`. */
+    list: string;
+    number: string;
+    numberOnly: string;
+    integer: string;
+    integerOnly: string;
+    text: string;
+    formulaFailed: string;
+    /** A condition in words: `{op}`, `{value}`, `{to}`. */
+    cond: string;
+    condBetween: string;
+    /** Said when a typed value is refused: `{message}`. */
+    refused: string;
+    /** Read out: `{range}`. */
+    added: string;
+    removed: string;
+}
+export interface SheetGroupMessages {
+    /** Menu items: `{count}` rows or columns. */
+    group: string;
+    groupRows: string;
+    groupCols: string;
+    ungroupRows: string;
+    ungroupCols: string;
+    /** Lines of a group, for the texts below: `{from}`, `{to}`; one line `{from}`. */
+    rowLines: string;
+    rowLine: string;
+    colLines: string;
+    colLine: string;
+    /** A group's button, and what is read out after pressing it: `{lines}`. */
+    collapseRows: string;
+    expandRows: string;
+    collapseCols: string;
+    expandCols: string;
+    collapsedRows: string;
+    expandedRows: string;
+    collapsedCols: string;
+    expandedCols: string;
+    /** The level buttons, and what is read out after one: `{level}`. */
+    rowLevel: string;
+    colLevel: string;
+    levelShown: string;
+    /** Read out after grouping: `{count}` rows or columns. */
+    groupedRows: string;
+    groupedCols: string;
+    ungrouped: string;
+    /** Grouping lines that would cross the group `{group}`, or nest too deep. */
+    crossing: string;
+    tooDeep: string;
+}
+export interface SheetLinkMessages {
+    /** Menu items and the card's buttons. */
+    add: string;
+    edit: string;
+    remove: string;
+    open: string;
+    /** The edit box's name, and a cell's link as read out: `{link}`. */
+    label: string;
+    cellLink: string;
+    /** The edit box's fields. */
+    text: string;
+    address: string;
+    addressPlaceholder: string;
+    /** Shown for an address that won't be followed. */
+    badAddress: string;
+    save: string;
+    cancel: string;
+    /** Read out after a change, and after following a link in the workbook: `{cell}`. */
+    saved: string;
+    removed: string;
+    jumped: string;
+    /** Shown when a link into the workbook goes nowhere, such as to a sheet that is gone: `{link}`. */
+    missing: string;
+}
+export interface SheetProtectMessages {
+    /** The toolbar's menu of these, and its items. */
+    menu: string;
+    protectSheet: string;
+    unprotectSheet: string;
+    protectBook: string;
+    unprotectBook: string;
+    lock: string;
+    unlock: string;
+    /** Read out after a change: `{name}` is the sheet's. */
+    sheetProtected: string;
+    sheetUnprotected: string;
+    bookProtected: string;
+    bookUnprotected: string;
+    locked: string;
+    unlocked: string;
+    /** Read out after a protected sheet's name on its tab. */
+    protectedSheet: string;
+    /** Shown when a change runs into protection, by what it ran into. */
+    refused: Record<SheetProtectionRefusal, string>;
+}
+export interface SheetNoteMessages {
+    /** Menu items. */
+    add: string;
+    edit: string;
+    remove: string;
+    /** `{count}` notes in the selection. */
+    removeMany: string;
+    /** The note box's name, and the note as read out with its cell: `{note}`. */
+    label: string;
+    cellNote: string;
+    placeholder: string;
+    save: string;
+    cancel: string;
+    /** Read out after a change; `{count}` notes. */
+    saved: string;
+    removed: string;
+    removedMany: string;
+}
+export interface SheetCompareMessages {
+    /** What a changed cell held in the older version: `{value}`; or that it was empty. */
+    was: string;
+    wasEmpty: string;
+    /** Read out after `restore`. */
+    restored: string;
+}
+export interface SheetCommentMessages {
+    /** Menu items: start a thread on the cell, or open the one it has. */
+    add: string;
+    open: string;
+    /** The name of the card beside the cell. */
+    label: string;
+    /** Read out with a cell that has a thread. */
+    cellComment: string;
+}
+export interface SheetFilterMessages {
+    /** Menu and toolbar items. */
+    sortAsc: string;
+    sortDesc: string;
+    sort: string;
+    turnOn: string;
+    turnOff: string;
+    clearAll: string;
+    /** A column's filter button: `{column}` is its heading or letter. */
+    button: string;
+    /** The panel. */
+    byValues: string;
+    byCondition: string;
+    search: string;
+    values: string;
+    all: string;
+    allMatches: string;
+    blank: string;
+    noMatch: string;
+    /** More values than listed: `{count}`. */
+    more: string;
+    condition: string;
+    value: string;
+    clear: string;
+    apply: string;
+    /** Read out: `{range}`, `{shown}` rows of `{total}`, `{column}`. */
+    added: string;
+    removed: string;
+    applied: string;
+    sorted: string;
+    /** Sorting a range with merged cells. */
+    mergedSort: string;
+    /** Sorting with nothing to sort: one row selected and no filter. */
+    nothingToSort: string;
+}
+/** The texts for a language, such as `zh-CN`; Chinese or English by its first part, English otherwise. */
+export declare function sheetMessagesFor(locale?: string): SheetMessages;
+/** Fills `{name}` placeholders. */
+export declare const format: (text: string, params: Record<string, string | number>) => string;

package/dist/types/sheet.vue.d.ts

@@ -0,0 +1,60 @@
+import { type SheetWorkbook } from './core/model';
+import { type SheetSelection } from './core/selection';
+import { SheetTransaction } from './core/transaction';
+import type { SheetImportEvent, SheetFileErrorEvent, SheetSlots, SheetExpose, SheetMenuContext, SheetMenuItem, SheetLinkOpenEvent, SheetPasteEvent, SheetProps } from './types';
+type __VLS_Slots = SheetSlots;
+declare const __VLS_base: import("vue").DefineComponent<SheetProps, SheetExpose, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    paste: (event: SheetPasteEvent) => any;
+    import: (event: SheetImportEvent) => any;
+    "update:modelValue": (value: SheetWorkbook) => any;
+    transaction: (tr: SheetTransaction) => any;
+    "update:selection": (value: SheetSelection) => any;
+    "update:activeSheet": (value: number) => any;
+    transactionCancel: (tr: SheetTransaction) => any;
+    linkOpen: (event: SheetLinkOpenEvent) => any;
+    fileError: (event: SheetFileErrorEvent) => any;
+    "update:comments": (threads: import("dou-ui").CommentThread[]) => any;
+    "update:activeComment": (id: string | null) => any;
+    commentAction: (action: import("dou-ui").CommentAction) => any;
+}, string, import("vue").PublicProps, Readonly<SheetProps> & Readonly<{
+    onPaste?: ((event: SheetPasteEvent) => any) | undefined;
+    onImport?: ((event: SheetImportEvent) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: SheetWorkbook) => any) | undefined;
+    onTransaction?: ((tr: SheetTransaction) => any) | undefined;
+    "onUpdate:selection"?: ((value: SheetSelection) => any) | undefined;
+    "onUpdate:activeSheet"?: ((value: number) => any) | undefined;
+    onTransactionCancel?: ((tr: SheetTransaction) => any) | undefined;
+    onLinkOpen?: ((event: SheetLinkOpenEvent) => any) | undefined;
+    onFileError?: ((event: SheetFileErrorEvent) => any) | undefined;
+    "onUpdate:comments"?: ((threads: import("dou-ui").CommentThread[]) => any) | undefined;
+    "onUpdate:activeComment"?: ((id: string | null) => any) | undefined;
+    onCommentAction?: ((action: import("dou-ui").CommentAction) => any) | undefined;
+}>, {
+    readonly: boolean;
+    compare: SheetWorkbook | null;
+    menu: (items: SheetMenuItem[], context: SheetMenuContext) => SheetMenuItem[];
+    selection: SheetSelection;
+    comments: import("dou-ui").CommentThread[];
+    messages: import("./locale").SheetMessagesOverride;
+    colWidth: number;
+    rowHeight: number;
+    author: import("dou-ui").CommentAuthor;
+    outline: boolean;
+    ariaLabel: string;
+    activeSheet: number;
+    headers: boolean;
+    gridlines: boolean;
+    historyDepth: number;
+    extensions: (import(".").SheetExtension | import(".").SheetExtension[])[];
+    fileDrop: boolean;
+    activeComment: string | null;
+    commentable: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};