Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
bpk-component-datatable
Advanced tools
Backpack datatable component.
npm install bpk-component-datatable --save-dev
import React from 'react';
import { BpkDataTable, BpkDataTableColumn } from 'bpk-component-datatable';
const rows = [
{ name: 'Jose', description: 'Software Engineer' },
{ name: 'Rolf', description: 'Manager' }
]
const onRowClick = row => alert(JSON.stringify(row));
export default () => (
<BpkDataTable rows={rows} height={200} onRowClick={onRowClick}>
<BpkDataTableColumn
label={'Name'}
dataKey={'name'}
width={100}
/>
<BpkDataTableColumn
label={'Description'}
dataKey={'description'}
width={100}
flexGrow={1}
/>
</BpkDataTable>
);
By default BpkDataTable
sorts the column using the value of dataKey
. For use cases where the data might more complex and requires custom sorting you can pass a sort
function along with sortBy
and sortDirection
.
import React from 'react';
import { BpkDataTable, BpkDataTableColumn } from 'bpk-component-datatable';
const complexRows = [
{
name: 'Jose',
description: 'Software Engineer',
seat: { office: 'London', desk: 10 },
},
{
name: 'Rolf',
description: 'Manager',
seat: { office: 'Barcelona', desk: 12 },
},
{
name: 'John',
description: 'Software Engineer',
seat: { office: 'Barcelona', desk: 15 },
},
];
let sortByValue = 'seat';
let sortDirectionValue = 'DESC';
const sortFunction = (rowA, rowB, id, desc) => {
const deskA = rowA.values.seat.desk;
const deskB = rowB.values.seat.desk;
if (deskA === deskB) {
return 0;
} else {
return deskA > deskB ? 1 : -1;
}
}
export default () => (
<BpkDataTable
rows={complexRows}
height={200}
sort={sortFunction}
sortBy={sortByValue}
sortDirection={sortDirectionValue}
>
<BpkDataTableColumn
label="Name"
dataKey="name"
width={100}
/>
<BpkDataTableColumn
label="Description"
dataKey="description"
width={100}
/>
<BpkDataTableColumn
label="Seat"
dataKey="seat"
width={100}
flexGrow={1}
cellRenderer={({ cellData }) => (
<React.Fragment>
{cellData.office} - {cellData.desk}
</React.Fragment>
)}
/>
</BpkDataTable>
);
Property | PropType | Required | Default Value |
---|---|---|---|
rows | arrayOf(Object) | true | - |
children | arrayOf(BpkDataTableColumn) | true | - |
height | number | true | - |
width | number | false | full width of parent |
headerHeight | number | false | 60 |
rowHeight | number | false | 60 |
rowStyle | object | false | {} |
onRowClick | func | false | null |
className | string | false | null |
defaultColumnSortIndex | number | false | 0 |
sort | func | false | null |
sortBy | string | false | null |
sortDirection | oneOf('ASC', 'DESC') | false | 'ASC' |
Property | PropType | Required | Default Value |
---|---|---|---|
dataKey | string | true | - |
width | number | true | - |
flexGrow | number | false | 0 |
label | string | false | null |
headerRenderer | func | false | null |
headerClassName | string | false | null |
headerStyle | object | false | {} |
cellRenderer | func | false | null |
cellDataGetter | func | false | null |
disableSort | bool | false | false |
defaultSortDirection | oneOf('ASC', 'DESC') | false | 'ASC' |
className | string | false | null |
For custom sorting, pass a sort
function.
Use sortBy
to specify which column the custom sorting will be applied to.
Use sortDirection
to set the direction of sorting. By default, it will be ascending.
The data will be sorted by default based on this column.
To handle more complex header data that needs any custom processing, pass a function or component to headerRenderer
prop. This will only be formatting the header value - all styling will be handled by the component.
It should implement the following signature:
function ({
dataKey: string, disableSort: boolean, label: string
}): element
To handle more complex cell data that needs any custom processing, pass a function or component to cellDataGetter
prop. This will only be formatting the cell value - all styling will be handled by the component.
It should implement the following signature:
function ({
dataKey: string,
rowData: any
}): any
To handle more complex cell data that needs any custom processing, pass a function or component to cellRenderer
prop. This will only be formatting the cell value - all styling will be handled by the component. To maintain backward compatibility, both cellRenderer
and cellDataGetter
will be supported, however, they are interchangeable as they both can only format the cell value.
It should implement the following signature:
function ({
cellData: any,
columnIndex: number,
dataKey: string,
rowData: any,
rowIndex: any,
}): node
FAQs
Backpack datatable component.
The npm package bpk-component-datatable receives a total of 31 weekly downloads. As such, bpk-component-datatable popularity was classified as not popular.
We found that bpk-component-datatable demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.