Ant Design 使用小结

正如Ant Design 官方介绍: "在中台产品的研发过程中,会出现不同的设计规范和实现方式,但其中往往存在很多类似的页面和组件,给设计师和工程师带来很多困扰和重复建设,大大降低了产品的研发效率。"在这次开发的项目中,因为数据交互非常频繁,大量的表单、时间选择器、表格、单选多选框,以及各种标识状态的组件,如果光靠手写或者使用 jQuery 插件,其开发的工作量仍然是相当大的,因此,Ant Design "经过大量的项目实践和总结,沉淀出一个中台设计语言 Ant Design。旨在统一中台项目的前端 UI 设计,屏蔽不必要的设计差异和实现成本,解放设计和前端的研发资源。"

同时,React 也是第一次使用,起初对于这种 Html 与 JS 代码混杂的书写格式搞得很不舒服,因为作为一个前端开发者,被"结构与逻辑分离"的思想洗脑太久了,但实际上组件的 HTML 是组成一个组件不可分割的一部分,能够将 HTML 封装起来才是组件的完全体,React 发明了 JSX 让 JS 支持嵌入 HTML 不得不说是一种非常聪明的做法,让前端实现真正意义上的组件化成为了可能。所以在使用了 React 开发一段时间后,越来越感觉到 React 封装组件的高效。而 Ant Design 则封装了一系列高质量的 React 组件,十分适用于在企业级的应用中,框架提供的 api 十分详尽,上手和使用相对简单,值得一提的是, Ant Design 使用 ES6 进行编写,因此使用过程中对 ES6 也是一次学习的机会。

在这里主要就项目中使用到的主要的组件以及遇到的一些坑进行总结,也是对这个项目开发的一个简单的梳理。

项目开发中主要用到的组件:

Button、Icon、Row/Col、BackTop、Pagination、Tabs、Checkbox、Cascader、Form、Rate、Select 、Modal、Message、Table

Button 的使用比较简单,需要注意的地方是为了和原生 button 进行区分,Form表单中的 Button 组件的submit 需要写成 htmlType = "submit" ,其他类似的组件也是同理。

举例:

image

使用了两种类型的Button, 并且定义了 Button 的点击事件,事件在 render() 方法外进行定义。

Icon的使用非常简单,Ant Design 提供了常用了Icon , 使用时只需要点击图标即可完成代码的复制。Icon 自带两个属性,type 定义了图标的类型, spin 定义图标是否有旋转动画。

Row / Col 主要用于栅格布局,和BootStrap 的使用十分相似,不同的是 Ant Design 默认把页面分成24份,而不是12份,增加了布局的灵活度。

Tabs 十分实用,通过Tabs 的切换可以十分高效地在同一个页面中展现不同业务的信息。Tabs 的使用也十分简单,只要将每一个 Tab 面板放在 Tabpane 标签里面即可。值得一提的是,如果要实现标签的动态切换(根据 state 的状态进行切换),需要在 Tabs 标签中添加 activeKey 属性,别且绑定 到具体的控制标签切换的 state 上,更重要的是,需要添加 onChange 方法,在标签切换的事件中设置当前 tab 的 state,如下:

image
image

Form 是项目中用的最多的表单了,表单项通过 FormItem 进行定义,并且可以设置对其方式、验证规则、错误提示信息以及绑定初始值,十分有用。

image
image

在最外层的 Form 标签上定义了表单的提交方法,并且把所有的表单项都获取复制到 values 参数中,因此可以对 values 对象进行操作,获取到对象的字段值并经行处理,如下:

image

Modal 主要在弹框和提示框中使用,如果弹框中需要进行数据操作,如选择和填写信息,则直接使用 Modal ,定义标题,按钮方法,以及弹框中的具体内容;如果只是简单的信息提示,比如成功或失败、警告等,则可以根据场景使用 Modal 下的 success、warning、confirm、info方法,使用起来也十分方便,需要注意的是,在这些方法中无法获取到正确的 this 指向,因此需要在方法外部先获取到 this 指针。如下:

image

