@egjs/ngx-infinitegrid 3.3.0 → 4.1.2-beta.1

package/README.md

@@ -1,234 +1,163 @@
-# ngx-infinitegrid [![npm version](https://badge.fury.io/js/%40egjs%2Fngx-infinitegrid.svg)](https://badge.fury.io/js/%40egjs%2Fngx-infinitegrid)
-
-An Angular component that can easily use [egjs-infinitegrid](https://github.com/naver/egjs-infinitegrid)
-* [Playground with Various Demos](https://naver.github.io/egjs-infinitegrid/storybook/)
-* [GridLayout Demo](https://codesandbox.io/s/ngx-infinitegrid-demo-gridlayout-vu7pp)
-* [GridLayout with Parallax Demo](https://codesandbox.io/s/ngx-infinitegrid-parallax-demo-gridlayout-cvxg5)
-* [JustifiedLayout Demo](https://codesandbox.io/s/ngx-infinitegrid-demo-justifiedlayout-ypvf7)
-* [Youtube Demo](https://codesandbox.io/s/ngx-infinitegrid-youtube-demo-m1npy)
-* [API Documentation](https://naver.github.io/egjs-infinitegrid/release/latest/doc/)
-
-
-## Install
-```bash
-$ npm install @egjs/ngx-infinitegrid  --save
+<h1 align="center">
+  <img width="256" alt="InfiniteGrid Logo" src="https://naver.github.io/egjs-infinitegrid/img/infinitegrid_logo.png"><br/>
+  @egjs/ngx-infinitegrid
+</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@egjs/ngx-infinitegrid" target="_blank">
+    <img src="https://img.shields.io/npm/v/@egjs/ngx-infinitegrid.svg?style=flat-square&color=dd0031&label=version&logo=NPM">
+  </a>
+  <a href="https://www.npmjs.com/package/@egjs/ngx-infinitegrid" target="_blank">
+    <img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@egjs/ngx-infinitegrid.svg?style=flat-square&label=%F0%9F%92%BE%20gzipped&color=007acc">
+  </a>
+  <a href="https://github.com/naver/egjs-infinitegrid/graphs/commit-activity">
+    <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/naver/egjs-infinitegrid.svg?style=flat-square&label=%E2%AC%86%20commits&color=08CE5D">
+  </a>
+  <a href="https://www.npmjs.com/package/@egjs/ngx-infinitegrid" target="_blank">
+    <img src="https://img.shields.io/npm/dm/@egjs/ngx-infinitegrid.svg?style=flat-square&label=%E2%AC%87%20downloads&color=08CE5D" alt="npm downloads per month">
+  </a>
+  <a href="https://github.com/naver/egjs-infinitegrid/graphs/contributors" target="_blank">
+    <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/naver/egjs-infinitegrid.svg?label=%F0%9F%91%A5%20contributors&style=flat-square&color=08CE5D"></a>
+  <a href="https://github.com/naver/egjs-infinitegrid/blob/master/LICENSE" target="_blank">
+    <img alt="GitHub" src="https://img.shields.io/github/license/naver/egjs-infinitegrid.svg?style=flat-square&label=%F0%9F%93%9C%20license&color=08CE5D">
+  </a>
+</p>
+
+<p align="center">
+  An Angular component that can arrange items infinitely according to the type of grids
+</p>
+
+<p align="center">
+  <a href="https://naver.github.io/egjs-infinitegrid/">Demo</a> / <a href="https://naver.github.io/egjs-infinitegrid/docs/api/InfiniteGrid">Documentation</a> / <a href="https://naver.github.io/egjs/">Other components</a>
+</p>
+
+## ⚙️ Installation
+```sh
+npm install --save @egjs/ngx-infinitegrid
 ```
 
-## How to use
-
-### Module
-```js
+## 🏃 Quick Start
+### Module definition
+```diff
++import { NgxInfiniteGridModule } from '@egjs/ngx-infinitegrid';
 import { BrowserModule } from '@angular/platform-browser';
 import { NgModule } from '@angular/core';
-import { AppComponent } from './app.component';
-
-import {
-  NgxInfiniteGridModule,
-  NgxInfiniteGridComponent,
-  NgxGridLayoutComponent,
-  NgxJustifiedLayoutComponent,
-  NgxSquareLayoutComponent,
-  NgxFrameLayoutComponent,
-  NgxPackingLayoutComponent,
-} from '@egjs/ngx-infinitegrid';
-
+ 
 @NgModule({
   declarations: [
-    AppComponent,
-    NgxGridLayoutComponent,
+    AppComponent
   ],
   imports: [
     BrowserModule,
-    // NgxInfiniteGridModule,
++   NgxInfiniteGridModule /* Add in imports */
   ],
   providers: [],
   bootstrap: [AppComponent]
 })
-export class AppModule {}
+export class AppModule { } /* Your app */
 ```
 
-### App
+```html
+<div NgxMasonryInfiniteGrid
+  class="container"
+  [gap]="5"
+  [items]="items"
+  [trackBy]="trackBy"
+  [groupBy]="groupBy"
+  (requestAppend)="onRequestAppend($event)"
+  *ngFor="let item of [0]; trackBy: randomTrackBy;"
+  #ig
+  >
+  <div class="item" *ngFor ="let item of ig.visibleItems; trackBy: trackBy;">
+  </div>
+</div>
+```
 
 ```ts
+import { Component, Input } from '@angular/core';
+import { OnRequestAppend } from '@egjs/infinitegrid';
+
 @Component({
   selector: 'app-root',
   templateUrl: './app.component.html',
-  styleUrls: ['./app.component.css']
 })
 export class AppComponent {
-  options={
-    threshold: 100,
-    isOverflowScroll: false,
-    isEqualSize: false,
-    isContantSize: false,
-    useFit: false,
-    useRecycle: false,
-    horizontal: false,
-  };
-  layoutOptions={
-    align: "justify",
-  };
-  start = 0;
-  items = [];
-  loadItems(groupKey: number, num: number) {
-    const items = this.items;
-    const start = this.start || 0;
-
-    for (let i = 0; i < num; ++i) {
-      items.push({
-        groupKey,
-        itemKey: start + i,
-        no: start + i,
-      });
-    }
-    this.items = [...items];
-    this.start += num;
-  }
-  onAppend({ currentTarget, groupKey, startLoading }) {
-    (window as any).a = this;
-    if (currentTarget.isLoading()) {
-      return;
-    }
-    startLoading();
-    this.loadItems(parseFloat(groupKey || 0) + 1, 5);
-  }
-  onLayoutComplete({ isAppend, isLayout, endLoading, fromCache }) {
-    if (!isLayout) {
-      endLoading();
+  items = this.getItems(0, 10);
+  getItems(nextGroupKey: number, count: number) {
+    const nextItems = [];
+    const nextKey = nextGroupKey * count;
+
+    for (let i = 0; i < count; ++i) {
+      nextItems.push({ groupKey: nextGroupKey, key: nextKey + i });
     }
+    return nextItems;
   }
-  onImageError({ totalIndex }) {
-    this.items.splice(totalIndex, 1);
-    this.items = [ ...this.items ];
-  }
-  onChange(e) {
-    console.log(e);
-  }
-  onPrepend(e) {
-    console.log(e);
+  groupBy(_: any, item: any) {
+    return item.groupKey;
   }
-  trackBy(index: number, item: IItem): any {
-    return item.itemKey;
+  trackBy(_: any, item: any) {
+    return item.key;
   }
-  groupBy(index: number, item: IItem): any {
-    return item.groupKey;
+  onRequestAppend(e: OnRequestAppend) {
+    const nextGroupKey = (+e.groupKey! || 0) + 1;
+
+    this.items = [
+      ...this.items,
+      ...this.getItems(nextGroupKey, 10),
+    ];
   }
 }
-
-```
-
-### Template
-```html
-<ngx-gridlayout #ig
-  [loading]="loading"
-  [options]="options"
-  [layoutOptions]="layoutOptions"
-  [items]="items"
-  [trackBy]="trackBy"
-  [groupBy]="groupBy"
-  (append)="onAppend($event)"
-  (prepend)="onPrepend($event)"
-  (change)="onChange($event)"
-  (layoutComplete)="onLayoutComplete($event)"
-  (imageError)="onImageError($event)">
-  <div class="loading" #loading>LOADING?</div>
-  <div class="item" *ngFor ="let item of ig.visibleItems; trackBy: trackBy;">
-      egjs {{item.no}}
-  </div>
-</ngx-gridlayout>
 ```
 
 
-## Props
-
-|name|type|default|description|
-|---|---|---|---|
-|trackBy|Function|get itemKey|Get a unique key that defines how to track changes for items in the iterable.|
-|groupBy|Function|get groupKey or data-groupkey|Get a unique key to distinguish between groups.|
-|useFirstRender|boolean|false|The useFirstRender option determines whether the markup will be shown on the first rendering or after loading is complete.|
-|loading|HTMLElement||Specifies the Loading Bar to use for append or prepend items.|
-|status|IInfiniteGridStatus|null|State object of the react-infinitegrid module|
-|layoutType|Class|GridLayout|Specifies the Layout class to use.|
-|options|IInfiniteGridOptions|{}|The option object of the eg.InfiniteGrid module|
-|layoutOptions|IInfiniteGridOptions|{}|Options to apply to the Layout.|
-
-
-### Options
-* [InfiniteGrid's options](https://naver.github.io/egjs-infinitegrid/release/latest/doc/eg.InfiniteGrid.html)
-* [InfiniteGrid's events](https://naver.github.io/egjs-infinitegrid/release/latest/doc/eg.InfiniteGrid.html#event:append)
-* [GridLayout's layoutOptions](https://naver.github.io/egjs-infinitegrid/release/latest/doc/eg.InfiniteGrid.GridLayout.html)
-* [JustifiedLayout's layoutOptions](https://naver.github.io/egjs-infinitegrid/release/latest/doc/eg.InfiniteGrid.JustifiedLayout.html)
-* [SquareLayout's layoutOptions](https://naver.github.io/egjs-infinitegrid/release/latest/doc/eg.InfiniteGrid.SquareLayout.html)
-* [FrameLayout's layoutOptions](https://naver.github.io/egjs-infinitegrid/release/latest/doc/eg.InfiniteGrid.FrameLayout.html)
-* [PackingLayout's layoutOptions](https://naver.github.io/egjs-infinitegrid/release/latest/doc/eg.InfiniteGrid.PackingLayout.html)
+## 📖 More Options & Examples
+[Options](https://naver.github.io/egjs-infinitegrid/Options) / [Demos](https://naver.github.io/egjs-infinitegrid/Demos)
 
+## 🙌 Contributing
+See [CONTRIBUTING.md](https://github.com/naver/egjs-infinitegrid/blob/master/CONTRIBUTING.md)
 
+## 📝 Feedback
+Please file an [Issue](https://github.com/naver/egjs-infinitegrid/issues) with label "Angular".
 
-### Restore status
-
-If you want to restore the state, use the status prop.
-
-* Save Status
-```html
-<GridLayout #ig></GridLayout>
+## Local development
+### Project setup
 ```
-```tsx
-import { NgxGridLayoutComponent } from "@egjs/ngx-infinitegrid";
-
-@ViewChild('ig', { static: false }) ig: NgxGridLayoutComponent;
-
-// Save Status
-this.ig.getStatus();
+npm install
 ```
 
-* Restore Status (First mount)
-```html
-
-<GridLayout
-	[status]="status"></GridLayout>
+### Compiles and hot-reloads demo
+```sh
+npm run start
 ```
 
-* Dynamically restore status
-```ts
-import { NgxGridLayoutComponent } from "@egjs/ngx-infinitegrid";
-
-@ViewChild('ig', { static: false }) ig: NgxGridLayoutComponent;
-
-this.ig.setStatus(status);
+### Compiles and minifies for production
+```
+npm run build
 ```
 
-## ⚙️ Development
-
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.0.1.
-
-## Development server
-
-Run `npm run start(ng serve)` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
-
-
-
-## Bug Report
-
-If you find a bug, please report it to us using the [Issues](https://github.com/naver/egjs-infinitegrid/issues) page on GitHub.
-
+### Run your tests
+```
+npm run test
+```
 
-## License
-react-infinitegrid is released under the [MIT license](https://github.com/naver/egjs-infinitegrid/blob/master/LICENSE).
+### Lints and fixes files
+```
+npm run lint
+```
 
+## 📜 License
+egjs-infinitegrid is released under the [MIT license](http://naver.github.io/egjs/license.txt).
 
 ```
-Copyright (c) 2019-present NAVER Corp.
-
+Copyright (c) 2015-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
@@ -238,3 +167,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ```
 
+<p align="center">
+  <a href="https://naver.github.io/egjs/"><img height="50" src="https://naver.github.io/egjs/img/logotype1_black.svg" ></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/naver"><img height="50" src="https://naver.github.io/OpenSourceGuide/book/assets/naver_logo.png" /></a>
+</p>
+