semi-design README

The project's README from github.com/DouyinFE/semi-design. As one markdown file: README.md.

Semi-UI

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

Twitter Follow

LICENSE NPM CONTRIBUTORS Design Token FIGMA CODECOV Chromatic Cypress

English | 简体中文

🎉 Features

🔥 Install

npm install @douyinfe/semi-ui
yarn add @douyinfe/semi-ui
pnpm add @douyinfe/semi-ui

👍 Component Usage

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

import React from 'react';
import { createRoot } from 'react-dom/client';
import { Button, Form } from '@douyinfe/semi-ui';

const App = () => (
    <Form>
        <Form.Input field='name' initValue='semi design'></Form.Input>
        <Button htmlType='submit'>submit</Button>
    </Form>
);

const root = createRoot(document.querySelector('#app'));

root.render(<App />);

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

⚡️ Design to Code Usage

Install Semi Figma Plugin. Translate Figma to real code in seconds. Support multiple output formats: JSX + SCSS / Emotion/Tailwind, or JSON Schema DSL

design2code

codesandboxdemo

🎨 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

📰 News about Semi UI

📌 Documentation

📝 Blogs

👌 Platform Support

Semi UI supports all major modern browsers.

chrome
chrome
firefox
firefox
safari
safari
IE/Edge
IE/Edge
electron
Electron
latest 2 versions latest 2 versions latest 2 versions Edge latest 2 versions

👨‍👨‍👧‍👦 User Group

Join User Group on Feishu / Lark

💖 Thanks

Chromatic

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

Cypress

Thanks to Cypress for providing E2E testing.

VisActor Logo VisActor Logo

Thanks to VisActor 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 documentation.

🎈 License

Semi UI is MIT Licensed

Star History

Star History Chart

semi-design (DouyinFE/semi-design)

Searching Database…

What is this?Semi Design is a comprehensive design system and React UI library: 80+ production-quality components kept stable since 2019, plus tooling that connects design and code — a Figma Design-to-Code plugin and a DSM platform for custom design tokens.
Is it a framework I build my whole app on, or a component library I pull pieces from?A library, not a framework — you install @douyinfe/semi-ui from npm and import just the components you need into an existing React app. It is written in TypeScript, with visuals and logic split into semi-ui and semi-foundation packages.
How do I get it into my project?Run npm install @douyinfe/semi-ui, import the stylesheet and start rendering components. The official doc site also offers hundreds of editable examples with live preview to copy from.
Do I need anything besides React to use it?No — the components are ordinary npm React packages, so any React app works. Node.js 20+ and lerna are only needed if you build the docs site or the monorepo yourself.
Which browsers will it run in?All major modern browsers: the latest two versions of Chrome, Firefox and Safari, plus Edge and Electron per the support table. IE is not on the list — Edge is the floor.
Can it turn my Figma designs into working React code?Yes — official Design to Code support. The Semi Figma Plugin translates a Figma draft into real code in seconds: JSX + SCSS, Emotion or Tailwind, or a JSON Schema DSL. With Figma devmode, selecting a layer shows the matching code right in the panel, and you can jump to CodeSandbox to keep editing.
What is Semi DSM?A design system management platform built on Semi UI: it gives you 3000+ design tokens to configure every detail, so you can reshape Semi into your own design system in one click, with Figma and code kept in sync.
Does it work the other way too — from code back into Figma?Yes, that is Code to Design (C2D): it automatically generates a Figma UI Kit according to your theme, keeping the design files and the code consistent.
How accessible are the components out of the box?Fully — Semi claims complete A11y support following W3C standards, with keyboard interaction, focus management and ARIA provided for all components.
Creator
DouyinFE
Size
65.1 MB
Stars
10.4K
Age
4y
Commits · 90 Days