Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 3.07 KB

README.md

File metadata and controls

91 lines (63 loc) · 3.07 KB
Raw

rowGrid.js (no jQuery required)

rowGrid.js is a small, lightweight (~1kB gzipped) JavaScript plugin for placing images (or other items) in straight rows.

The grid is similar to grids on Google Image Search, Flickr, Shutterstock and Google+ images.

Features:

  • responsive
  • infinite scrolling
  • support for all modern browsers and IE >= 9

How does it work?

All items must have the same height but the width can be variable. RowGrid.js justifies the items in straight rows so that the width of the rows equals the width of the container/parent element. At first rowGrid.js adjusts the margin between the items. If this is not enough rowGrid.js scales down the items.

Usage

It is important that you either declare the width and height as attributes on the img tag or that you wait until the images are loaded before you start rowGrid.js.

HTML:

<div class="container">
  <div class="item">
    <img src="path/to/image" width="320" height="200" />
  </div>
  <div class="item">
    <img src="path/to/image" width="290" height="200" />
  </div>
  ...
</div>

JS:

var container = document.getElementsByClassName('container')[0];
rowGrid.init(container, {itemSelector: ".item", minMargin: 10, maxMargin: 25, firstItemClass: "first-item", lastRowClass: 'last-row', resize: true});

Relayout

You can relayout the complete grid with rowGrid.layout();. If you appended items to the grid you can call rowGrid.append(); to arrange just the new items in the grid. This is useful if you want to implement endless scrolling.

Parameters

The method rowGrid.init() expects two parameters. The first one has to be a DOM element and the second one a JavaScript object with options:

itemSelector (required)

  • value: string (CSS Selector)

The selector have to reference to all grid items.

minMargin (required)

  • value: number or null

This is the minimal horizontal margin between the items. The margin is only between the items not between the first/last item and the container.

maxMargin (required)

  • value: number or null

This is the maximal horizontal margin between the items.

resize

  • value: boolean
  • default value: true

If resize is set to true the layout updates on resize events. This is useful for responsive websites.

minWidth

  • value: number
  • default value: 0

mode

  • value: string (CSS Selector)

The grid has two mode either grid the default or list mode that allow only one image by row.

RowGrid.js only applies its grid system if the width of the window is greater than or equals to the specified value.

The default value is 0. This means the items always get arranged by rowGrid.js.

Also check out the demo in the example directory to see this option in action.

lastRowClass

  • value: string
  • default value: last-row

The first item in the last row gets this class.

firstItemClass

  • value: string
  • default value: undefined

The first item in every row gets this class.