在 Semi Design 页面上使用 VChart
什么是 Semi
Semi Design 是由抖音前端团队,MED 产品设计团队设计、开发并维护的设计系统。它作为全面、易用、优质的现代应用 UI 解决方案,从字节跳动各业务线的复杂场景提炼而来,支撑近千计平台产品,服务内外部 10 万+ 用户。

目前 VChart 针对 Semi Design 提供了专项适配。Semi Design 的更多信息可见 Semi 官网。
安装和使用 VChart
Semi Design 目前主要适配 React 工程。可以使用以下命令安装 react-vchart:
# 使用 npm 安装 npm install @visactor/react-vchart # 使用 yarn 安装 yarn add @visactor/react-vchart
绘制图表以及更详细的指引详见这个教程。
适用于 Semi Design 的图表主题包
为了使 VChart 在 Semi 页面环境中获得更好的体验,VisActor 额外推出了 @visactor/vchart-semi-theme 主题包。这个包有以下特性:
- 开箱即用:经过简单的配置,就可以使 VChart 样式自动融入 Semi 设计语言,也会自动适配用户通过 Semi DSM 自定义的主题包。
- 响应式:
@visactor/vchart-semi-theme支持监听页面上的亮暗模式变化以及主题切换,自动对页面上的 VChart 图表的主题进行热更新。
DEMO
完整 demo 请访问此页面。
安装
https://www.npmjs.com/package/@visactor/vchart-semi-theme
# npm npm install @visactor/vchart-semi-theme # yarn yarn add @visactor/vchart-semi-theme
使用
实现默认的功能,只需要在全局执行一次 initVChartSemiTheme 方法进行初始化。这个语句通常可以放在 React 项目的入口文件中。如以下示例:
import React from 'react'; import { createRoot } from 'react-dom/client'; import App from './app.jsx'; import { initVChartSemiTheme } from '@visactor/vchart-semi-theme'; // initialization initVChartSemiTheme(); const dom = document.querySelector('#root'); const root = createRoot(dom); root.render(<App />);
initVChartSemiTheme 方法支持传入一个对象作为 option,其类型声明为:
interface IInitVChartSemiThemeOption { /** 初始亮暗色模式 */ defaultMode?: 'light' | 'dark'; /** 是否监听亮暗色模式自动更改图表主题,默认为 true */ isWatchingMode?: boolean; /** 是否监听主题变化自动更改图表主题,默认为 false(适用于 semi 官方主题切换接口:https://semi.design/dsm/install_switcher)*/ isWatchingThemeSwitch?: boolean; }
例如,如果要开启监听用户侧的主题切换,初始化语句可以改为这样:
// initialization
initVChartSemiTheme({
isWatchingThemeSwitch: true
});
Token 映射
在图表主题的功能上,VChart 支持数据色板和语义色板的自定义配置。@visactor/vchart-semi-theme 基于这个特性实现了和 Semi Design 的结合。