| 1 | # Choerodon UI
|
| 2 |
|
| 3 | An enterprise-class UI design language and React-based implementation.
|
| 4 |
|
| 5 | [中文 README](README-zh_CN.md)
|
| 6 |
|
| 7 | ## Features
|
| 8 |
|
| 9 | - Extracted from the interactive language and visual style of enterprise-level medium and backstage products.
|
| 10 | - A set of high-quality React components out of the box.
|
| 11 | - Written in TypeScript with predictable static types.
|
| 12 | - The whole package of development and design resources and tools.
|
| 13 |
|
| 14 | ## Environment Support
|
| 15 |
|
| 16 | - Modern browsers and Internet Explorer 9+ (with [polyfills](https://ant.design/docs/react/getting-started#Compatibility))
|
| 17 | - Server-side Rendering
|
| 18 | - [Electron](http://electron.atom.io/)
|
| 19 |
|
| 20 | ## Install
|
| 21 |
|
| 22 | ```bash
|
| 23 | npm install choerodon-ui --save
|
| 24 | ```
|
| 25 |
|
| 26 | ## Usage
|
| 27 |
|
| 28 | ```jsx
|
| 29 | import { DatePicker } from 'choerodon-ui';
|
| 30 | import { Table } from 'choerodon-ui/pro';
|
| 31 | ReactDOM.render(<><DatePicker /><Table /></>, mountNode);
|
| 32 | ```
|
| 33 |
|
| 34 | And import style manually:
|
| 35 |
|
| 36 | ```jsx
|
| 37 | import 'choerodon-ui/dist/choerodon-ui.css'; // or 'choerodon-ui/dist/choerodon-ui.less'
|
| 38 | import 'choerodon-ui/dist/choerodon-ui-pro.css'; // or 'choerodon-ui/dist/choerodon-ui-pro.less'
|
| 39 | ```
|
| 40 |
|
| 41 | Or [import components on demand](https://open-hand.github.io/choerodon-ui/en/docs/other/introduce#%E6%8C%89%E9%9C%80%E5%8A%A0%E8%BD%BD)
|
| 42 |
|
| 43 |
|
| 44 | ## Internationalization
|
| 45 |
|
| 46 | See [i18n](https://open-hand.github.io/choerodon-ui/en/docs/other/i18n).
|
| 47 |
|
| 48 | ## Links
|
| 49 |
|
| 50 | - [Home page](https://open-hand.github.io/choerodon-ui/en)
|
| 51 | - [Components](https://open-hand.github.io/choerodon-ui/en/docs/other/introduce)
|
| 52 | - [Change Log](CHANGELOG.en-US.md)
|
| 53 | - [Scaffold Market](http://scaffold.ant.design)
|
| 54 | - [rc-components](http://react-component.github.io/)
|
| 55 | - [Customize Theme](https://open-hand.github.io/choerodon-ui/customize-theme)
|
| 56 |
|
| 57 | ## Local Development
|
| 58 |
|
| 59 | ```bash
|
| 60 | $ git clone https://github.com/open-hand/choerodon-ui.git
|
| 61 | $ cd choerodon-ui
|
| 62 | $ npm install
|
| 63 | $ npm start
|
| 64 | ```
|
| 65 |
|
| 66 | ## Deployment
|
| 67 |
|
| 68 | ```bash
|
| 69 | $ npm run deploy
|
| 70 | ```
|
| 71 |
|
| 72 | ## publish
|
| 73 |
|
| 74 | ```bash
|
| 75 | $ npm run pub
|
| 76 | ```
|
| 77 |
|
| 78 | Open your browser and visit http://127.0.0.1:8001 , see more at https://open-hand.github.io/choerodon-ui/en/tutorials/introduction .
|