ngx-infinite-scroll

  • Version 10.0.1
  • Published
  • 244 kB
  • 2 dependencies
  • MIT license

Install

npm i ngx-infinite-scroll
yarn add ngx-infinite-scroll
pnpm add ngx-infinite-scroll

Overview

An infinite scroll directive for Angular

Index

Classes

class InfiniteScrollDirective

class InfiniteScrollDirective implements OnDestroy, OnChanges, AfterViewInit {}

    constructor

    constructor(element: ElementRef, zone: NgZone);

      property alwaysCallback

      alwaysCallback: boolean;

        property fromRoot

        fromRoot: boolean;

          property horizontal

          horizontal: boolean;

            property immediateCheck

            immediateCheck: boolean;

              property infiniteScrollContainer

              infiniteScrollContainer: any;

                property infiniteScrollDisabled

                infiniteScrollDisabled: boolean;

                  property infiniteScrollDistance

                  infiniteScrollDistance: number;

                    property infiniteScrollThrottle

                    infiniteScrollThrottle: number;

                      property infiniteScrollUpDistance

                      infiniteScrollUpDistance: number;

                        property scrolled

                        scrolled: EventEmitter<IInfiniteScrollEvent>;

                          property scrolledUp

                          scrolledUp: EventEmitter<IInfiniteScrollEvent>;

                            property scrollWindow

                            scrollWindow: boolean;

                              method destroyScroller

                              destroyScroller: () => void;

                                method handleOnScroll

                                handleOnScroll: ({ type, payload }: IInfiniteScrollAction) => void;

                                  method ngAfterViewInit

                                  ngAfterViewInit: () => void;

                                    method ngOnChanges

                                    ngOnChanges: ({
                                    infiniteScrollContainer,
                                    infiniteScrollDisabled,
                                    infiniteScrollDistance,
                                    }: SimpleChanges) => void;

                                      method ngOnDestroy

                                      ngOnDestroy: () => void;

                                        method setup

                                        setup: () => void;

                                          class InfiniteScrollModule

                                          class InfiniteScrollModule {}

                                            Interfaces

                                            interface IInfiniteScrollEvent

                                            interface IInfiniteScrollEvent {}

                                              property currentScrollPosition

                                              currentScrollPosition: number;

                                                interface IPositionElements

                                                interface IPositionElements {}

                                                  property axis

                                                  axis: any;

                                                    property windowElement

                                                    windowElement: ContainerRef;

                                                      interface IPositionStats

                                                      interface IPositionStats {}

                                                        property height

                                                        height: number;

                                                          property isWindow

                                                          isWindow?: boolean;

                                                            property scrolled

                                                            scrolled: number;

                                                              property totalToScroll

                                                              totalToScroll: number;

                                                                interface IResolver

                                                                interface IResolver {}

                                                                  property axis

                                                                  axis: any;

                                                                    property container

                                                                    container: ContainerRef;

                                                                      property isWindow

                                                                      isWindow: boolean;

                                                                        Type Aliases

                                                                        type ContainerRef

                                                                        type ContainerRef = Window | ElementRef | any;

                                                                          Package Files (4)

                                                                          Dependencies (2)

                                                                          Dev Dependencies (37)

                                                                          Peer Dependencies (0)

                                                                          No peer dependencies.

                                                                          Badge

                                                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ngx-infinite-scroll.

                                                                          • Markdown
                                                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ngx-infinite-scroll)
                                                                          • HTML
                                                                            <a href="https://www.jsdocs.io/package/ngx-infinite-scroll"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>