react-absolute-grid

React Absolute Grid

An absolute layout grid with animations, filtering, zooming, and drag and drop support. Use your own component as the grid item. See the Demo.

Usage:

Install with npm install react-absolute-grid

import React from 'react';
import AbsoluteGrid from './lib/AbsoluteGrid.jsx';

 var sampleItems = [
  {key: 1, name: 'Test', sort: 0, filtered: 0},
  {key: 2, name: 'Test 1', sort: 1, filtered: 0},
];
 
React.render(<AbsoluteGrid items={sampleItems} />, document.getElementById('Container'));

Options (Properties)

• items | default: [] | The array of items in the grid
• displayObject | default: <GridItem/> | The React component used to display items
• keyProp | default: 'key' | The property to be used as a key
• filterProp | default: 'filtered' | The property to be used for filtering, if the filtered value is true, the item won't be displayed. It's important to not remove items from the array because that will cause React to remove the DOM, for performance we would rather hide it then remove it.
• sortProp | default: 'sort' | The property to sort on
• itemWidth | default: 128 | The width of an item
• itemHeight | default: 128 | The height of an item
• verticalMargin | default: -1 | How much space between rows, -1 means the same as columns margin which is dynamically calculated based on width
• responsive | default: false | If the container has a dynamic width, set this to true to update when the browser resizes
• animation | default: 'transform 300ms ease' | The CSS animation to use on elements. Pass a blank string or false for no animation.
• zoom | default: 1 | Zooms the contents of the grid, 1 = 100%
• onMove | default: fn(from, to) | This function is called when an item is dragged over another item. It is your responsibility to update the sort of all items when this happens.

Creating a DisplayObject component

Display objects will receive item, style, and index as properties. You must apply the style to the root element in your render. Here's the simplest possible example with drag and drop support:

'use strict';

import React from 'react';
import BaseDisplayObject from '../lib/BaseDisplayObject.jsx';

export default class SampleDisplay extends BaseDisplayObject{

  constructor() {
    super();
    //Only required if you want drag/drop support
    this.onDrag = super.onDrag.bind(this);
    this.onMouseOver = super.onMouseOver.bind(this);
  }

  render() {
    //IMPORTANT: Without the style, nothing happens :(
    var itemStyle = super.getStyle.call(this);
    return <div onMouseDown={this.onDrag} onMouseOver={this.onMouseOver} style={itemStyle}></div>;
  }
}

Once you've created a display object, use it like this:

 var dispalyObject = (<SampleDisplay />);
 var grid = (<AbsoluteGrid ... displayObject={displayObject}/>);

What Makes AbsoluteGrid Unique?

The idea behind AbsoluteGrid is high performance. This is achieved by using Translate3d to position each item in the layout. Items are never removed from the DOM, instead they are hidden. For best performance you should avoid re-arranging or removing items which you pass into AbsoluteGrid, instead you can use the filtered and sort properties to hide or sort an item. Those properties are customizable using the keyProp and filterProp properties.

ToDo:

• Full Mobile Supprt
• Improve Drag & Drop browser support and reliability

Browser Compatibility

This component should work in all browsers that support CSS3 3D Transforms. If you need IE9 support you can modify it to use transform rather than transform3d. Pull requests welcome!

Drag and Drop only works on IE11+ due to lack of pointer events, although there is a workaround coming soon.