Socket
Socket
Sign inDemoInstall

bpk-component-datatable

Package Overview
Dependencies
247
Maintainers
7
Versions
395
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    bpk-component-datatable

Backpack datatable component.


Version published
Weekly downloads
334
increased by25.56%
Maintainers
7
Install size
37.5 MB
Created
Weekly downloads
 

Readme

Source

bpk-component-datatable

Backpack datatable component.

Installation

npm install bpk-component-datatable --save-dev

Usage

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>
);

Props

BpkDataTable

PropertyPropTypeRequiredDefault Value
rowsarrayOf(Object)true-
childrenarrayOf(BpkDataTableColumn)true-
heightnumbertrue-
widthnumberfalsefull width of parent
headerHeightnumberfalse60
rowHeightnumberfalse60
rowStyleobjectfalse{}
onRowClickfuncfalsenull
classNamestringfalsenull
defaultColumnSortIndexnumberfalse0
sortfuncfalsenull
sortBystringfalsenull
sortDirectiononeOf('ASC', 'DESC')false'ASC'

BpkDataTableColumn

PropertyPropTypeRequiredDefault Value
dataKeystringtrue-
widthnumbertrue-
flexGrownumberfalse0
labelstringfalsenull
headerRendererfuncfalsenull
headerClassNamestringfalsenull
headerStyleobjectfalse{}
cellRendererfuncfalsenull
cellDataGetterfuncfalsenull
disableSortboolfalsefalse
defaultSortDirectiononeOf('ASC', 'DESC')false'ASC'
classNamestringfalsenull

Prop Details

sort, sortBy, sortDirection

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.

defaultColumnSortIndex

The data will be sorted by default based on this column.

headerRenderer

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
cellDataGetter

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
cellRenderer

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

Last updated on 30 Sep 2022

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc