semi-design/packages/semi-ui

Semi-UI

A modern, comprehensive, flexible design system and UI library. Connect DesignOps & DevOps. Quickly build beautiful React apps. Maintained by Douyin-fe team.

[![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] [](https://twitter.com/SemiDesignUI)

🎉 Features

• 💪 Up to 70+ high-quality Components.
• 💅 Code2Design, automatically generate Figma UI Kit according to different themes, keep same between design and code
• 🚀 Powerful Design2Code support, convert figma draft to code in a few seconds
• 💕 Complete A11y support, follows W3C standards to provide keyboard interaction, focus management and ARIA for all components
• 💅 Up to 3000+ Design Tokens can be easily modify by Semi Design system management, make Semi Design to Any Design quickly.
• 🌍 Internationalization Support for Dozens of Languages, timezone, RTL support
• ⚙️ Strict quality assurance, covering unit testing, E2E testing, visual testing
• 👏 Written in Typescript, friendly Static Type Support. Based on Foundation/Adapter architecture, easy to read and contribute
• 🥳 SSR (Server Side Rendering) Compatible.

🔥 Install

# with npm
npm install @douyinfe/semi-ui

# with yarn
yarn add @douyinfe/semi-ui

👍 Usage

Here is a quick example to get you started, it's all you need:

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'));

And Semi UI Doc Site has hundreds of editable examples and live preview, welcome to play with those examples.

📰 News about Semi UI

• Follow on Twitter
• Follow on Medium
• Follow on Dev.to

📌 Documentation

• Semi DSM
• Semi Design2Code
• Semi Figma Plugin
• Quick Start
• Components Overview
• Customizing Themes
• Design Tokens
• Dark Mode
• Semi Icons
• Global Config
• Internationalization
• FAQ
• CHANGELOG

👌 Platform Support

Semi UI supports all major modern browsers.

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

👨‍👨‍👧‍👦 User Group

Join User Group on Feishu / Lark

💖 Thanks

Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.

Thanks to Cypress for providing E2E testing.

👐 Contributing

Thanks to all the people who already contributed!

Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Semi UI.

See CONTRIBUTING documentation.

🎈 License

Semi UI is MIT Licensed