/semi-design

๐Ÿš€A modern, comprehensive, flexible design system and React UI library. ๐ŸŽจ Provide more than 2,300+ Design Tokens and powerful DSM tools, easy to build your own design system. Make Semi Design to Any Design

Primary LanguageTypeScriptOtherNOASSERTION

Semi-UI

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

NPM FIGMA LICENSE BUILD-JS BUILD-CSS CODECOV Chromatic Cypress

English | ็ฎ€ไฝ“ไธญๆ–‡

๐ŸŽ‰ Features

  • ๐Ÿ’ช Up to 58 high-quality Components.
  • ๐Ÿ’… 2000+ Design Tokens. Flexible custom render structure. Build your own design system.
  • ๐ŸŒ Internationalization Support for Dozens of Languages.
  • ๐Ÿ‘ Written in Typescript, Friendly Static Type Support.
  • ๐Ÿฅณ 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.

๐Ÿ“Œ Documentation

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

๐Ÿ‘ Contributing

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.

๐Ÿ‘จโ€๐Ÿ‘จโ€๐Ÿ‘งโ€๐Ÿ‘ฆ User Group

Join User Group.

๐Ÿ’– 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.

๐ŸŽˆ License

Semi UI is MIT Licensed