readme.md 4.5 KB
Newer Older
雪洛's avatar
雪洛 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148


## Table 表单
> 组件名:``uni-table``,代码块: `uTable`。

用于展示多条结构类似的数据

### 平台差异说明

目前仅支持pc端

### 组件使用注意事项

为了避免错误使用,给大家带来不好的开发体验,请在使用组件前仔细阅读下面的注意事项,可以帮你避免一些错误。

- 组件需要依赖 `sass` 插件 ,请自行手动安装
- 如使用过程中有任何问题,或者您对uni-ui有一些好的建议,欢迎加入 uni-ui 交流群:871950839

### 安装方式

本组件符合[easycom](https://uniapp.dcloud.io/collocation/pages?id=easycom)规范,`HBuilderX 2.5.5`起,只需将本组件导入项目,在页面`template`中即可直接使用,无需在页面中`import`和注册`components`

如需通过`npm`方式使用`uni-ui`组件,另见文档:[https://ext.dcloud.net.cn/plugin?id=55](https://ext.dcloud.net.cn/plugin?id=55)


### 基本用法 
表格是由4个组件: `uni-table`表格组件、`uni-tr`表格行 、`uni-th` 表格头、`uni-td` 单元格组成

需要注意的是:
- `uni-table` 的根节点一定是 `uni-tr`
- `uni-tr` 的根节点一定是 `uni-th` 或者 `uni-td`
- 一个表格内理论上只能包含表头行
- 目前只能在 `uni-th` 中设置 width 属性,`uni-td` 的宽度跟随 `uni-th` 宽度变化


```html
<uni-table border stripe emptyText="暂无更多数据" >
	<!-- 表头行 -->
	<uni-tr>
		<uni-th align="center">日期</uni-th>
		<uni-th align="center">姓名</uni-th>
		<uni-th align="left">地址</uni-th>
	</uni-tr>
	<!-- 表格数据行 -->
	<uni-tr>
		<uni-td>2020-10-20</uni-td>
		<uni-td>Jeson</uni-td>
		<uni-td>北京市海淀区</uni-td>
	</uni-tr>
	<uni-tr>
		<uni-td>2020-10-21</uni-td>
		<uni-td>HanMeiMei</uni-td>
		<uni-td>北京市海淀区</uni-td>
	</uni-tr>
	<uni-tr>
		<uni-td>2020-10-22</uni-td>
		<uni-td>LiLei</uni-td>
		<uni-td>北京市海淀区</uni-td>
	</uni-tr>
	<uni-tr>
		<uni-td>2020-10-23</uni-td>
		<uni-td>Danner</uni-td>
		<uni-td>北京市海淀区</uni-td>
	</uni-tr>

</uni-table>
</script>
			 
```




## API

### Table Props

|属性名		| 类型			|默认值	 		| 可选值	| 说明|
|:-:			| :-:			|:-:			| :-:	| :-:	|
|border		| Boolean		| false			| -		| 是否带有纵向边框	|
|stripe		| Boolean		| false			| -		| 是否显示斑马线样式	|
|type			| String		| ''			| -			| 值为type="selection" 时开启多选|
|emptyText	| String		| 没有更多数据	| -		| 空数据时显示的文本内容	|
|loading		| Boolean		| false			| -		| 显示加载中|	

### Table Events

事件称名				|说明									| 返回参数			
:-:					|:-:									| :-:				
selection-change	| 开启多选时,当选择项发生变化时会触发该事件	| Function(Object)

### Table Methods
**Tips: 因微信小程序框架问题,暂不支持如下方法**

|方法称名							|说明				|参数|
|:-:								|:-:				|:-:|
|selectionAll				|选中全部行	|-	|
|toggleRowSelection	|用于多选表格,切换某一行的选中状态,如果使用了第二个参数,则是设置这一行选中与否(selected 为 true 则选中)	| Function(Array:[行索引],Boolean:selected)	|
|clearSelection	|用于多选表格,清空用户的选择	|-	|
|toggleAllSelection	|用于多选表格,切换所有行的选中状态	|-	|



### Th Props

|属性名		|类型		|默认值	 	|可选值				|说明|
|:-:			|:-:		|:-:			|	:-:				|:-:|
|width		|String	| -				|-					| 单元格宽度|
|align		|String	| left		|left/center/right	| 表头对齐方式|
|filter-type		|String	| 	|search/select/range/date	| 筛选类型,search关键字搜索,select类别选择|
|filter-data		|Array	| 	|| 筛选数据|
|sortable |Boolean| false		|- 	| 是否启用排序|

filter-data 示例
```json
[{
	text: "", //显示
	value: "" // 
}]
```


### Th Events

|事件称名				|说明									| 返回参数			|
|:-:					|:-:									| :-:				|
||sort-change	| 点击排序时会触发该事件	| Function(Object)|
||filter-change	| 筛选数据时会触发该事件	| Function(Object)|

filter-change(e) 说明
```json
e = {
	filterType: "", //筛选类型 search/select/range 和传入的相同
	filter: "" // , filterType=search字符串类型,filterType=select数组类型,filterType=range数组类型,[0]开始值, [1]结束值
}
```


### Td Props

|属性名	|类型	|默认值	 	|可选值				|说明|
|:-:		|:-:		|:-:			|:-:				|:-:|
|align	|Boolean| left		|left/center/right	| 单元格对齐方式|


## 组件示例

点击查看:[https://hellouniapp.dcloud.net.cn/pages/extUI/table/table](https://hellouniapp.dcloud.net.cn/pages/extUI/table/table)