DouyinFE / semi-design

๐Ÿš€A modern, comprehensive, flexible design system and React UI library. ๐ŸŽจ Provide more than 3000+ Design Tokens, easy to build your design system. Make Semi Design to Any Design. ๐Ÿง‘๐Ÿปโ€๐Ÿ’ป Design to Code in one click
https://semi.design
Other
8.36k stars 707 forks source link
code2design dark-mode design-system design2code designops designtocode figma-plugin react theme ui-libary

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

๐Ÿ”ฅ Install

npm install @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 base on Semi UI with DSM in one click, Provide more than 2700 tokens for you to configure every detail. Sync between Figma and Code at all times.

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.

๐Ÿ‘ 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