Core Features

import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import DesignEnUS from '@univerjs/design/locale/en-US'import { UniverDocsPlugin } from '@univerjs/docs'import { UniverDocsUIPlugin } from '@univerjs/docs-ui'import DocsUIEnUS from '@univerjs/docs-ui/locale/en-US'import { UniverFormulaEnginePlugin } from '@univerjs/engine-formula'import { UniverRenderEnginePlugin } from '@univerjs/engine-render'import { UniverSheetsPlugin } from '@univerjs/sheets'import { UniverSheetsFormulaPlugin } from '@univerjs/sheets-formula'import { UniverSheetsFormulaUIPlugin } from '@univerjs/sheets-formula-ui'import SheetsFormulaUIEnUS from '@univerjs/sheets-formula-ui/locale/en-US'import { UniverSheetsNumfmtPlugin } from '@univerjs/sheets-numfmt'import { UniverSheetsNumfmtUIPlugin } from '@univerjs/sheets-numfmt-ui'import SheetsNumfmtUIEnUS from '@univerjs/sheets-numfmt-ui/locale/en-US'import { UniverSheetsUIPlugin } from '@univerjs/sheets-ui'import SheetsUIEnUS from '@univerjs/sheets-ui/locale/en-US'import SheetsEnUS from '@univerjs/sheets/locale/en-US'import { UniverUIPlugin } from '@univerjs/ui'import UIEnUS from '@univerjs/ui/locale/en-US'import '@univerjs/design/lib/index.css'import '@univerjs/ui/lib/index.css'import '@univerjs/docs-ui/lib/index.css'import '@univerjs/sheets-ui/lib/index.css'import '@univerjs/sheets-formula-ui/lib/index.css'import '@univerjs/sheets-numfmt-ui/lib/index.css'import '@univerjs/engine-formula/facade'import '@univerjs/ui/facade'import '@univerjs/docs-ui/facade'import '@univerjs/sheets/facade'import '@univerjs/sheets-ui/facade'import '@univerjs/sheets-formula/facade'import '@univerjs/sheets-numfmt/facade'const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      DesignEnUS,      UIEnUS,      DocsUIEnUS,      SheetsEnUS,      SheetsUIEnUS,      SheetsFormulaUIEnUS,      SheetsNumfmtUIEnUS,    ),  },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverFormulaEnginePlugin)univer.registerPlugin(UniverUIPlugin, {  container: 'app',})univer.registerPlugin(UniverDocsPlugin)univer.registerPlugin(UniverDocsUIPlugin)univer.registerPlugin(UniverSheetsPlugin)univer.registerPlugin(UniverSheetsUIPlugin)univer.registerPlugin(UniverSheetsFormulaPlugin)univer.registerPlugin(UniverSheetsFormulaUIPlugin)univer.registerPlugin(UniverSheetsNumfmtPlugin)univer.registerPlugin(UniverSheetsNumfmtUIPlugin)

interface IUniverSheetsUIConfig {  // Whether to show the footer.  footer?:    | false    | {        // The sheet bar is the sub-sheet manager, including adding/switching/deleting sub-sheets.        sheetBar?: boolean        // The statistic bar includes statistics of the current selection, such as count, sum, average, etc.        statisticBar?: boolean        // The bottom menu includes options like highlight, gridlines, etc.        menus?: boolean        // The zoom slider at the bottom.        zoomSlider?: boolean        /**         * The config of the add sheet button in the sheet bar.         */        addSheetButtonConfig?: {          /**           * Whether to show the add sheet button in the sheet bar.           * When `footer` or `footer.sheetBar` is false, this config will not work because the sheet bar will not be rendered.           * @default true           */          show?: boolean          /**           * The default row count of the new sheet created by the add sheet button.           * @default 1000           */          defaultRowCount?: number          /**           * The default column count of the new sheet created by the add sheet button.           * @default 20           */          defaultColumnCount?: number        }      }  // Whether to show the formula bar  formulaBar?: boolean  clipboardConfig?: {    // Whether to show the paste options button after paste operation    hidePasteOptions?: boolean  }  // The configuration for the scroll bar  scrollConfig?: IScrollBarProps  /**   * Strategy for showing the protected range shadow.   * - true or 'always': Show shadow for all protected ranges (default behavior)   * - 'non-editable': Only show shadow for ranges that cannot be edited (Edit permission is false)   * - 'non-viewable': Only show shadow for ranges that cannot be viewed (View permission is false)   * - false or 'none': Never show shadow for protected ranges   * @default true   */  protectedRangeShadow?: boolean | 'always' | 'non-editable' | 'non-viewable' | 'none'  // Whether to disable the force string alert.  disableForceStringAlert?: boolean  // Whether to disable the force string mark.  disableForceStringMark?: boolean}

interface IUniverSheetsCorePresetConfig {  // Container element, can be a string or a DOM element  container?: string | HTMLElement  // Whether to show the header  header?: boolean  // Whether to show the header toolbar  toolbar?: boolean  // The type of the header toolbar. 'classic': default classic mode; 'grid': two-row grid mode; 'collapsed': compact mode; 'simple': ungrouped mode  ribbonType?: RibbonType  // Whether to show the footer  footer?:    | false    | {        // Sheet bar is the sub-sheet manager, including adding/switching/deleting sub-sheets.        sheetBar?: boolean        // Statistic bar includes statistics of the current selection, such as count, sum, average, etc.        statisticBar?: boolean        // The bottom menu includes options like highlight, gridlines, etc.        menus?: boolean        // The zoom slider at the bottom.        zoomSlider?: boolean        /**         * The config of the add sheet button in the sheet bar.         */        addSheetButtonConfig?: {          /**           * Whether to show the add sheet button in the sheet bar.           * When `footer` or `footer.sheetBar` is false, this config will not work because the sheet bar will not be rendered.           * @default true           */          show?: boolean          /**           * The default row count of the new sheet created by the add sheet button.           * @default 1000           */          defaultRowCount?: number          /**           * The default column count of the new sheet created by the add sheet button.           * @default 20           */          defaultColumnCount?: number        }      }  // Whether to show the context menu  contextMenu?: boolean  // Whether to disable auto focus  disableAutoFocus?: true  // Menu configuration  menu?: MenuConfig  sheets?: {    // If both row style and column style are set, whether row style precedes column style    isRowStylePrecedeColumnStyle?: boolean    // Whether auto height applies to merged cells    autoHeightForMergedCells?: boolean    /**     * Whether synchronize the frozen state to other users in real-time collaboration.     * @default true     */    freezeSync?: boolean    clipboardConfig?: {      // Whether to show the paste options button after paste operation      hidePasteOptions?: boolean    }    // The configuration for the scroll bar    scrollConfig?: IScrollBarProps    /**     * Strategy for showing the protected range shadow.     * - true or 'always': Show shadow for all protected ranges (default behavior)     * - 'non-editable': Only show shadow for ranges that cannot be edited (Edit permission is false)     * - 'non-viewable': Only show shadow for ranges that cannot be viewed (View permission is false)     * - false or 'none': Never show shadow for protected ranges     * @default true     */    protectedRangeShadow?: boolean | 'always' | 'non-editable' | 'non-viewable' | 'none'    // Whether to disable the force string alert.    disableForceStringAlert?: boolean    // Whether to disable the force string mark.    disableForceStringMark?: boolean  }  // ... More configuration options}