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
and they will be handled as explained in react-virtualized's [docs] (https://github.com/bvaughn/react-virtualized/blob/main/docs/Table.md#prop-types)
import React from 'react';
import { BpkDataTable, BpkDataTableColumn } from 'bpk-component-datatable';
import _sortBy from 'lodash/sortBy';
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 = ({ sortBy, sortDirection }) => {
if (sortBy === 'seat') {
complexRows = _sortBy(complexRows, [
row => row.seat.office,
row => row.seat.desk,
]);
} else {
complexRows = _sortBy(complexRows, sortBy);
}
if (sortDirection === 'DESC') {
complexRows.reverse();
}
sortByValue = sortBy;
sortDirectionValue = sortDirection;
};
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>
);
Supports all properties defined in Table
(from react-virtualized
),
in addition to the following:
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 |
defaultColumnSortIndex | number | false | 0 |
sort | func | false | null |
sortBy | string | false | null |
sortDirection | oneOf('ASC', 'DESC') | false | null |
Supports all properties defined in Column
(from react-virtualized
)
FAQs
Backpack datatable component.
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.