Feature-Packed Grid Framework for React and ImmutableJS
❗️ Demo at gridiron.js.org
npm install -S gridiron gridiron-modules
For easiest usage across an application, setup a gridiron.js file in a modules folder with the following content:
/** Factory that imports all of the gridiron components and feeds them your apps version of its dependencies (React, ReactDOM, addons, etc.) */themeName: 'mellow'
All components should be wrapped in a pager component whether you want the data displayed in pages or not. The pager is responsible for taking data from redux and mapping it to the format that the grid and other components expect. Sorting, filtering, and partitioning of the data all occurs at the pager level. By filtering and sorting as early as possible in the rendering hierarchy, gridiron components are able to render fast and bypass unnecessary data.
||how many documents to show on a single page|
||an array of the column IDs that will be passed|
||how to break the data into documents and cells|
||allows early lifecycle filtering of columns|
||which columns to sort by|
||how to filter the data|
A complex full example:
Accordion documentation is coming soon!
Cards documentation is coming soon!
Graph documentation is coming soon!
To setup gridiron for use in development run the following steps at CLI:
npm i -g lerna@latestgit clone https://github.com/noderaider/gridironcd gridironlerna bootstraplerna run start
Then from your project:
npm link ../gridiron/packages/gridiron# start your project, gridiron should hot reload as you update its source code.
See gridiron's test project at gridiron-test
In active development, come back in a few days.