https://github.com/robingenz/ngx-infinite-scroll

📜 Angular directive for infinite scrolling.
https://github.com/robingenz/ngx-infinite-scroll

angular infinite-scroll ngx

Last synced: about 1 month ago
JSON representation

📜 Angular directive for infinite scrolling.

• Host: GitHub
• URL: https://github.com/robingenz/ngx-infinite-scroll
• Owner: robingenz
• Created: 2021-06-24T19:46:38.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-20T06:54:13.000Z (9 months ago)
• Last Synced: 2024-03-24T15:03:35.807Z (4 months ago)
• Topics: angular, infinite-scroll, ngx
• Language: TypeScript
• Homepage:
• Size: 2.9 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-angular - @robingenz/ngx-infinite-scroll - Simple Angular directive for infinite scrolling. (Table of contents / Third Party Components)

README

        
# ngx-infinite-scroll

[![npm (version)](https://img.shields.io/npm/v/@robingenz/ngx-infinite-scroll)](https://www.npmjs.com/package/@robingenz/ngx-infinite-scroll)

[![npm (downloads)](https://img.shields.io/npm/dw/@robingenz/ngx-infinite-scroll)](https://www.npmjs.com/package/@robingenz/ngx-infinite-scroll)

📜 Angular directive for infinite scrolling.

## Installation

```bash

npm install @robingenz/ngx-infinite-scroll

```

Import the `InfiniteScrollModule`:

```ts

import { InfiniteScrollModule } from '@robingenz/ngx-infinite-scroll';

@NgModule({

  imports: [InfiniteScrollModule],

})

export class AppModule {}

```

## Usage

```html



  
{{ item }}



```


## API

### Properties

| Name                    | Type    | Required | Default | Details                                                                                                                                                          |

| ----------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| infiniteScrollThreshold | string  | ✕        | 200px   | The threshold distance from the bottom of the element to call the `onInfiniteScroll` output event when scrolled.The value can be either a percent, or in pixels. |

| infiniteScrollDisabled  | boolean | ✕        | false   | If `true`, the infinite scroll event listeners will be removed.                                                                                                  |

### Events

| Name | Type | Details |

|----------|------|---------|

|onInfiniteScroll|void|Emitted when the scroll reaches the threshold distance.|

## Example

A working example can be found [here](https://stackblitz.com/github/robingenz/ngx-infinite-scroll).

## Changelog

See [CHANGELOG.md](https://github.com/robingenz/ngx-infinite-scroll/blob/main/CHANGELOG.md).

## License

See [LICENSE](https://github.com/robingenz/ngx-infinite-scroll/blob/main/LICENSE).