ant-design/docs/react/getting-started.md

156 lines
5.1 KiB
Markdown
Raw Normal View History

2015-06-04 17:56:09 +08:00
# 快速上手
2015-08-24 15:57:00 +08:00
- category: 1
2015-06-04 17:56:09 +08:00
- order: 1
2015-11-05 20:37:06 +08:00
Ant Design React 致力于提供给程序员**愉悦**的开发体验。
2015-07-03 18:06:47 +08:00
2016-03-14 16:18:06 +08:00
---
2015-11-23 16:02:31 +08:00
## 第一个例子
2015-11-23 15:20:42 +08:00
2016-01-20 15:42:52 +08:00
最简单的试用方式参照以下 CodePen 演示,也推荐 Fork 本例来进行 `Bug Report`,注意不要在实际项目中这样使用。
2015-11-23 15:20:42 +08:00
2016-01-20 15:42:52 +08:00
- [antd CodePen](http://codepen.io/anon/pen/pgdXYp?editors=001)
2015-11-23 15:20:42 +08:00
2015-11-23 16:02:31 +08:00
## 标准开发
2015-11-23 15:20:42 +08:00
2015-11-05 20:37:06 +08:00
实际项目开发中,你会需要对 ES2015 和 JSX 代码的构建、调试、代理、打包部署等一系列工程化的需求。
2015-10-22 11:01:36 +08:00
我们提供了一套 `npm` + `webpack` 的开发工具链来辅助开发,下面我们用一个简单的实例来说明。
2015-07-03 18:06:47 +08:00
2016-01-19 17:30:58 +08:00
### 1. 安装脚手架工具
2015-07-03 18:06:47 +08:00
2015-11-30 17:09:16 +08:00
> 使用 `antd-init` 前,务必确认 [Node.js](https://nodejs.org/en/) 已经升级到 v4.x 或以上。
2015-07-03 18:06:47 +08:00
```bash
2015-10-29 16:31:16 +08:00
$ npm install antd-init -g
2015-07-03 18:06:47 +08:00
```
2016-01-19 17:30:58 +08:00
更多功能请参考 [脚手架工具](https://github.com/ant-design/antd-init/) 和 [开发工具文档](http://ant-tool.github.io/)。
2015-07-03 18:06:47 +08:00
### 2. 创建一个项目
使用命令行进行初始化。
```bash
$ mkdir antd-demo && cd antd-demo
2015-10-29 16:31:16 +08:00
$ antd-init
2015-10-22 16:03:59 +08:00
$ npm install
2015-07-03 18:06:47 +08:00
```
2015-11-20 11:33:42 +08:00
若安装缓慢报错,可尝试用 `cnpm` 或别的镜像源自行安装:`rm -rf node_modules && cnpm install`.
2015-10-22 16:03:59 +08:00
2015-07-03 18:06:47 +08:00
### 3. 使用组件
2015-10-22 15:53:49 +08:00
编辑 `src/component/App.jsx`,用 React 的方式直接使用 Ant Design React 的组件。
2015-07-03 18:06:47 +08:00
```jsx
2015-08-20 18:19:51 +08:00
import React from 'react';
import { DatePicker, message } from 'antd';
2015-07-17 13:55:39 +08:00
2015-10-22 15:53:49 +08:00
const App = React.createClass({
2015-07-17 13:55:39 +08:00
getInitialState() {
return {
date: ''
};
},
handleChange(value) {
2015-08-26 16:38:55 +08:00
message.info('您选择的日期是: ' + value.toString());
2015-07-17 13:55:39 +08:00
this.setState({
date: value
});
},
2015-07-03 18:06:47 +08:00
render() {
2015-08-26 16:38:55 +08:00
return <div style={{width: 400, margin: '100px auto'}}>
<DatePicker onChange={this.handleChange} />
2015-08-26 16:38:55 +08:00
<div style={{marginTop: 20}}>当前日期:{this.state.date.toString()}</div>
2015-07-17 13:55:39 +08:00
</div>;
2015-07-03 18:06:47 +08:00
}
});
2015-10-22 15:53:49 +08:00
export default App;
2015-07-03 18:06:47 +08:00
```
2015-10-22 15:53:49 +08:00
你可以在 [这里](/components/button) 选用更多组件。
2015-07-03 18:06:47 +08:00
### 4. 开发调试
2016-01-23 15:31:19 +08:00
一键启动调试,访问 http://127.0.0.1:8989 查看效果。
2015-07-03 18:06:47 +08:00
```bash
$ npm run dev
```
### 5. 构建和部署
```bash
$ npm run build
```
入口文件会构建到 `dist` 目录中,你可以自由部署到不同环境中进行引用。
2015-08-22 19:13:06 +08:00
> 上述例子用于帮助你理解 Ant Design React 的使用流程,并非真实的开发过程,你可以根据自己的项目开发流程进行接入。
2015-07-08 12:55:23 +08:00
2015-07-03 18:06:47 +08:00
## 兼容性
2015-08-22 19:13:06 +08:00
Ant Design React 支持所有的现代浏览器和 IE8+。
2015-07-03 18:06:47 +08:00
对于 IE8需要提供 [es5-shim](http://facebook.github.io/react/docs/working-with-the-browser.html#browser-support-and-polyfills) 等 Polyfills 的支持。
<div class="code-line-highlight"></div>
<style>
.code-line-highlight {
2016-03-19 13:54:38 +08:00
box-shadow: 0px 184px 0px rgba(255, 207, 0, 0.1);
height: 42px;
margin-top: -42px;
position: relative;
z-index: 1;
2016-01-10 19:19:14 +08:00
width: 80%;
2016-03-19 13:54:38 +08:00
pointer-events: none;
}
</style>
2015-07-03 18:06:47 +08:00
```html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<!-- 引入样式 -->
2015-10-22 11:01:36 +08:00
<link rel="stylesheet" href="/index.css">
2015-07-20 16:07:02 +08:00
<!-- Polyfills -->
2016-03-09 16:01:02 +08:00
<script src="https://as.alipayobjects.com/g/component/??console-polyfill/0.2.2/index.js,es5-shim/4.5.7/es5-shim.min.js,es5-shim/4.5.7/es5-sham.min.js,html5shiv/3.7.2/html5shiv.min.js,media-match/2.0.2/media.match.min.js"></script>
2015-07-03 18:06:47 +08:00
</head>
<body>
</body>
2015-10-22 11:01:36 +08:00
<!-- 引入公用文件 -->
<script src="/common.js"></script>
<!-- 引入入口文件 -->
<script src="/index.js"></script>
2015-07-03 18:06:47 +08:00
</html>
```
2016-03-19 13:54:38 +08:00
另外,由于 `babel@6.x` 对 IE8 的支持不佳,你可能会遇到类似 [#28](https://github.com/ant-tool/atool-build/issues/28) 和 [#858](https://github.com/ant-design/ant-design/issues/858) 的 default 报错的问题。
[antd-init](http://github.com/ant-design/antd-init) 脚手架已经解决了这个问题,你也可以参照这个 [webpack 配置](https://github.com/ant-design/antd-init/blob/f5fb9479ca973fade51fd6754e50f8b3fafbb1df/boilerplate/webpack.config.js#L4-L8)。
2016-02-01 14:44:18 +08:00
> 更多 IE8 下使用 React 的相关问题可以参考https://github.com/xcatliu/react-ie8
2015-11-05 20:24:18 +08:00
## 自行构建
如果想自己维护工作流,我们推荐使用 [webpack](http://webpack.github.io/) 进行构建和调试。理论上你可以利用 React 生态圈中的 [各种脚手架](https://github.com/enaqx/awesome-react#boilerplates) 进行开发,如果遇到问题可参考我们所使用的 [webpack 配置](https://github.com/ant-tool/atool-build/blob/master/src/getWebpackCommonConfig.js) 进行 [定制](http://ant-tool.github.io/webpack-config.html)。
2015-11-05 20:24:18 +08:00
2016-03-22 00:26:33 +08:00
目前社区也有很多基于 antd 定制的 [脚手架](https://github.com/ant-design/ant-design/issues/129),欢迎进行试用和贡献。
2016-03-22 00:22:35 +08:00
2016-04-04 15:21:33 +08:00
## 配置案例
2015-12-04 17:11:18 +08:00
2016-04-04 15:21:33 +08:00
- [改变主色系](https://github.com/ant-design/antd-init/tree/master/examples/customize-antd-theme)
- [使用本地字体](https://github.com/ant-design/antd-init/tree/master/examples/local-iconfont)
- [构建独立文件](https://github.com/ant-design/antd-init/tree/master/examples/build-antd-standalone)
2015-11-05 20:24:18 +08:00
2015-07-03 18:06:47 +08:00
## 小甜点
2015-07-09 14:00:13 +08:00
- 你可以享用 `npm` 生态圈里的所有模块。
2016-04-04 15:21:33 +08:00
- 我们使用了 `babel`,试试用 [ES2015](http://babeljs.io/blog/2015/06/07/react-on-es6-plus/) 的写法来提升编码的愉悦感。