@univerjs/esbuild-plugin

Installation

npm install @univerjs/esbuild-plugin

Usage

If you are using the esbuild API, you can add the plugin to your build configuration:

import { UniverPlugin } from '@univerjs/esbuild-plugin'
import esbuild from 'esbuild'

esbuild.build({
  plugins: [
    univerPlugin()
  ],
})

Features

Automatic Import of Required CSS

This feature is enabled by default. You can disable it by passing css: false to the plugin options.

esbuild.build({
  plugins: [
    univerPlugin({
+     css: false
    })
  ],
})

Simplified Import of Language Packs

The plugin provides a virtual module univer:locales, which simplifies the import of language packs.

import { LocaleType } from '@univerjs/core'

import { enUS, faIR, ruRU, viVN, zhCN, zhTW } from 'univer:locales'

new Univer({
  locales: {
    [LocaleType.ZH_CN]: zhCN,
    [LocaleType.EN_US]: enUS,
    [LocaleType.RU_RU]: ruRU,
    [LocaleType.VI_VN]: viVN,
    [LocaleType.ZH_TW]: zhTW,
    [LocaleType.FA_IR]: faIR,
  }
})

TypeScript Support

In order for TypeScript to recognize the univer:locales import, you should add a reference to the tsconfig.json file in your project.

{
  "compilerOptions": {
+    "types": ["@univerjs/esbuild-plugin/types"]
  }
}

Options

• css: boolean - Whether to automatically import required CSS. Default is true.