主题与深色模式
使用官方主题
@univerjs/themes 导出 defaultTheme(也可写作 blueTheme)、darkBlueTheme、greenTheme、orangeTheme、purpleTheme、redTheme 和 yellowTheme。
不传主题时,Univer 使用
defaultTheme。安装主题插件
预设模式
预设模式下,主题从 @univerjs/presets 导入:
TypeScript
// import { defaultTheme } from "@univerjs/presets";import { yellowTheme } from '@univerjs/presets'const { univer } = createUniver({ theme: yellowTheme, // theme: defaultTheme,})插件模式
插件模式下,主题由 @univerjs/themes 提供,因此需要先安装该包。
Shell
pnpm add @univerjs/themesShell
npm install @univerjs/themesShell
yarn add @univerjs/themesShell
bun add @univerjs/themesTypeScript
import { yellowTheme } from '@univerjs/themes'// import { defaultTheme } from "@univerjs/themes";const univer = new Univer({ theme: yellowTheme, // theme: defaultTheme,})自定义主题
主题是一个符合 Theme 接口的对象。以 defaultTheme 为基础,覆盖需要修改的字段,再把结果传给 Univer。默认变量的定义方式见 Theme 类型参考。
TypeScript
import type { Theme } from '@univerjs/themes';import { defaultTheme } from '@univerjs/themes';export const customTheme: Theme = { ...defaultTheme, primary: { ...defaultTheme.primary, 50: '#F5F3FF', 100: '#EDE9FE', 200: '#DDD6FE', 300: '#C4B5FD', 400: '#A78BFA', 500: '#8B5CF6', 600: '#7C3AED', 700: '#6D28D9', 800: '#5B21B6', 900: '#4C1D95', },};TypeScript
// 在这里导入你自定义的主题import { customTheme } from './custom-theme'const univer = new Univer({ theme: customTheme,})主题定制器
主题定制器是一个独立工具,可用于编辑 Univer 主题 Tokens、预览浅色和深色模式,并复制最终得到的 Theme JSON。
深色模式
将 darkMode 设为 true 后,Univer 会以深色模式启动。
TypeScript
new Univer({ darkMode: true,})Facade API
运行过程中也可以通过 Facade API 切换深色模式。
TypeScript
import { darkBlueTheme } from '@univerjs/themes'univerAPI.setTheme(darkBlueTheme)univerAPI.toggleDarkMode(true)const currentTheme = univerAPI.getCurrentTheme()console.log(univerAPI.isDarkMode(), currentTheme)univerAPI.toggleDarkMode(false)你觉得这篇文档如何?