griddle-position-plugin

0.0.33 • Public • Published

Griddle Position Plugin (BETA)

The position plugin allows you to add infinite scrolling and other position-specific functionality to the grid.

Install the plugin by running npm install griddle-position-plugin and add it to plugins property on Griddle with an optional config.

import PositionPlugin from 'griddle-position-plugin';
...
const optionalConfig = {...};
<Griddle ... plugins={[PositionPlugin(optionalConfig)]}

Configuration

Optional configuration values (and their defaults)

import PositionPlugin from 'griddle-position-plugin';
...
const settings = {
  // The height of the table
  tableHeight: 500,
  // The width of the table
  tableWidth: null,
  // The minimum row height
  rowHeight: 30,
  // The minimum column width
  defaultColumnWidth: null,
  // Whether or not the header should be fixed
  fixedHeader: true,
  // Disable pointer events while scrolling to improve performance
  disablePointerEvents: false
};
...
<Griddle data={data} plugins={[PositionPlugin(settings)]}/>

Planned Features

  1. Infinite column scrolling
  2. Column resizing
  3. Locked columns

Readme

Keywords

none

Package Sidebar

Install

npm i griddle-position-plugin

Weekly Downloads

2

Version

0.0.33

License

MIT

Last publish

Collaborators

  • joellanciaux
  • ryanlanciaux