/react-component-grid

Primary LanguageJavaScriptApache License 2.0Apache-2.0

react-component-grid

React Flexbox Component Grid provides a simple, flexbox-based grid to be used for tabular data or other scenarios where you desire a header-ed or header-less grid.

React - Because componentized, one-way data flowish frontend development

Flexbox - For a responsive, aligned grid that's easy to customize via parameters while also remaining unobtrusive

Component - Because just taking text or numbers is so un-Reactish, we expect to represent every cell with a component

Grid - Or datagrid. Or matrix. In this case, a framework of rectangular cells

Stories in Ready

Build Status

npm version

Installation

$ npm i -S react-flexbox-component-grid

Getting Started

3 props are expected and required to use the component grid:

data: An array containing the row-wise data you wish to display. Each data item MUST contain a unique id property (either string or number).

const data = [
        {
            id: 1,
            objectToSendToComponentAsProps: { quantity: 1 },
            
        },
        {
            id: 2,
            objectToSendToComponentAsProps: { quantity: 3 },
            
        },
    ];

columns: An array representation of the columns you wish to display

const columns = [
        {
            data: 'objectToSendToComponentAsProps',
            component: reactComponentToRenderInThisColumn,
        }
    ];

component: at least one component to render as a grid cell

const reactComponentToRenderInThisColumn = props => (
  <div>{props.quantity}</div>
)

Key Contributors: