0.1.13 • Published 5 years ago

nzx-data-table v0.1.13

Weekly downloads
56
License
-
Repository
-
Last release
5 years ago

如何使用

这是一个抽象组件,无法直接使用。这是针对antd的table组件封装了很多常用操作的基础组件,使用时需要先继承该组件。

API

变量

名称说明类型默认值
dataItems已加载的数据any[][]
filteredItems已筛选的数据any[][]
sortedItems已排序的数据any[][]
loadingItems是否正在加载数据Booleanfalse
pageItems当前分页数据any[]-
selectedItems选中项any[]-
currentItem当前项any-
allChecked全选状态Booleanfalse
indeterminate已选且非全选状态Booleanfalse
sortName排序字段名string-
sortValue排序字段值,可选值参考 nzSortString-
sortMap排序字段映射any-
rowClickSkipTags行点击时忽略的标签名String[]'input', 'button'

方法

名称说明参数返回值
loadItems加载数据(state?: any)Promise<any[]>
filterItems筛选数据(filter?: any, items?: any[])any[]
sortItems排序数据(sortName: String, sortValue: String, items?: any[])any[]
restoreState还原数据状态(item: any, oldItem: any)-
cleanStatus清除选中状态--
checkAll全选(value: Boolean)-
refreshStatus刷新选中状态(state?: any)-
itemEqual判断元素是否相等(x: any, y: any)Boolean
removeItem移除数据(item: T, items?: any[])any[]
  • loadItems: state 会传递给 onLoadItems,加载结果会保存在 dataItems/filteredItems/sortedItems,会自动设置加载状态及还原选中/筛选/排序状态
  • filterItems: items 默认值为 dataItems,筛选结果会保存在 filteredItems,筛选条件会保存在 filterState,排序完成后会自动执行排序
  • sortItems: items 默认值为 filteredItems,排序结果会保存在 sortedItems
  • restoreState: 默认会还原选中状态
  • cleanStatus: 默认会清除 selectedItems/currentItem,刷新选中状态
  • refreshStatus: state 类型为 items?: any[], selectedItems?: any[]items 默认值为 pageItems/sortedItemsselectedItems 默认值为 []
  • removeItem: items 默认值为 dataItems

回调

名称说明参数返回值
onLoadItems加载数据(state?: any)Promise<any[]>
onFilterItems筛选数据(filter: any, items: any)any[]
onSortItems排序数据(items: any[])any[]
onCheckItem选中元素(item: any)boolean

事件

名称说明参数
onRowClick行点击(event: Event, item: any)
onPageChange页码变化(data: any[])

DataTableFns

独立使用 DataTable 时,构造函数的参数为 DataTableFns,包含以下字段,所有字段可选。通过传递不通的字段,可以覆盖 DataTable 对应的函数。

名称对应
loadonLoadItems
filteronFilterItems
restorerestoreState
equalitemEqual
rowClickonRowClick
  • restore: 会先自动调用 DataTable 原始的方法
0.1.13

5 years ago

0.1.12

5 years ago

0.1.11

5 years ago

0.1.10

5 years ago

0.1.9

5 years ago

0.1.8

5 years ago

0.1.7

5 years ago

0.1.6

5 years ago

0.1.5

5 years ago

0.1.4

5 years ago

0.1.3

5 years ago

0.1.2

5 years ago

0.1.1

5 years ago

0.1.0

5 years ago