Table 的的使用过中则遇到了很多的坑,主要是因为表格中的数据都是通过请求接口获取到的,因此需要对数据进行动态渲染,同时表格中的数据还允许操作,甚至,有多个表格需要同时渲染,因此表格的一切都要再请求接口后动态生成,然后渲染到 DOM 结构中去。举例:

image

在这里表格中的数据通过请求接口获取,每一个 item 包含了表格中的所有数据,同时手动为表格中的每一行数据添加一个 index 属性用于标识数据的唯一性(所有通过 for 或者 map 循环出来的数据都需要加标识条目唯一性的 key 值,可以是 id,也可以是自己添加的属性,唯一即可,不这样做的话浏览器会报出警告)。

当获取到数据并生成所有的表格结构后,将此对象复制给 state,并插入到 DOM,便可以实现动态表格以及动态数据的插入。表格的使用,谨慎仔细是十分重要的。

Cascader 在封装选择省市区组件中使用到,这里也有较多的技巧。组件代码如下:

[
复制代码

](javascript:void(0); "复制代码")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; word-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;"> 1 import React, { Component, PropTypes } from 'react'
2 import { connect } from 'react-redux'
3 import Cascader from 'antd/lib/cascader'
4 import Button from 'antd/lib/button'
5 import message from 'antd/lib/message'
6 import ajax from '../../utils/service'
7 import * as inputActions from '../../actions/input'
8
9 let province = [ 10 { value: 2, label: "北京", isLeaf: false }, 11 { value: 3, label: "安徽", isLeaf: false }, 12 { value: 4, label: "福建", isLeaf: false }, 13 { value: 5, label: "甘肃", isLeaf: false }, 14 { value: 6, label: "广东", isLeaf: false }, 15 { value: 7, label: "广西", isLeaf: false }, 16 { value: 8, label: "贵州", isLeaf: false }, 17 { value: 9, label: "海南", isLeaf: false }, 18 { value: 10, label: "河北", isLeaf: false }, 19 { value: 11, label: "河南", isLeaf: false }, 20 { value: 12, label: "黑龙江", isLeaf: false }, 21 { value: 13, label: "湖北", isLeaf: false }, 22 { value: 14, label: "湖南", isLeaf: false }, 23 { value: 15, label: "吉林", isLeaf: false }, 24 { value: 16, label: "江苏", isLeaf: false }, 25 { value: 17, label: "江西", isLeaf: false }, 26 { value: 18, label: "辽宁", isLeaf: false }, 27 { value: 19, label: "内蒙古", isLeaf: false }, 28 { value: 20, label: "宁夏", isLeaf: false }, 29 { value: 21, label: "青海", isLeaf: false }, 30 { value: 22, label: "山东", isLeaf: false }, 31 { value: 23, label: "山西", isLeaf: false }, 32 { value: 24, label: "陕西", isLeaf: false }, 33 { value: 25, label: "上海", isLeaf: false }, 34 { value: 26, label: "四川", isLeaf: false }, 35 { value: 27, label: "天津", isLeaf: false }, 36 { value: 28, label: "西藏", isLeaf: false }, 37 { value: 29, label: "新疆", isLeaf: false }, 38 { value: 30, label: "云南", isLeaf: false }, 39 { value: 31, label: "浙江", isLeaf: false }, 40 { value: 32, label: "重庆", isLeaf: false }, 41 { value: 33, label: "香港", isLeaf: false }, 42 { value: 34, label: "澳门", isLeaf: false }, 43 { value: 35, label: "台湾", isLeaf: false } 44 ];
45
46 let options = province 47
48 class Location extends Component {
49 constructor(props) {
50 super(props);
51
52 }
53 state = { 54 options: options,
55 inputValue: '',
56 }
57
58 componentWillMount(){
59 const {hideLoading} = this.props;
60 setTimeout(() => { hideLoading()}, 1000)
61 }
62
63 _onChange = (value, selectedOptions) => { 64 console.log(value);
65 this.setState({
66 inputValue: selectedOptions.map(o=>o.label).join(', ')
67 });
68 const onChange = this.props.onChange;
69
70 if (onChange) { 71 onChange({...value});
72 }
73 }
74
75 _loadData = (selectedOptions) => { 76 const targetOption = selectedOptions[selectedOptions.length - 1];
77 const id = targetOption.value; 78 targetOption.loading = true;
79
80 if (selectedOptions.length == '1') {
81 // 点击省,获取市
82 ajax.post(ajax.api.GETSERVICEAREA, { id: id, token: localStorage.token }).then(data => { 83 if(data.status.code == '1'){
84 targetOption.loading = false;
85 targetOption.children = []; 86 data.result.map((v, k)=>{
87 // 拼出市
88 targetOption.children.push({
89 value: v.id,
90 label: v.name,
91 isLeaf: false,
92 });
93 });
94 this.setState({
95 options: [...this.state.options],
96 });
97 }
98 });
99 }else if (selectedOptions.length == '2') { 100 // 点击市,获取区
101 ajax.post(ajax.api.GETSERVICEAREA, { id: id, token: localStorage.token }).then(data => { 102 if(data.status.code == '1'){ 103 targetOption.loading = false; 104 targetOption.children = []; 105 data.result.map((v, k)=>{ 106 // 拼出区
107 targetOption.children.push({ 108 value: v.id, 109 label: v.name, 110 isLeaf: true, 111 }); 112 }); 113 this.setState({ 114 options: [...this.state.options], 115 }); 116 } 117 }); 118 }else { 119 targetOption.loading = false; 120 } 121 } 122
123 _resetLocation = () => { 124 document.getElementsByClassName('ant-cascader-picker-clear')[0].click(); 125 this.setState({ 126 inputValue: '', 127 }); 128 } 129
130 render() { 131 return ( 132 <div>
133 <Cascader 134 options={this.state.options} 135 loadData={this._loadData} 136 onChange={this._onChange} 137 changeOnSelect 138 placeholder=""
139 />
140 </div>
141 ) 142 } 143 } 144
145 export default connect(state => ({ 146 showLoginLayer: state.login.isShowLoginLayer 147 }), inputActions)(Location)</pre>

