ant-design/docs/react/practical-projects.en-US.md

266 lines
6.8 KiB
Markdown
Raw Normal View History

2016-09-18 17:39:11 +08:00
---
order: 3
title: Practical Projects
---
[dva](https://github.com/dvajs/dva) is a React and redux based, lightweight and elm-style framework, which supports side effects, hot module replacement, dynamic on demand, react-native, SSR. And it has been widely used in production environment.
This article will guide you to create a simple application from zero using dva and antd.
Include the following:
---
## Install dva
Install dva with npm.
```bash
$ npm install dva-cli -g
```
## Create New App
After installed dva-cli, you can have access to the `dva` command in terminal. Now, create a new application with `dva new`.
```bash
$ dva new dva-quickstart
```
This creates `dva-quickstart` directory, that contains the project directories and files, and provides development server, build script, mock service, proxy server and so on.
Then `cd` the `dva-quickstart` directory, and start the development server.
```bash
$ cd dva-quickstart
$ npm start
```
2016-11-16 21:34:28 +08:00
After a few seconds, you will see the following output:
2016-09-18 17:39:11 +08:00
```bash
proxy: load rule from proxy.config.js
proxy: listened on 8989
📦 411/411 build modules
webpack: bundle build is now finished.
```
Open http://localhost:8989 in your browser, you will see dva welcome page.
## Integrate antd
2016-10-22 17:29:00 +08:00
Install `antd` and `babel-plugin-import` with npm. `babel-plugin-import` is used to automatically import scripts and stylesheets from antd in demand. See [repo](https://github.com/ant-design/babel-plugin-import) 。
2016-09-18 17:39:11 +08:00
```bash
$ npm install antd babel-plugin-import --save
2016-09-18 17:39:11 +08:00
```
Edit `webpack.config.js` to integrate `babel-plugin-import`.
2016-09-18 17:39:11 +08:00
```diff
2016-09-23 15:35:17 +08:00
+ webpackConfig.babel.plugins.push(['import', {
+ libraryName: 'antd',
+ style: 'css',
2016-09-18 17:39:11 +08:00
+ }]);
```
> Notice: No need to manually restart the server, it will restart automatically after you save the `webpack.config.js`.
## Define Router
We need to write an application displaying the list of products. The first step is to create a route.
Create a route component `routes/Products.js`:
```javascript
import React from 'react';
2016-11-14 14:16:12 +08:00
const Products = (props) => (
<h2>List of Products</h2>
);
2016-09-18 17:39:11 +08:00
2016-09-19 21:53:00 +08:00
export default Products;
2016-09-18 17:39:11 +08:00
```
2016-11-16 21:34:28 +08:00
Add routing information to router, edit `router.js`:
2016-09-18 17:39:11 +08:00
```diff
+ import Products from './routes/Products';
...
+ <Route path="/products" component={Products} />
```
Then open http://localhost:8989/#/products in your browser, you should be able to see the `<h2>` tag defined before.
## Write UI Components
As your application grows and you notice you are sharing UI elements between multiple pages (or using them multiple times on the same page), in dva it's called reusable components.
Let's create a `ProductList` component that we can use in multiple places to show a list of products.
Create `components/ProductList.js` and typing:
```javascript
import React, { PropTypes } from 'react';
import { Table, Popconfirm, Button } from 'antd';
const ProductList = ({ onDelete, products }) => {
2016-11-14 14:16:12 +08:00
const columns = [{
title: 'Name',
dataIndex: 'name',
}, {
title: 'Actions',
render: (text, record) => {
return (
<Popconfirm title="Delete?" onConfirm={() => onDelete(record.id)}>
<Button>Delete</Button>
</Popconfirm>
);
2016-09-18 17:39:11 +08:00
},
2016-11-14 14:16:12 +08:00
}];
2016-09-18 17:39:11 +08:00
return (
<Table
dataSource={products}
columns={columns}
/>
);
};
ProductList.proptypes = {
onDelete: PropTypes.func.isRequired,
products: PropTypes.array.isRequired,
};
export default ProductList;
```
## Define Model
After complete the UI, we will begin processing the data and logic.
dva manages domain model with `model`, with reducers for synchronous state update, effects for async logic, and subscriptions for data source subscribe.
Let's create a model `models/products.js` and typing:
```javascript
import dva from 'dva';
export default {
namespace: 'products',
state: [],
reducers: {
'delete'(state, { payload: id }) {
return state.filter(item => item.id !== id);
},
},
};
```
In this model:
- `namespace` represent the key on global state
- `state` is the initial value, here is an empty array
- `reducers` is equal to reducer in redux, accepting action, and update state synchronously
Then don't forget to require it in `index.js`:
```diff
// 3. Model
+ app.model(require('./models/products'));
```
## Connect
2016-11-16 21:34:28 +08:00
So far, we have completed a separate model and component. Then how to connect these together?
2016-09-18 17:39:11 +08:00
2016-11-16 21:34:28 +08:00
dva provides a `connect` method. If you are familiar with redux, this `connect` is from react-router.
2016-09-18 17:39:11 +08:00
Edit `routes/Products.js` and replace with following:
```javascript
import React from 'react';
import { connect } from 'dva';
import ProductList from '../components/ProductList';
2016-11-14 14:16:12 +08:00
const Products = ({ dispatch, products }) => {
2016-09-18 17:39:11 +08:00
function handleDelete(id) {
2016-11-14 14:16:12 +08:00
dispatch({
2016-09-18 17:39:11 +08:00
type: 'products/delete',
payload: id,
});
}
return (
<div>
<h2>List of Products</h2>
2016-11-14 14:16:12 +08:00
<ProductList onDelete={handleDelete} products={products} />
2016-09-18 17:39:11 +08:00
</div>
);
};
// export default Products;
export default connect(({ products }) => ({
2016-11-14 14:16:12 +08:00
products,
2016-09-18 17:39:11 +08:00
}))(Products);
```
Finally, we need some initial data to make the application run together. Edit `index.js`:
```diff
- const app = dva();
+ const app = dva({
+ initialState: {
+ products: [
+ { name: 'dva', id: 1 },
+ { name: 'antd', id: 2 },
+ ],
+ },
+ });
```
Refresh your browser, you should see the following result:
2016-09-21 11:28:38 +08:00
<p style="text-align: center">
2016-09-18 17:39:11 +08:00
<img src="https://zos.alipayobjects.com/rmsportal/GQJeDDeUCSTRMMg.gif" />
</p>
## Build
Now that we've written our application and verified that it works in development, it's time to get it ready to deploy to our users. To do so, run the following command:
```bash
$ npm run build
```
After a few seconds, the output should be as follows:
```bash
Child
Time: 14008ms
Asset Size Chunks Chunk Names
index.html 255 bytes [emitted]
common.js 1.18 kB 0 [emitted] common
index.js 504 kB 1, 0 [emitted] index
index.css 127 kB 1, 0 [emitted] index
```
The `build` command packages up all of the assets that make up your application —— JavaScript, templates, CSS, web fonts, images, and more. Then you can find these files in the `dist /` directory.
## What's Next
We have completed a simple application, but you may still have lots of questions, such as:
- How to dealing with async logic
- How to load initial data elegantly
- How to handle onError globally and locally
- How to load Routes and Models on demand
- How to implement HMR
- How to mock data
- and so on...
You can:
2016-11-16 21:34:28 +08:00
- Visit [dva official website](https://github.com/dvajs/dva).
2016-11-14 14:16:12 +08:00
- View all the [API](https://github.com/dvajs/dva#api).
- View [tutorial](https://github.com/dvajs/dva-docs/blob/master/v1/zh-cn/tutorial/01-%E6%A6%82%E8%A6%81.md), complete a medium application step by step.
2016-11-14 14:16:12 +08:00
- View examples, such as [dva version of hackernews](https://github.com/dvajs/dva-hackernews).