angular2-virtual-scroll - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "angular2-virtual-scroll",
-  "version": "0.0.1",
-  "description": "Angular 2 module for introducing virtual scroll capability",
-  "main": "index.ts",
+  "version": "0.0.2",
+  "description": "Angular 2 module for virtual -infinite- list.",
+  "main": "dist/virtual-scroll.js",
+  "types": "dist/virtual-scroll.d.ts",
   "scripts": {
+    "tsc": "node_modules/typescript/bin/tsc",
+    "build": "npm run tsc --",
+    "tslint": "tslint",
+    "lint": "tslint src/**/*.ts",
+    "watch": "npm run tsc -- -w",
+    "start": "npm run watch",
     "test": "npm test"
@@ -14,6 +21,5 @@ },
   "keywords": [
-    "virtual",
+    "virtual scroll",
     "scroll",
-    "angular",
-    "2"
+    "angular 2"
   ],
@@ -25,3 +31,16 @@ "author": "Rinto Jose",
   },
-  "homepage": "https://github.com/rintoj/angular2-virtual-scroll#readme"
+  "homepage": "https://github.com/rintoj/angular2-virtual-scroll#readme",
+  "devDependencies": {
+    "@angular/common": "2.1.1",
+    "@angular/compiler": "2.1.1",
+    "@angular/core": "2.1.1",
+    "@angular/platform-browser": "2.1.1",
+    "@angular/platform-browser-dynamic": "2.1.1",
+    "@types/node": "6.0.45",
+    "codelyzer": "1.0.0-beta.2",
+    "rxjs": "5.0.0-beta.12",
+    "tslint": "3.15.1",
+    "typescript": "2.0.6",
+    "zone.js": "0.6.25"
+  }
 }

README.md

 
 # angular2-virtual-scroll
 
-Coming soon
+Virtual Scroll displays a virtual, "infinite" list.
 
+## About
+
+This module does not render every record in the list at once; instead a small subset of records just enough to fill the viewport are rendered and reused as the user scrolls. Thus displaying an infinitely growing list of items in a viewport of size just about a couple rows in an efficient way is made possible.
+
+* Angular 2 compatible module
+* Easy to use apis
+* OpenSource and available in GitHub
+
+**Note:** Items must have a fixed height and width for this module to work perfectly.
+
+## Demo
+
+[See Demo Here](http://rintoj.github.io/angular2-virtual-scroll)
+
+## Usage
+
+```
+<virtual-scroll [items]="items" (update)="viewPortItems = $event">
+
+    <list-item *ngFor="let item of viewPortItems" [item]="item">
+    </list-item>
+
+</virtual-scroll>
+```
+
+## Get Started
+
+**Step 1:** Install angular2-virtual-scroll
+
+```
+npm install angular2-virtual-scroll --save
+```
+
+**Step 2:** Import virtual scroll module into your app module
+
+```
+....
+import { VirtualScrollModule } from 'angular2-virtual-scroll';
+
+....
+
+@NgModule({
+    ...
+    imports: [
+        ....
+        VirtualScrollModule
+    ],
+    ....
+})
+export class AppModule { }
+```
+
+**Step 3:** Wrap virtual-scroll tag around list items;
+
+```
+<virtual-scroll [items]="items" (update)="viewPortItems = $event">
+
+    <list-item *ngFor="let item of viewPortItems" [item]="item">
+    </list-item>
+
+</virtual-scroll>
+```
+
 ## Contributing
-Contributions are very welcome! Just send a pull request. Feel free to contact me or checkout my [Github](https://github.com/rintoj) page.
+Contributions are very welcome! Just send a pull request. Feel free to contact me or checkout my [GitHub](https://github.com/rintoj) page.
 
 ## Author
 
-**Rinto Jose** (rintoj) 
+**Rinto Jose** (rintoj)
 
 Follow me:
-  [Github](https://github.com/rintoj)
+  [GitHub](https://github.com/rintoj)
 | [Facebook](https://www.facebook.com/rinto.jose)
@@ -16,0 +79,0 @@ | [Twitter](https://twitter.com/rintoj)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20566

increased by529.12%

Number of package files

9

increased by200%

Lines of code

357

increased byInfinity%

Number of lines in readme file

106

increased by146.51%

Worsened metrics

Dev dependency count

11

increased byInfinity%

No dependency changes