Home

Awesome

<p align="middle" ><img src="https://naver.github.io/egjs-grid/images/logo.png" /></p> <h2 align="middle">Grid</h2> <p align="middle"> <a href="https://www.npmjs.com/package/@egjs/grid" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/grid.svg?style=flat-square&color=007acc&label=version" alt="npm version" /></a>&nbsp; <img src="https://img.shields.io/badge/language-typescript-blue.svg?style=flat-square" />&nbsp; <a href="https://github.com/naver/egjs-grid/actions" target="_blank"><img alt="Github actions" src="https://img.shields.io/github/actions/workflow/status/naver/egjs-grid/run-e2e.yml?branch=main&style=flat-square" /></a>&nbsp; <a href="https://coveralls.io/github/naver/egjs-grid?branch=main&style=flat-square" target="_blank"><img alt="Coveralls github" src="https://img.shields.io/coveralls/github/naver/egjs-grid.svg?style=flat-square&label=%E2%9C%85%20coverage" /></a>&nbsp; <a href="https://github.com/naver/egjs-grid/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/static/v1?style=flat-square&label=license&message=MIT&color=08CE5D" /></a>&nbsp; <a href="https://github.com/naver/egjs-grid/tree/main/packages/react-grid" target="_blank"><img alt="React" src="https://img.shields.io/static/v1.svg?label=&message=React&style=flat-square&color=61daeb" /></a>&nbsp; <a href="https://github.com/naver/egjs-grid/tree/main/packages/ngx-grid" target="_blank"><img alt="Angular" src="https://img.shields.io/static/v1.svg?label=&message=Angular&style=flat-square&color=C82B38" /></a>&nbsp; <a href="https://github.com/naver/egjs-grid/tree/main/packages/vue-grid" target="_blank"><img alt="Vue" src="https://img.shields.io/static/v1.svg?label=&message=Vue&style=flat-square&color=3fb984" /></a>&nbsp; <a href="https://github.com/naver/egjs-grid/tree/main/packages/svelte-grid" target="_blank"><img alt="Svelte" src="https://img.shields.io/static/v1.svg?label=&message=Svelte&style=flat-square&color=C82B38" /></a> </p> <p align="middle">A component that can arrange items according to the type of grids.</p> <p align="middle"> <a href="https://naver.github.io/egjs-grid" target="_blank"><strong>Demo</strong></a> /&nbsp; <a href="https://naver.github.io/egjs-grid/release/latest/doc/" target="_blank"><strong>API</strong></a> </p>

Grids

<img src="https://naver.github.io/egjs-grid/images/MasonryGrid.png" /><img src="https://naver.github.io/egjs-grid/images/JustifiedGrid.png" /><img src="https://naver.github.io/egjs-grid/images/FrameGrid.png" /><img src="https://naver.github.io/egjs-grid/images/PackingGrid.png" />
MasonryGridJustifiedGridFrameGridPackingGrid

Documents

Download and Installation

Download dist files from repo directly or install it via npm.

$ npm install @egjs/grid
<script src="//naver.github.io/egjs-grid/release/latest/dist/grid.min.js"></script>

How to use

import { MasonryGrid, JustifiedGrid, FrameGrid, PackingGrid } from "@egjs/grid";


// Grid.MasonryGrid
const grid = new MasonryGrid(container, {
  gap: 5,
});

grid.renderItems();

Use Faster & Lazy Rendering

<img src="..." />
<img src="..." />
<img src="..." loading="lazy" />
<img data-grid-lazy="true" />
<div data-grid-width="100" data-grid-height="100">
   <img src="..." />
   <img src="..." />
   <img src="..." />
</div>
<div data-grid-skip="true">
   <img src="..." />
   <img src="..." />
   <img src="..." />
</div>

Detect resize of Container & Children

Grid calculates the size of container and children by window resizing event. However, even if the size of the window does not change, the size of the event container and children can change. Most of the first rendering issues are also like this.

