Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/phil-r/react-native-grid-component

:black_square_button: React native grid component
https://github.com/phil-r/react-native-grid-component

android grid grid-component ios react react-native

Last synced: 26 days ago
JSON representation

:black_square_button: React native grid component

Lists

README 

        
# :black_square_button: react-native-grid-component



[![NPM version](http://img.shields.io/npm/v/react-native-grid-component.svg?style=flat)](https://www.npmjs.com/package/react-native-grid-component)

[![Build Status](https://travis-ci.org/phil-r/react-native-grid-component.svg?branch=master)](https://travis-ci.org/phil-r/react-native-grid-component)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)



Easy to use grid component for your [react-native](https://github.com/facebook/react-native/) project. Supports iOS and Android.



Based on [react-native framework](https://github.com/facebook/react-native/) by Facebook.



## Installation



```

npm install react-native-grid-component

```



or



```

yarn add react-native-grid-component

```



## Examples



- [Simple](https://snack.expo.io/@phil/react-native-grid-component-example)

- [Sections](https://snack.expo.io/@phil/grid-with-sections-example)



## Demo



![android low](https://cloud.githubusercontent.com/assets/577316/18456263/d6b977e2-794f-11e6-878f-5737355111ac.gif) ![ios low](https://cloud.githubusercontent.com/assets/577316/18456262/d6b7a39a-794f-11e6-8587-06757dc42e14.gif)



## Usage



```js

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) => (

    

  );



  _renderPlaceholder = i => ;



  render() {

    return (

      

    );

  }

}



const styles = StyleSheet.create({

  item: {

    flex: 1,

    height: 160,

    margin: 1

  },

  list: {

    flex: 1

  }

});

```



[Full interactive example](https://snack.expo.io/@phil/react-native-grid-component-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 |

| `numColumns` _optional_        | number                                         | number of elements per one row                                                                              |

| `keyExtractor` _optional_      | func `(item: object, index: number) => string` | [see docs](https://facebook.github.io/react-native/docs/flatlist#keyextractor)                              |

| `sections` _optional_          | bool                                           | switches internal implementation to [SectionList](https://facebook.github.io/react-native/docs/sectionlist) |



Also see [FlatList](https://facebook.github.io/react-native/docs/flatlist#props) props or [SectionList](https://facebook.github.io/react-native/docs/sectionlist#props) props(if you set `sections` to true)



## See also



- [React Native Looped Carousel](https://github.com/appintheair/react-native-looped-carousel)

- [React Native Buyscreen](https://github.com/appintheair/react-native-buyscreen)



## ISC License (ISC)



Copyright (c) 2016-2019, Phil Rukin >



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.