@trysound/datagrid

datagrid

Declarative reactive table with unidirectional data flow

API

Grid component

data

columns

[
    {
        name: string,
        displayName: string,
        minWidth: number,
        width: number || string, // 120, '60%' depends on viewportWidth
        maxWidth: number,
        pinnedLeft: boolean,
        pinnedRight: boolean,
        enableResizing: boolean,
        enableMoving: boolean,
        enableFiltering: boolean,
        enableSorting: boolean,
        sort: null | 'asc' | 'desc',
        placeholder: string,
        filter: string
    }
]

gridState

// predefined behaviors
{
    moving?: {
        name: string,
        left: string,
        right: string
    },
    selectedIndex?: number,
    pager?: {
        page: number,
        size: number
    }
}

callback (action: Action) => void

scrollTop number

viewportWidth number

viewportHeight number

headerHeight number

rowHeight number

columnComponent

({
    gridState,
    callback,
    column,
    index: number, // columnIndex
    last: boolean, // is the last column
    ghost: boolean // is column moving ghost
}) => nodes

rowComponent

({
    gridState,
    columns, // columns with width
    callback,
    datum, // row data
    index: number // row index
}) => nodes

reducer

Coming soon...

selectGridData

Coming soon...

withScrollProps

Coming soon...

License

MIT © Bogdan Chadkin