Overview

A set of tools to build extensible layouts using CSS grid specification.

React-Grits attempts to reduce the complexity in sharing, debugging, and previewing standardized layouts by providing a thin layer on top of CSS grid.

Installation

npm install react-grits

or through yarn

yarn add react-grits

API

Helpers

• createGridItemsForChildren
  • Arguments:
    • children: React node or array of nodes
    • WrapperComponent: Optional component to wrap each item. Defaults to GridItem.
• createGridWithProps
  • Arguments:
    • props: A set of configuration properties to provide to the grid component:
      • templateAreas: a nested array of named template areas
      • templateColumns: an string list of column sizes
      • templateRows: an string list of row sizes
      • columnGap: a string to define the gap size between columns
      • rowGap: a string to define the gap size between rows
    • components: A set of components which can be used to override rendering
      • GridComponent: a component which defines the grid layout
      • ItemComponent: a component which will wrap all children
      • See this section for more information
• debug: a higher-order component which wraps a layout created with createGridWithProps and enables debugging by passing a debug=true prop
• validate: a function which creates a higher-order component that will validate the number of children passed to a layout

Components

• Grid
• GridItem

Pre-defined templates

• SplitHalf
• AsideLeft
• AsideRight
• Thirds

Using a predefined layout

Each layout supports named grid-areas, if you forget to include a grid area name thats ok, we will automatically populate it for you.

 import {AsideLeft} from 'react-grits';

// without a grid area defined
const MyPage = () => (
  <AsideLeft>
    <AwesomeSidebar/>
    <MainContent/>
  </AsideLeft>
)

// without defined grid areas
const MyPage = () => (
  <AsideLeft>
    <AwesomeSidebar gridArea="view2"/>
    <MainContent gridArea="view1" />
  </AsideLeft>
)

Defining a custom layout

import { validate, createGridWithProps, debug } from 'react-grits';

// start by defining your template areas
const templateAreas = [
    ["a", "b"],
    ["c", "c"]
];

// want to define split 50/50?
const templateColumns = "50% 50%";

// add validation rules, specify how many children are required
const validator = validate({minChildren: 3});

// Create our CSS grid
const Component = createGridWithProps({ templateAreas, templateColumns, columnGap });

// Enhance our component with debugging and validation
export default debug(validator(Component))

Pre-Defined Application Layouts

These are a couple of included templates that can be used with any framework

Aside Left

Provides a left sidebar and a main region seperated a column gap. This is a commonly seen pattern with dashboard sites and nav+data views.

Code Example

import {AsideLeft} from 'react-grits';

<AsideLeft>
   <Side gridArea="view1" />
   <Master gridArea="view2" />
</AsideLeft>

Aside Right

Provides a right sidebar and a main region with a gap between columns.

Code Example

import {AsideRight} from 'react-grits';

<AsideRight>
   <Master gridArea="view1" />
   <Side gridArea="view2" />
</AsideRight>

Split Half Template

Splits each view equally into two columns seperated by a column gap.

Code Example

import {SplitHalf} from 'react-grits';

<SplitHalf>
   <FooView gridArea="view1" />
   <BarView gridArea="view2" />
</SplitHalf>

Thirds

Provides a three column approach where each column has an equal width and an equal gap.

Code Example

import {Thirds} from 'react-grits';

<Thirds>
   <ACol gridArea="view1" />
   <BCol gridArea="view2" />
   <CCol gridArea="view3" />
</Thirds>

Customizing Layout Components

The library ships with underlying components which handle defining the CSS grid layout using reasonable default behaviors.

If you want to customize the styles of either the containing Grid component, or the Item components which wrap each child within a layout, you may pass overriding components to the createGridWithProps function when you define your layout.

createGridWithProps({ GridComponent: MyCustomGrid, ItemComponent: MyCustomItem });

Each component is passed certain props which you can use to define your styling. The library exports the default components as Grid and GridItem. They are created using styled-components, and can be extended or wrapped if you want to build on top of existing styles.

Grid

The Grid component receives the provided templateColumns, templateRows, columnGap, rowGap props. It also receives a parsed version of templateAreas which is ready to be used as a CSS property value. Finally, any further props which are passed through by the user are supplied to Grid, including style and other common props.

GridItem

The item component will automatically be used to wrap all children in a layout. It receives one prop, gridArea, which is supplied by the user to the wrapped child. Use this prop as a CSS value to put the component into its proper grid space. You may also use it to define some custom logic if you wish.

License

Copyright 2017 Jonathan Fontanez

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.