angular-infinity-scrolling 0.0.1 → 1.1.0

package/README.md

@@ -1,24 +1,34 @@
-# AngularInfinityScroller
-
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.0.
-
-## Code scaffolding
-
-Run `ng generate component component-name --project angular-infinity-scroller` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project angular-infinity-scroller`.
-> Note: Don't forget to add `--project angular-infinity-scroller` or else it will be added to the default project in your `angular.json` file. 
-
-## Build
-
-Run `ng build angular-infinity-scroller` to build the project. The build artifacts will be stored in the `dist/` directory.
-
-## Publishing
-
-After building your library with `ng build angular-infinity-scroller`, go to the dist folder `cd dist/angular-infinity-scroller` and run `npm publish`.
-
-## Running unit tests
-
-Run `ng test angular-infinity-scroller` to execute the unit tests via [Karma](https://karma-runner.github.io).
-
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+## Thank you for using angular -infinity-scroller for infinite scrolling.
+## Use Case
+### Note: Current version ov package is compatible with angular version above 17
+### go to the directory, open terminal and and install package using `npm i angular-infinity-scroller`
+### Go to the ts file of component e.g. example.component.ts and insert AngularInfinityScrollerDirective
+
+
+```ruby
+import {AngularInfiniteScrollerDirective} from "angular-infinity-scroller";
+
+@Component({
+  selector: 'app-example',
+  imports: [
+    AngularInfiniteScrollerDirective,
+  ],
+  templateUrl: './exaple.component.html',
+  styleUrl: './exaple.component.scss',
+})
+export class ExampleComponent
+```
+````
+followed by consuming the directive in example.component.
+````
+### Currently Directive has 2 properties
+````
+scrollDistance - input which accpet a number between 1  and 10 describing to emit the data if scrollable height is less than or equal to (number*10) percent
+[scrollDistance]='2' value will be emitted if scrollable height is less than or 20%
+onScrolled - output that accept a voidFunction to be invoked on emit
+(onScrolled)="handleScroll()"
+````
+```ruby
+<div class='scrollable-parent' appAngularInfinityScroller [scrollDistance]="4" (onScrolled)="handleScroll()">
+</div>
+```

package/package.json

@@ -1,6 +1,25 @@
 {
   "name": "angular-infinity-scrolling",
-  "version": "0.0.1",
+  "version": "1.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Jayant061/angular-infinity-scroller"
+  },
+  "bugs": {
+    "url": "https://github.com/Jayant061/angular-infinity-scroller/issues"
+  },
+  "keywords": [
+    "Angular-infinity-scrolling",
+    "Angular-infinity-scroller",
+    "infinity-scroller",
+    "Angular-infinite-scroller",
+    "Angular-infinite-scroll",
+    "infinte-scroll",
+    "infinite",
+    "Angular"
+  ],
+  "author": "Jayant Thakur",
+  "license": "ISC",
   "peerDependencies": {
     "@angular/common": "^18.2.0",
     "@angular/core": "^18.2.0"
@@ -22,4 +41,4 @@
       "default": "./fesm2022/angular-infinity-scroller.mjs"
     }
   }
-}
+}