Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

minimasonry

1.1.5 • Public • Published

MiniMasonry.js

Minimalist dependancy free Masonry layout library

MiniMasonry is a lightweight (1kb Gzipped) dependancy free Masonry layout. It will compute elements position in Javascript and update their positions using css's transform attribute. This means positioning does not trigger browser layout and use the device's GPU. This also allow css animation during element positionning.

MiniMasonry is responsive, you give it a target width and it will adjust columns number and elements width. MiniMasonry will increase element width (until another column can fit in the layout) but will never reduce the target width.

Installation

You can install MiniMasonry by cloning the repository, downloading the build type (minimasonry.min.js / minimasonry.esm.js) or using npm :

npm install minimasonry

Then, include the minified version of MiniMasonry.js on your website :

<script src="node_modules/minimasonry/build/minimasonry.min.js"></script>

or use it via ESM :

import MiniMasonry from "minimasonry";

Usage

To use MiniMasonry you should have a container relatively positioned with your elements as children. Those children elements must be absolutely positioned.

Then you can initialise MiniMasonry :

var masonry = new MiniMasonry({
    container: '.masonry_transition'
});

Parameters

Here is the list of available parameters :

Name Default value Description
baseWidth (int) 255 Target width of elements.
container (string) Null Container selector. Required
gutter (int) 10 Width / height of gutter between elements. Use gutterX / gutterY to set different values.
gutterX (int) null Width of gutter between elements. Need gutterY to works, fallback to gutter.
gutterY (int) null Height of gutter between elements. Need gutterX to works, fallback to gutter.
minify (boolean) true Whether or not MiniMasonry place elements on shortest column or keep exact order of list.
surroundingGutter (boolean) true Set left gutter on first columns and right gutter on last.
ultimateGutter (int) 5 Gutter applied when only 1 column can be displayed.

API

Here is the list of available APIs :

Name Description
layout() If list has changed, trigger a relayout of the masonry

MiniMasonry will add a "resize" event listener on the window to redraw the masonry on window resize. This listener is throttled to 66ms (15fps).

Example

See website

License

MIT

Made by Spope

Install

npm i minimasonry

DownloadsWeekly Downloads

78

Version

1.1.5

License

MIT

Unpacked Size

24.6 kB

Total Files

10

Last publish

Collaborators

  • avatar