Files
zb-table/readme.md

137 lines
4.9 KiB
Markdown
Raw Normal View History

2022-03-02 10:56:22 +08:00
## 介绍
2022-03-09 11:53:54 +08:00
基于uni-app开发的一个普通的表格组件功能有固定首列和表头、排序、操作按钮、已用于生产环境
2022-03-02 10:56:22 +08:00
2022-03-02 15:00:38 +08:00
## table 属性
| 参数 | 说明 | 类型 | 可选值 | 默认值 |是否必须|
| ------ | ------ | ------ | ------ | ------ |------ |
| data | 显示的数据 | array |-- | -- |必须 |
| column | 显示的列数据 | array |-- | -- |必须 |
| stripe | 是否为斑马纹 table| boolean | - |false | 否 |
| fit | 列的宽度是否自撑开 | boolean |true,false | false |否 |
| show-header | 是否显示表头 | boolean |true,false | true |否 |
2022-03-09 19:22:07 +08:00
| border | 是否带有纵向边框 | boolean |true,false | true |否 |
2022-03-02 15:00:38 +08:00
2022-03-08 17:54:47 +08:00
## table 事件
| 参数 | 说明 | 类型 | 可选值 | 默认值 |是否必须|
| ------ | ------ | ------ | ------ | ------ |------ |
2022-03-09 19:22:07 +08:00
| 事件名自定义 | 取决于type类型为operation的 renders参数里面 func 的参数名 | Function |(row,index)=>{} | -- |否 |
| toggleRowSelection | 用于多选表格,切换某一行的选中状态,第一个参数代表选中状态,参数二代表选中的对象 | Function |(selected ,array)=>{} | -- |否 |
| toggleAllSelection | 用于多选表格,切换所有行的选中状态 ,第一个参数代表选中状态,参数二代表选中的对象| Function |(selected ,array)=>{} | -- |否 |
2022-03-02 15:00:38 +08:00
2022-03-02 10:56:22 +08:00
## column 属性
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| ------ | ------ | ------ | ------ | ------ |
2022-03-08 17:54:47 +08:00
| name | 属性值 | string |-- | 无 |
| label | 显示的标题 | string |-- | 无 |
2022-03-02 15:00:38 +08:00
| width | 列的宽度 | number |-- | 100 |
2022-03-08 17:54:47 +08:00
| fixed | 列是否固定在左侧true 表示固定在左侧 | boolean |true,false | true |
| sorter | 排序 | boolean |true,false | false |
| emptyString | 当值为空的时候默认显示的值 | string | | -- |
2022-03-09 19:22:07 +08:00
| filters | 对象过滤的选项,对象格式,对象中的元素需要有 key 和 value 属性。 | Object | {key:value} | -- |
| align | 对齐方式 | String | left/center/right | left |
| type | 为 operation 的时候代表为操作按钮 | string | operation | -- |
| renders | type 为operation的时候 必传 | Array | {name:'名字',func:"父元素接收事件名",type:"按钮的类型",size:"大小"} | -- |
2022-03-09 11:53:54 +08:00
```
type 为 operation 的时候代表为操作按钮
renders 代表传入的按钮 Array =>[
{
name:'编辑',
type:'primary',代表按钮的类型
size:'mini',代表按钮的大小
func:'edit' // func 代表操作按钮点击的事件名字 父元素接收的事件 父元素 @edit
例如:// <zb-table @edit=""/>
}
]
```
## 示例
```
<zb-table
:show-header="true"
:columns="column"
:stripe="true"
:fit="false"
@edit="buttonEdit"
@dele="dele"
:data="data"/>
```
2022-03-02 10:56:22 +08:00
## 数据格式
```
column:[
2022-03-08 17:54:47 +08:00
{ name: 'name', label: '姓名',fixed:true,width:80,emptyString:'--' },
{ name: 'age', label: '年纪',sorter:true },
2022-03-02 10:56:22 +08:00
{ name: 'sex', label: '性别' },
{ name: 'address', label: '地址' },
2022-03-08 17:54:47 +08:00
{ name: 'date', label: '日期',sorter:true },
2022-03-02 10:56:22 +08:00
{ name: 'province', label: '省份' },
{ name: 'city', label: '城市' },
{ name: 'zip', label: '邮编' },
2022-03-08 17:54:47 +08:00
{ name: 'operation', type:'operation',label: '操作',width: 150,renders:[
{
name:'编辑',
func:'edit' // func 代表子元素点击的事件 父元素接收的事件 父元素 @edit
},
{
name:'删除',
type:'warn',
func:"dele"
}
]},
2022-03-02 10:56:22 +08:00
],
data:[
{
date: '2016-05-02',
name: '王小虎1',
province: '上海',
sex:'男',
age:'18',
city: '普陀区',
address: '上海市普',
zip: 200333
},
{
date: '2016-05-02',
name: '王小虎2',
province: '上海',
sex:'男',
age:'18',
city: '普陀区',
address: '上海市普',
zip: 200333
},
{
date: '2016-05-02',
name: '王小虎3',
province: '上海',
sex:'男',
age:'18',
city: '普陀区',
address: '上海市普',
zip: 200333
},
{
date: '2016-05-02',
name: '王小虎4',
province: '上海',
sex:'男',
age:'18',
city: '普陀区',
address: '上海市普',
zip: 200333
},
{
date: '2016-05-02',
name: '王小虎5',
province: '上海',
sex:'男',
age:'18',
city: '普陀区',
address: '上海市普',
zip: 200333
}
]
```