In this case, I recommend ResizeObserver for you.

Provides useResizeObserver option to detect size change of container and observeChildren option to detect size change of children.

import { MasonryGrid, JustifiedGrid, FrameGrid, PackingGrid } from "@egjs/grid";


// Grid.MasonryGrid
const grid = new MasonryGrid(container, {
  gap: 5,
  useResizeObserver: true,
  observeChildren: true,
});

grid.renderItems();

Pre-guess size for performance or invisible items.

What if all items were the same size?

If you use the isEqualSize option, all items are considered to be the same size. Each resize only calculates the size of one item. Add data-grid-not-equal-size="true" attribute if there is an exceptional item whose size needs to be calculated while using isEqualSize.

<div class="item item1"></div>
<div class="item item1"></div>
<div class="item item1"></div>
<!--item2 is a different size than item1.-->
<div class="item item2" data-grid-not-equal-size="true"></div>

What if a size group exists?

isEqualSize assumes all items are equal. But if there are more than two size-groups, use data-grid-size-group.

<!--item1 has the same size.-->
<div class="item item1" data-grid-size-group="1"></div>
<div class="item item1" data-grid-size-group="1"></div>
<!--item2 has the same size.-->
<div class="item item2" data-grid-size-group="2"></div>
<div class="item item2" data-grid-size-group="2"></div>

What if all items don't change size?

If all items do not have a constant size, use the isConstantSize option. Resizing doesn't calculate the item's size. If you want to recalculate, use .updateItems(items, { useOrgResize: true }) method or .renderItems({ useOrgResize: true }) method.

Packages

PackageVersionDescription
@egjs/react-grid<a href="https://www.npmjs.com/package/@egjs/react-grid" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/react-grid.svg?style=flat-square&color=00d8ff&label=%F0%9F%94%96" alt="version" /></a>React port of @egjs/grid
@egjs/ngx-grid<a href="https://www.npmjs.com/package/@egjs/ngx-grid" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/ngx-grid.svg?style=flat-square&color=dd0031&label=%F0%9F%94%96" alt="version" /></a>Angular port of @egjs/grid
@egjs/vue-grid<a href="https://www.npmjs.com/package/@egjs/vue-grid" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/vue-grid.svg?style=flat-square&color=42b883&label=%F0%9F%94%96" alt="version" /></a>Vue.js port of @egjs/grid
@egjs/svelte-grid<a href="https://www.npmjs.com/package/@egjs/svelte-grid" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/svelte-grid.svg?style=flat-square&color=ff3d00&label=%F0%9F%94%96" alt="version" /></a>Svelte port of @egjs/grid

Supported Browsers

The following are the supported browsers.

Internet ExplorerChromeFirefoxSafariiOSAndroid
9+LatestLatestLatest7+4+(polyfill 2.2+)

How to start developing egjs-grid?

For anyone interested to develop egjs-grid, follow the instructions below.

Development Environment

1. Clone the repository

Clone the egjs-grid repository and install the dependency modules.

# Clone the repository.
$ git clone https://github.com/naver/egjs-grid.git

2. Install dependencies

# Install the dependency modules.
$ npm install

3. npm start

Run storybook for development.

Open http://localhost:6006 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

3. npm build

Use npm script to build Grid

$ npm run build

Two folders will be created after complete build is completed.

Linting

To keep the same code style, we adopted ESLint to maintain our code quality. The rules are modified version based on Airbnb JavaScript Style Guide. Setup your editor for check or run below command for linting.

$ npm run lint

Test

Once you created a branch and done with development, you must perform a test running with npm test command before your push the code to a remote repository.

$ npm run test

Running npm test command will start Mocha tests via Karma-runner.

Bug Report

If you find a bug, please report to us opening a new Issues on GitHub.

License

egjs-grid is released under the MIT license.

Copyright (c) 2021-present NAVER Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.