Semi-UI

A modern, comprehensive, flexible design system and UI library. Connect DesignOps & DevOps. Quickly build beautiful React apps.

[![Twitter Follow](https://img.shields.io/twitter/follow/SemiDesignUI?style=social)](https://twitter.com/SemiDesignUI) [![LICENSE][license-badge]][license-url] [![NPM][npm-badge]][npm-url] [![CONTRIBUTORS][contributors-badge]][contributors-url] ![Design Token][Design Token] [![FIGMA][figma-badge]][figma-url] [![CODECOV][codecov-badge]][codecov-url] [![Chromatic][chromatic-badge]][chromatic-url] [![Cypress][cypress-badge]][cypress-url] [npm-badge]: https://img.shields.io/npm/v/@douyinfe/semi-ui.svg [contributors-badge]: https://img.shields.io/github/contributors/DouyinFE/semi-design [contributors-url]: https://github.com/DouyinFE/semi-design/graphs/contributors [Design Token]: https://img.shields.io/badge/Design%20Token-2739%2B-brightgreen [npm-url]: https://www.npmjs.com/package/@douyinfe/semi-ui [figma-badge]: https://img.shields.io/badge/Figma-UIKit-%2318a0fb [figma-url]: https://www.figma.com/@semi [license-badge]: https://img.shields.io/npm/l/@douyinfe/semi-ui [license-url]: https://github.com/DouyinFE/semi-design/blob/main/LICENSE [codecov-badge]: https://img.shields.io/codecov/c/gh/DouyinFE/semi-design [codecov-url]: https://app.codecov.io/gh/DouyinFE/semi-design [chromatic-badge]: https://img.shields.io/badge/test-chromatic-brightgreen [chromatic-url]: https://www.chromatic.com/ [cypress-badge]: https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/k83u7j&style=flat&logo=cypress [cypress-url]: https://dashboard.cypress.io/projects/k83u7j/runs [build-js-badge]: https://img.badgesize.io/https:/unpkg.com/@douyinfe/semi-ui/dist/umd/semi-ui.min.js?label=semi.min.js&compression=gzip [build-js-url]: https://unpkg.com/browse/@douyinfe/semi-ui/dist/umd/semi-ui.min.js [build-css-badge]: https://img.badgesize.io/https:/unpkg.com/@douyinfe/semi-ui/dist/css/semi.min.css?label=semi.min.css&compression=gzip [build-css-url]: https://unpkg.com/browse/@douyinfe/semi-ui/dist/css/semi.min.css

English | [简体中文](./README-zh_CN.md)

# 🎉 Features - 💪 Up to 70+ high-quality Components. Stable updates since 2019 - 🚀 Official Design to Code (D2C) support, convert Figma draft to real code in a few seconds - 💅 Code to Design (C2D), automatically generate Figma UI Kit according to different themes, keep consistency between design and code - 💕 Complete A11y support, follows W3C standards to provide keyboard interaction, focus management and ARIA for all components - 💅 Design system management Semi DSM, up to 3000+ Design Tokens, make Semi Design to Any Design quickly. - 🌍 Internationalization Support for Dozens of Languages, timezone, and RTL support - ⚙️ Strict quality assurance, covering unit testing, E2E testing, and visual testing. - 👏 Written in Typescript, friendly Static Type Support. Based on Foundation/Adapter architecture, easy to read and contribute - 🥳 SSR (Server Side Rendering) Compatible. - 📦 Easily compatible with web components, providing a complete adaptation solution, more suitable for building SDKs, browser plugins and other scenarios that require DOM isolation. # 🔥 Install ```sh npm install @douyinfe/semi-ui ``` ```sh yarn add @douyinfe/semi-ui ``` ```sh pnpm add @douyinfe/semi-ui ``` # 👍 Component Usage Here is a quick example to get you started, it's all you need: ```jsx import React from 'react'; import { createRoot } from 'react-dom/client'; import { Button, Form } from '@douyinfe/semi-ui'; const App = () => ( ); const root = createRoot(document.querySelector('#app')); root.render(); ``` [Semi UI Doc Site](https://semi.design/en-US/) has hundreds of editable examples and live preview, welcome to play with those examples. # ⚡️ Design to Code Usage Install [Semi Figma Plugin](https://www.figma.com/community/plugin/1166339852662786534/Semi-Design-%E8%AE%BE%E8%AE%A1%E8%BD%AC%E4%BB%A3%E7%A0%81). Translate Figma to real code in seconds. Support multiple output formats: JSX + SCSS / Emotion/Tailwind, or JSON Schema DSL - Support Figma devmode, selecting a layer, directly get corresponding code on the right ![design2code](https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/github/devmode.gif) - Or jump to codesandbox to continue editing ![codesandboxdemo](https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/github/1080p-fps5.gif) # 🎨 DSM Usage Define your own design system based on Semi UI with DSM in one click, Provide more than 3000 tokens for you to configure every detail. Sync between Figma and Code always. ![dsmintro](https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/github/dsmintro.png) # 📰 News about Semi UI - [Follow on Twitter](https://twitter.com/SemiDesignUI) - [Follow on Medium](https://medium.com/@semi-design) - [Follow on Dev.to](https://dev.to/semidesign) # 📌 Documentation - [Semi DSM](https://semi.design/dsm) - [Design to Code](https://semi.design/code/en-US) - [Semi Figma Plugin](https://www.figma.com/community/plugin/1166339852662786534/Semi-Design-%E8%AE%BE%E8%AE%A1%E8%BD%AC%E4%BB%A3%E7%A0%81) - [Quick Start](https://semi.design/en-US/start/getting-started) - [Components Overview](https://semi.design/en-US/start/overview) - [Customizing Themes](https://semi.design/en-US/start/customize-theme) - [Design Tokens](https://semi.design/en-US/basic/tokens) - [Dark Mode](https://semi.design/en-US/start/dark-mode) - [Semi Icons](https://semi.design/en-US/basic/icon) - [Global Config](https://semi.design/en-US/other/configprovider) - [Internationalization](https://semi.design/en-US/other/locale) - [FAQ](https://semi.design/en-US/start/faq) - [CHANGELOG](https://semi.design/en-US/start/changelog) # 📝 Blogs - [The Evolution of Semi D2C Design to Code](https://juejin.cn/post/7267418854124699702) - [How to design component library architecture to adapt to different mvvm frameworks](https://bytedance.feishu.cn/wiki/wikcnOVYexosCS1Rmvb5qCsWT1f) - [How we test semi ui](https://medium.com/front-end-weekly/how-we-test-semi-design-component-libraries-64b854f63b65) - [In-depth explanation of Semi theme](https://mp.weixin.qq.com/s/noHoWRuA25PgqFNcurhIUA) - [Accessibility in Semi Design](https://mp.weixin.qq.com/s/O3js-SZDNPEOjGxh-aAkbw) # 👌 Platform Support Semi UI supports all major modern browsers. |[ chrome

](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/chrome/chrome.png)
chrome|[ firefox

](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/firefox/firefox.png)
firefox|[ safari

](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/safari/safari.png)
safari|[ IE/Edge

](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/edge/edge.png)
IE/Edge|[

](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/electron/electron.png)
Electron| |--|--|--|--|--| | latest 2 versions | latest 2 versions | latest 2 versions | Edge | latest 2 versions | # 👨‍👨‍👧‍👦 User Group Join [User Group](https://bytedance.feishu.cn/docs/doccnw93Dujm3UCkHRDTMTm1qwe#) on Feishu / Lark # 💖 Thanks

Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.

Thanks to [Cypress](https://www.cypress.io/) for providing E2E testing.

Thanks to [VisActor](https://www.visactor.com/) for providing the data visualization solution. ## 👐 Contributing Thanks to all the people who already contributed!

Read the contributing guide to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to Semi UI. See [CONTRIBUTING](CONTRIBUTING-en-US.md) documentation. # 🎈 License Semi UI is [MIT Licensed](LICENSE)