[
复制代码

](javascript:void(0); "复制代码")

其中要注意的地方很多,首先是初始值的设置。因为使用省市区组件,不能一次性拉取到所有的地区,这样会十分消耗性能,造成不良的用户体验,正确的做法是在点击时获取下一级的地区信息,这样有针对性的请求可以减少加载时间,那么问题来了,如何实现?

首先,使用 Cascader 的 api 中有 loadData 属性,可以定义数据的加载,同时,onChange 事件可以监听到每一次的数据变化,但是使用 Cascader 有一个限制,便是第一级的数据需要在加载组件之前就定义并获取到,否则无法进行下一级数据的加载,因此这里单独定义了所有了省的数据:

image

onChange 事件获取到当前选择的对象,并提供了两个参数,分别是选择的当前值(数组类型)和选择的多级对象(当前选择的对象和当前对象下一级的数组对象)。

在获取到当前选中的对象后对值进行拼接处理并赋值给 inputValue (在组件框中显示的选中值),同时设置onChange()方法,将值的变化情况通知给父组件(如 FormItem )

image

loadData()方法用于组件级联数据的加载,其参数就是 onChange()方法的第二个参数,在这里获取到参数的最后一个对象(即当前点击的对象),通过判断参数的长度来识别当前要获取的数据的类型(市还是区),获取到数据后生成组件要求的数据格式,最后将格式化的数据赋值给 option 就可以了。

image

最后,模拟了一个重置(清空)的功能,Cascader 值的清空有两点,一是选择框内容的清空,二是级联数据的重置,内容的清空比较简单,直接将 inputValue 设置为空即可,而级联数据的重置不能将 option 设置为空,这样会导致级联组件无法使用(下拉数据为空),为此使用了一个小技巧:

在组件的 api 属性中有一个allowClear 属性,默认是 true,即允许清空,其效果是当鼠标移到选择数据后的级联表单上会出现一个 叉号的按钮,如下:

image
image

通过开发者工具可以获取到这个按钮的类名,那么之后的操作就简单了: 自定义一个重置(清空)按钮,然后触发清空按钮的事件即可:

image

推荐阅读更多精彩内容