0.2.3 • Published 7 years ago

react-masonry-layout-jd v0.2.3

Weekly downloads
-
License
GPL-3.0
Repository
-
Last release
7 years ago

React Masonry Layout

Masonry Layout base on bricks.js with React. It comes with infinite scroll feature too !

Install

$ npm install react-masonry-layout

Usage

import React from 'react'
import MasonryLayout from 'react-masonry-layout'

class Masonry extends React.Component {

  static defaultProps = {
    maxCount: 5,
    perPage: 20
  }

  state = {
    count: 0,
    isLoading: false,
    items: Array(20).fill()
  }


  getItems() {
    if (this.state.count >= this.props.maxCount) return
    this.setState(Object.assign(
      {},
      this.state,
      { isLoading: true }
    ), () => {
      setTimeout(() => {
        this.setState(Object.assign(
          {},
          this.state,
          {
            isLoading: false,
            items: this.state.items.concat(
              Array(perPage).fill()
            )
          }
        ))
      })
    })
  }

  render() {
    <MasonryLayout
      id="items"
      infiniteScroll={::this.getItems}
      infiniteScrollLoading={this.state.isLoading} >

      {this.state.items.map((v, i) => <div
        key={i}
        style={{
          width: '236px',
          height: `${i % 2 === 0 ? 4 * 50 : 50 }px`,
          display: 'block',
          background: 'rgba(0,0,0,0.7)'
        }}
        />)}

    </MasonryLayout>
  }
}

API

propstypedefaultdescription
idstringnullrequired
packedstringdata-packedoptional, see Bricks.js
sizesarray[ { columns: 2, gutter: 20 }, { mq: '768px', columns: 3, gutter: 20 }, { mq: '1024px', columns: 6, gutter: 20 } ]optional, see Bricks.js
classNamestring''optional, the css classname you want to use
styleobject{}optional, the inline style you want to use
infiniteScrollfunction() => {}optional, the function that used to load more data
infiniteScrollContainerstringwindowoptional, by default, it will listen to the window's scroll event. If you want to listen to some div's scroll event, please set the container's id to it
infiniteScrollDisabledbooleanfalseoptional, if you don't want to trigger infiniteScroll, set it to false
infiniteScrollLoadingbooleanfalseoptional, when you are loading data, please set it to true, then the infiniteScroll will not trigger
infiniteScrollEndbooleanfalseoptional, when no more data, please set it to true, then the infiniteScroll will not trigger
infiniteScrollDistancenumber200optional, the distance to trigger infiniteScroll
infiniteScrollSpinnerelement<div>this is a loader</div>optional, override it if you want to custom the loading spinner
infiniteScrollEndIndicatorelement<div>no more data</div>optional, override it if you want to custom the no more data indicator

License

MIT.