🔲 react-native-grid-component

Easy to use grid component for your react-native project. Supports iOS and Android.

Based on react-native framework by Facebook.

Installation

npm install react-native-grid-component --save

yarn add react-native-grid-component

Examples

Demo

Usage

import React, { Component } from 'react';
import { StyleSheet, View } from 'react-native';

import Grid from 'react-native-grid-component';

class Simple extends Component {
  _renderItem = (data, i) => (
    <View style={[{ backgroundColor: data }, styles.item]} key={i} />
  );

  _renderPlaceholder = i => <View style={styles.item} key={i} />;

  render() {
    return (
      <Grid
        style={styles.list}
        renderItem={this._renderItem}
        renderPlaceholder={this._renderPlaceholder}
        data={['black', 'white', 'red', 'green', 'blue']}
        itemsPerRow={2}
      />
    );
  }
}

const styles = StyleSheet.create({
  item: {
    flex: 1,
    height: 160,
    margin: 1
  },
  list: {
    flex: 1
  }
});

Full interactive example

Props

Name	propType	description
`data` required	Array	Array that will be used to render items
`renderItem` required	func `(data: any, i: number) => React$Element`	function that accepts data and returns React Element that will be rendered for each `data` item
`renderPlaceholder` optional	func `(i: number) => React$Element`	function that returns placeholder React Elements that ere rendered to fill the space at the end of the grid
`renderFooter` optional	func `() => React$Element`	underlying ListView renderFooter prop
`refreshControl` optional	func `() => React$Element`	underlying ListView refreshControl prop
`itemsPerRow` optional	number	number of elements per one row
`onEndReached` optional	func	function that is called when the end of the grid reached (can be used to add new elements, like in example)
`itemHasChanged` optional	func `(data1: any, data2: any) => boolean`	function that is used in `rowHasChanged` function in `ListView.DataSource` to determine whether the row was updated. IMPORTANT: It's possible to get `null` as one or both of arguments, so you'll want to check for that ( e.g. `(d1, d2) => d1 && d2 ? d1.data !== d2.data : true`)

TODO

ISC License (ISC)

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

ejferg / react-native-grid-component Goto Github PK