semi-design

Semi-UI

现代、全面、灵活的设计系统和 UI 库。 致力打通 DesignOps & DevOps ，快速搭建美观的 React 应用。

[![NPM][npm-badge]][npm-url] [![FIGMA][figma-badge]][figma-url] [![LICENSE][license-badge]][license-url] [![BUILD-JS][build-js-badge]][build-js-url] [![BUILD-CSS][build-css-badge]][build-css-url] [![CODECOV][codecov-badge]][codecov-url] [![Chromatic][chromatic-badge]][chromatic-url] [![Cypress][cypress-badge]][cypress-url]

简体中文 | English

🎉 特性

• 💪 60+高质量组件
• 💕 完善的无障碍支持，为所有组件提供遵循 W3C 标准的键盘交互、焦点管理和语义化
• 🎨 设计系统管理工具 Semi DSM，多达2000+ Design Token，快速定制你的专属设计系统
• 🌍 国际化支持 17 种语言，提供完备的多语言、多时区、RTL支持
• 💅 Code2Design，根据不同主题自动生成 Figma UI Kit，保持代码与设计同源
• 🚀 强大的 Design2Code支持，设计稿一键转代码，快速构建应用
• ⚙️ 稳定的质量保障，覆盖单元测试、E2E测试、视觉回归测试等多种测试手段
• 🥳 支持 SSR
• 👏 使用 TypeScript, 良好的类型定义，基于 Foundation / Adapter 架构，源码易于阅读 / 贡献

🔥 安装

# 使用 npm
npm install @douyinfe/semi-ui

# 使用 yarn
yarn add @douyinfe/semi-ui

👍 使用

这是一个快速开始的例子：

import React from 'react';
import ReactDOM from 'react-dom';
import { Button, Switch } from '@douyinfe/semi-ui';

const App = () => (
    <>
        <Button type='primary'>primary button</Button>
        <Switch size='large' />
    </>
);

ReactDOM.render(<App />, document.querySelector('#app'));

Semi UI 官网 拥有上千个支持实时调试的例子，欢迎体验使用。

📌 文档

• Semi DSM
• Semi Design2Code
• Semi Figma Plugin
• 快速开始
• 组件总览
• 自定义主题
• DSM主题商店
• Design Tokens
• 暗色模式
• Icons
• 全局配置
• 国际化
• 常见问题
• CHANGELOG

👌 平台支持

Semi UI 支持所有主流浏览器。

|
chrome|
firefox|
safari|
IE/Edge|
Electron| |--|--|--|--|--| | latest 2 versions | latest 2 versions | latest 2 versions | Edge | latest 2 versions |

👐 贡献指南

阅读贡献指南了解我们的开发流程，包括开发规范、测试规范和构建规范等。

CONTRIBUTING

👨‍👨‍👧‍👦 交流群

有任何问题可以进群交流，我们会及时给予解答和反馈。

加入用户群.

💖 Thanks

感谢 Chromatic 提供可视化测试平台，帮助我们审查 UI 更改和提供视觉回归测试。

感谢 Cypress 提供 E2E 测试。

🎈 协议

Semi UI 使用 MIT 协议