egjs-infinitegrid

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

Documents

• Get Started and Demos
• Playground with various framework demos
• InfiniteGrid Options
• API documentation
• Migrating from v2.0 to v3.0
• Articles
  • Introducing eg.InfiniteGrid, a new library for implementing a card layout [Korean]
  • Card-based design and eg.InfiniteGrid 3.0 [Korean]

Layouts

The InfiniteGrid can use various layouts.

• GridLayout: The GridLayout is a layout that stacks cards with the same width as a stack of bricks.
• JustifiedLayout: JustifiedLayout is a layout that the card is filled up on the basis of a line given a size.
• FrameLayout: FrameLayout is a layout that allows you to place cards in a given frame.
• SquareLayout: SquareLayout is a layout that places all cards like squares on a checkerboard, and important cards are n times larger.
• PackingLayout: The PackingLayout is a layout that shows the important cards bigger without sacrificing the weight of the cards.

Benchmark

eg.infiniteGrid benchmark: append item performance with masonry

Packages

Package	Version	Description
@egjs/ngx-infinitegrid		Angular port of @egjs/infinitegrid
@egjs/react-infinitegrid		React port of @egjs/infinitegrid
@egjs/vue-infinitegrid		Vue.js port of @egjs/infinitegrid
@egjs/svelte-infinitegrid		Svelte port of @egjs/infinitegrid

Download and Installation

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

Packaged version

Packaged version is not an official distribution. Is just to provide for ease use of 'egjs-infinitegrid'.

• Dependencies
  • @egjs/component
  • @egjs/list-differ
  • @egjs/imready
• latest version

• Specific version
  • https://naver.github.io/egjs-infinitegrid/release/[VERSION]/dist/[FILE_NAME]

Installation with npm

The following command shows how to install egjs-infinitegrid using npm.

$ npm install @egjs/infinitegrid

How to use

The following code shows how to import InfiniteGrid.

• See InfiniteGrid options
• See InfiniteGrid methods

import InfiniteGrid, {GridLayout, JustifiedLayout, ...} from "@egjs/infinitegrid";

// eg.InfiniteGrid
const ig = new InfiniteGrid(".container", {
  // options
  isOverflowScroll: true,
});

// GridLayout, JustifiedLayout, SquareLayout, FrameLayout, PackingLayout ...
ig.setLayout(GridLayout, {
  // layout options
  margin: 5,
});

// If items are already inserted in children, call layout method
ig.layout();

// If you want to add items from top(left) to bottom(right), call append method
ig.append(`<div class="item"></div>`);


// If you want to add items from bottom(right) to top(left), call prepend method
ig.prepend(`<div class="item"></div>`);

Events

See InfiniteGrid events

// If you want to add items infinitely to the bottom(right), use the append event.
ig.on("append", () => {
  ig.append(`<div class="item"></div>`);
});


// If you want to add items infinitely to the top(left), use the prepend event.
ig.on("prepend", () => {
  ig.prepend(`<div class="item"></div>`);
});

// If you want to know when items have been added, use the layoutComplete event.
ig.on("layoutCompete", e => {
  if (e.isLayout) {
    // Fired when items are relocated through the resize event or method
  } else {
    // Fired when items are added
  }
});

Supported Browsers

The following are the supported browsers.

• If you want to use in IE8, please use polyfill.

Dependency

egjs-infinitegrid has the dependencies for the following libraries:

How to start developing egjs-infinitegrid?

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

Development Environment

1. Clone the repository

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

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

2. Install dependencies

npm is supported.

# Install the dependency modules.
$ npm install

3. Build

Use npm script to build egjs-infinitegrid

# Run webpack-dev-server for development
$ npm start

# Build
$ npm run build

# Generate jsdoc
$ npm run jsdoc

Two folders will be created after complete build is completed.

• dist folder: Includes the infinitegrid.js and infinitegrid.min.js files.
• doc folder: Includes API documentation. The home page for the documentation is doc/index.html.

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 npm run test command before you push code to a remote repository.

$ npm run test

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

Bug Report

If you find a bug, please report it to us using the Issues page on GitHub.

License

egjs-infinitegrid is released under the MIT license.

Copyright (c) 2015 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.