virtuallist-antd

virtualList for antd-table, 实现antd-table的虚拟列表, antd-table无限滚动, infinite scrolling for antd-table

Stats

StarsIssuesVersionUpdatedCreatedSize
virtuallist-antd
6860.6.5-beta.07 days ago2 years agoMinified + gzip package size for virtuallist-antd in KB

Readme

virtuallist-antd

NPM JavaScript Style Guide

仓库(github): https://github.com/crawler-django/virtuallist-antd

版本更新记录(update detail): https://github.com/crawler-django/virtuallist-antd/blob/master/update.md

virtualList for antd-table, 实现antd-table的虚拟列表, antd-table无限滚动, infinite scrolling for antd-table. 支持antd树形表格, antd版本要在4.17.0及以上, virtuallist-antd要再0.6.3及以上. (support tree data, after antd v4.17.0, after virtuallist-antd v0.6.3)

  • 已经支持4.0的antd-table.(4.x ---- v0.3.0后, 3.x ---- v0.2.8.)

    (support antdv4. 4.x --- ^v0.3.0, 3.x --- v0.2.8. 3.x not updated)

  • 你可以像平常一样在columns里使用fixed

    (u can use fixed as usual)

  • 支持进行条件搜索 变更数据.

    (support search data as usual)

  • 目前用了节流 - 60ms 在滚动的时候刷新窗口

    (use throttle, 60ms)

  • 支持分页, calc().

    (support pagination, support scrolly for calc())

  • 只支持纵向虚拟列表.

    (only support vertical virtuallist)

  • 此组件会计算第一行的高度, 并且以第一行的高度为准来固定每行的高度. 组件有自带的css, 会使每行的td不会换行.

    (this component will calculate first line's height and amend following each line's height based on it. It has its own css, which prevents each line's TD from wrapping (td do not wrap))

example

complex example

Install

npm install --save virtuallist-antd

Usage

import * as React from 'react'
import ReactDom from 'react-dom'

import { VList } from 'virtuallist-antd'
import { Table } from 'antd'

function Example(): JSX.Element {
    const dataSource = [...]
    const columns = [...]
    const rowkey = 'xxx'
    return (
        <Table 
            dataSource={dataSource}
            columns={columns}
            rowKey={rowKey}
            scroll={{
                y: 1000 // 滚动的高度, 可以是受控属性。 (number | string) be controlled.
            }}
            // 使用VList 即可有虚拟列表的效果
            components={VList({
                height: 1000 // 此值和scrollY值相同. 必传. (required).  same value for scrolly
            })}
        />
    )
}

ReactDom.render(<Example />, dom)

VList

    VList({
        height: number | string,  // (必填) 对应scrollY. 
        onReachEnd: () => void, // (可选) 滚动条滚到底部触发api. (scrollbar to the end)
        onScroll: () => void, // (可选) 滚动时触发的api. (triggered by scrolling)
        vid: string, // (可选, 如果同一页面存在多个虚拟表格时必填.) 唯一标识. (unique vid, required when exist more vitual table on a page)
    })
    
    VList returns: {
        table: VTable,
        body: {
            wrapper: VWrapper,
            row: VRow,
            cell: VCell,
        }
    }

api

    import { scrollTo } from 'virtuallist-antd'

    // scrollTo
    scrollTo({
        row: number, // 行数. (row number)
        y: number, // y偏移量. (offset Y)
        vid: string, // 对应VList的vid. (same as VList vid)
    })

License

MIT © crawler-django

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.