Create cascading layout grids like Pinterest with the power of CSS Grid Layout.
$ npm i brique --save
import{Brique}from'./node_modules/brique/lib';constrefGrid=document.getElementById('grid');newBrique(refGrid);HTML script tag requires the type="module" attribute.
<scripttype="module" src="scripts/main.js"></script>Create the grid in the JavaScript file (scripts/main.js) and import the esm version of the library (index.esm.js).
import{Brique}from'./node_modules/brique/lib/index.esm.js';constrefGrid=document.getElementById('grid');newBrique(refGrid);<divid="grid"><div><h2>Box 1</h2><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p></div><div><h2>Box 2</h2><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut laboret.</p></div><div><h2>Box 3</h2></div><div><h2>Box 4</h2><p>Lorem ipsum dolor sit amet.</p></div><div><h2>Box 5</h2><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor.</p></div></div>3 parameters can be passed to the Brique class.
newBrique(gridElement,options,observeGridResize);Target HTML element which is the container for grid items.
| Property | Type | Required | Description |
|---|---|---|---|
| columns | number | true | Number of columns |
| columnGap | string | false | Spacing between columns |
| rowGap | string | false | Spacing between row |
constrefGrid=document.getElementById('grid');constoptions={columns: 4,rowGap: '24px',columnGap: '16px',};newBrique(refGrid,options);The default value for this parameter is true.
If the value is true, the grid items will be updated when the viewport is resized.
If the value is false, the grid will never be updated when the viewport is resized.
Static property which returns the options defined by default in the Brique class.
Brique.DEFAULT_OPTIONS;Reference array of HTML elements of all grid items.
Update the rendering of the entire grid on demand.
briqueGrid.update();Update the rendering of the grid items on demand.
briqueGrid.updateItems();Update the dimension of grid items when the grid element is resized.
constrefGrid=document.getElementById('grid');constbriqueGrid=newBrique(refGrid);briqueGrid.updateOnResize();Stop update the dimension of grid items when the grid element is resized.
briqueGrid.stopUpdateOnResize();Return current options object.
briqueGrid.getOptions();// output: { columns: 3, rowGap: '32px', columnGap: '32px'}Change all properties of options object.
briqueGrid.setOptions({columns: 5});Updates only changed properties.
briqueGrid.updateOptions({columns: 5});Can be used to create a responsive grid.
Removes all events listened to on the HTML elements handled by the Brique class.
The destroy() method must be called when the grid is removed from HTML.
Update options object on media queries change.
constrefGrid=document.getElementById('grid');constmediaQueryMobile=window.matchMedia('(max-width: 767px)');constgetColumnsNumber=()=>mediaQueryMobile.matches ? 2 : 3;constbriqueGrid=newBrique(refGrid,{columns: getColumnsNumber(),columnGap: '32px',rowGap: '32px',});mediaQueryMobile.addEventListener('change',()=>{briqueGrid.updateOptions({columns: getColumnsNumber(),});});