Infinite Grid

A module used to arrange card elements including content infinitely on a gr...

naver/egjs-infinitegrid naver.github.io/egjs-infinitegrid/@egjs/infinitegrid

README

@egjs/infinitegrid

Demo / Documentation / Other components

A module used to arrange elements including content infinitely according to grid type. With this module, you can implement various grids composed of different card elements whose sizes vary. It guarantees performance by maintaining the number of DOMs the module is handling under any circumstance
📱💻🖥

Supported Frameworks

✨ Features

- Use it in a framework you like.

- We supports all major JS frameworks like React, Vue, Angular

- Restore state like position and active slide with persist

- Supports both Desktop & Mobile

- Support Dynamic Options

- Rich API

📖 Articles

InfiniteGrid 4 Release!!

⚙️ Installation

npm

``` sh
$ npm install --save @egjs/infinitegrid
```

CDN

- jsDelivr: https://cdn.jsdelivr.net/npm/@egjs/infinitegrid/dist/

- unpkg: https://unpkg.com/@egjs/infinitegrid/dist/

- cdnjs: https://cdnjs.com/libraries/egjs-infinitegrid

🏃 Quick Start

HTML

``` html
<div class="container"></div>
```

ES Modules

```ts
import { MasonryInfiniteGrid } from "@egjs/infinitegrid";
const ig = new MasonryInfiniteGrid(".container", { gap: 5 });
```

With CDN

``` html
<script src="https://unpkg.com/@egjs/infinitegrid/dist/infinitegrid.min.js"></script>
```

``` js
var ig = new InfiniteGrid.MasonryInfiniteGrid(".container", { gap: 5 });
```

``` js
import { MasonryInfiniteGrid } from "@egjs/infinitegrid";
function getItems(nextGroupKey, count) {
const nextItems = [];
for (let i = 0; i < count; ++i) {
const num = nextGroupKey * count + i;
nextItems.push(`<div class="item"></div>`);
}
return nextItems;
}
const ig = new MasonryInfiniteGrid(".container", {
gap: 5,
});
ig.on("requestAppend", (e) => {
const nextGroupKey = (+e.groupKey || 0) + 1;
ig.append(getItems(nextGroupKey, 10), nextGroupKey);
});
ig.renderItems();
```

Use Faster & Lazy Rendering

When the loading="lazy" or data-grid-lazy="true"(external lazy loading) attribute is used, Rendering of the items occurs immediately. When items are loaded, they are rendered sequentially.

``` html
<img src="..." />
<img src="..." />
<img src="..." loading="lazy" />
<img data-grid-lazy="true" />
```

If you use data-grid-width and data-grid-height attributes, the size of self, child image, and video elements is automatically adjusted until loading is complete.

``` html
<div data-grid-width="100" data-grid-height="100">
<img src="..." />
<img src="..." />
<img src="..." />
</div>
```

If you use data-grid-skip="true" attribute, you can omit it even if there are images in itself and child image, and video elements.

``` html
<div data-grid-skip="true">
<img src="..." />
<img src="..." />
<img src="..." />
</div>
```

Detect resize of Container & Children

InfiniteGrid 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.

``` js
import { MasonryInfiniteGrid, JustifiedInfiniteGrid, FrameInfiniteGrid, PackingInfiniteGrid } from "@egjs/infinitegrid";
// InfiniteGrid.MasonryInfiniteGrid
const grid = new MasonryInfiniteGrid(container, {
gap: 5,
useResizeObserver: true,
observeChildren: true,
});
grid.renderItems();
```

📦 Packages

|Package|Version|Description|

|:-----:|:-----:|:-----:|

|[**@egjs/infinitegrid**](https://github.com/naver/egjs-infinitegrid/blob/master/packages/infinitegrid/README.md)|

|Vanilla Module of InfiniteGrid||[**@egjs/ngx-infinitegrid**](https://github.com/naver/egjs-infinitegrid/blob/master/packages/ngx-infinitegrid/README.md)|

[Angular](https://angular.io/) port of @egjs/infinitegrid||[**@egjs/react-infinitegrid**](https://github.com/naver/egjs-infinitegrid/blob/master/packages/react-infinitegrid/README.md)|

[React](https://reactjs.org/) port of @egjs/infinitegrid||[**@egjs/vue-infinitegrid**](https://github.com/naver/egjs-infinitegrid/blob/master/packages/vue-infinitegrid/README.md)|

[Vue.js@2](https://vuejs.org/v2/guide/index.html) port of @egjs/infinitegrid||[**@egjs/vue3-infinitegrid**](https://github.com/naver/egjs-infinitegrid/blob/master/packages/vue3-infinitegrid/README.md)|

[Vue.js@3](https://v3.vuejs.org/) port of @egjs/infinitegrid||[**@egjs/svelte-infinitegrid**](https://github.com/naver/egjs-infinitegrid/blob/master/packages/svelte-infinitegrid/README.md)|