Choerodon UI of React
Choerodon UI 基于 Material Design 体系精心设计,优雅美观,UED 不断优化升级。支持企业主题定制,开发和服务于企业级后台产品。
官网地址
官网:https://choerodon.github.io/choerodon-ui/zh
国内镜像:https://choerodon.gitee.io/choerodon-ui/zh
Github: https://github.com/open-hand/choerodon-ui
特性
- 提炼自企业级中后台产品的交互语言和视觉风格。
- 开箱即用的高质量 React 组件。
- 使用 TypeScript 构建,提供完整的类型定义文件。
- 全链路开发和设计工具体系。
支持环境
版本
安装
使用 npm 或 yarn 安装
我们推荐使用 npm 或 yarn 的方式进行开发,不仅可在开发环境轻松调试,也可放心地在生产环境打包部署使用,享受整个生态圈和工具链带来的诸多好处。
$ npm install choerodon-ui --save
$ yarn add choerodon-ui
如果你的网络环境不佳,推荐使用 cnpm。
浏览器引入
在浏览器中使用 script
和 link
标签直接引入文件,并使用全局变量 choerodon-ui
。
我们在 npm 发布包内的 choerodon-ui/dist
目录下提供了 choerodon-ui.js
choerodon-ui.css
以及 choerodon-ui.min.js
choerodon-ui.min.css
。你也可以通过 UNPKG 进行下载。
强烈不推荐使用已构建文件,这样无法按需加载,而且难以获得底层依赖模块的 bug 快速修复支持。
示例
import { DatePicker } from 'choerodon-ui';
ReactDOM.render(<DatePicker />, mountNode);
引入样式:
import 'choerodon-ui/dist/choerodon-ui.css'; // or 'choerodon-ui/dist/choerodon-ui.less'
按需加载
下面两种方式都可以只加载用到的组件。
- 使用 babel-plugin-import(推荐)。
// .babelrc or babel-loader option
{
"plugins": [
[
"import",
{
"libraryName": "choerodon-ui",
"libraryDirectory": "es",
"style": "css"
}
] // `style: true` 会加载 less 文件
]
}
注意:webpack 1 无需设置
libraryDirectory
。
然后只需从 choerodon-ui 引入模块即可,无需单独引入样式。等同于下面手动引入的方式。
// babel-plugin-import 会帮助你加载 JS 和 CSS
import { DatePicker } from 'choerodon-ui';
- 手动引入
import DatePicker from 'choerodon-ui/lib/date-picker'; // 加载 JS
import 'choerodon-ui/lib/date-picker/style/css'; // 加载 CSS
// import 'choerodon-ui/lib/date-picker/style'; // 加载 LESS
强烈推荐阅读 《提问的智慧》、《如何向开源社区提问题》 和 《如何有效地报告 Bug》、《如何向开源项目提交无法解答的问题》,更好的问题更容易获得帮助。