mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-04 21:18:01 +08:00
104 lines
4.0 KiB
Markdown
104 lines
4.0 KiB
Markdown
<p align="center">
|
||
<a href="http://ant.design">
|
||
<img width="320" src="https://t.alipayobjects.com/images/rmsweb/T1B9hfXcdvXXXXXXXX.svg">
|
||
</a>
|
||
</p>
|
||
|
||
# Ant Design
|
||
|
||
[](https://travis-ci.org/ant-design/ant-design)
|
||
[](https://coveralls.io/github/ant-design/ant-design)
|
||
[](https://david-dm.org/ant-design/ant-design)
|
||
|
||
[](https://www.npmjs.org/package/antd)
|
||
[](https://npmjs.org/package/antd)
|
||
[](http://isitmaintained.com/project/ant-design/ant-design "Average time to resolve an issue")
|
||
[](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
|
||
一套企业级的 UI 设计语言和 React 实现。
|
||
|
||
[README in English](README.md)
|
||
|
||
## 特性
|
||
|
||
- 提炼自企业级中后台产品的交互语言和视觉风格。
|
||
- 开箱即用的高质量 React 组件。
|
||
- 使用 TypeScript 构建，提供完整的类型定义文件。
|
||
- 基于 npm + webpack + [dva](https://github.com/dvajs/dva) 的企业级开发框架。
|
||
|
||
## 安装
|
||
|
||
```bash
|
||
npm install antd
|
||
```
|
||
|
||
## 示例
|
||
|
||
```jsx
|
||
import { DatePicker } from 'antd';
|
||
ReactDOM.render(<DatePicker />, mountNode);
|
||
```
|
||
|
||
引入样式：
|
||
|
||
```jsx
|
||
import 'antd/dist/antd.css'; // or 'antd/dist/antd.less'
|
||
```
|
||
|
||
按需加载可通过此写法 `import DatePicker from 'antd/lib/date-picker'` 或使用插件 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import)。
|
||
|
||
|
||
## 浏览器支持
|
||
|
||
现代浏览器和 IE9 及以上。
|
||
|
||
> [IE8 issues](https://github.com/xcatliu/react-ie8)
|
||
|
||
## TypeScript
|
||
|
||
tsconfig.json
|
||
|
||
```js
|
||
{
|
||
"compilerOptions": {
|
||
"moduleResolution": "node",
|
||
"jsx": "preserve",
|
||
"allowSyntheticDefaultImports": true
|
||
}
|
||
}
|
||
```
|
||
|
||
> 注意：设置 `allowSyntheticDefaultImports` 避免 `error TS1192: Module 'react' has no default export` 的错误。
|
||
|
||
|
||
## 链接
|
||
|
||
- [首页](http://ant.design/)
|
||
- [组件文档](http://ant.design/docs/react/introduce)
|
||
- [更新日志](CHANGELOG.en-US.md)
|
||
- [开发脚手架](https://github.com/dvajs/dva-cli)
|
||
- [开发工具文档](http://ant-tool.github.io/)
|
||
- [React 基础组件](http://react-component.github.io/)
|
||
- [移动端组件](http://mobile.ant.design)
|
||
- [动效](https://motion.ant.design)
|
||
- [设计规范速查手册](https://os.alipayobjects.com/rmsportal/HTXUgPGkyyxEivE.png)
|
||
- [开发者说明](https://github.com/ant-design/ant-design/wiki/Development)
|
||
- [版本发布规则](https://github.com/ant-design/ant-design/wiki/%E8%BD%AE%E5%80%BC%E8%A7%84%E5%88%99%E5%92%8C%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E6%B5%81%E7%A8%8B)
|
||
- [社区贡献脚手架和范例](https://github.com/ant-design/ant-design/issues/129)
|
||
- [常见问题](https://github.com/ant-design/ant-design/wiki/FAQ)
|
||
- [CodePen 模板](http://codepen.io/benjycui/pen/KgPZrE?editors=001) for bug reports
|
||
- [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design)
|
||
- [定制主题](http://ant.design/docs/react/customize-theme)
|
||
|
||
## 如何贡献
|
||
|
||
我们欢迎任何形式的贡献，有任何建议或意见您可以进行 [Pull Request](https://github.com/ant-design/ant-design/pulls)，或者给我们 [提问](https://github.com/ant-design/ant-design/issues)。
|
||
|
||
## 发布周期
|
||
|
||
遵循 [Semantic Versioning 2.0.0](http://semver.org/lang/zh-CN/) 语义化版本规范。
|
||
|
||
* patch 版本：每周末会进行日常 bugfix 更新。（如果有紧急的 bugfix，则任何时候都可发布）
|
||
* minor 版本：每月发布一个带有新特性的版本。
|
||
* 大版本号：含有破坏性更新和新特性，不再发布周期内。
|