ngx-infinite-scroll

  • Version 17.0.0
  • Published
  • 153 kB
  • 1 dependency
  • MIT license

Install

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

Overview

[![Build Status](https://travis-ci.org/orizens/ngx-infinite-scroll.svg?branch=master)](https://travis-ci.org/orizens/ngx-infinite-scroll) [![Backers on Open Collective](https://opencollective.com/ngx-infinite-scroll/backers/badge.svg)](#backers) [![Sponso

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 ɵdir

                        static ɵdir: i0.ɵɵDirectiveDeclaration<
                        InfiniteScrollDirective,
                        '[infiniteScroll], [infinite-scroll], [data-infinite-scroll]',
                        never,
                        {
                        infiniteScrollDistance: {
                        alias: 'infiniteScrollDistance';
                        required: false;
                        };
                        infiniteScrollUpDistance: {
                        alias: 'infiniteScrollUpDistance';
                        required: false;
                        };
                        infiniteScrollThrottle: {
                        alias: 'infiniteScrollThrottle';
                        required: false;
                        };
                        infiniteScrollDisabled: {
                        alias: 'infiniteScrollDisabled';
                        required: false;
                        };
                        infiniteScrollContainer: {
                        alias: 'infiniteScrollContainer';
                        required: false;
                        };
                        scrollWindow: { alias: 'scrollWindow'; required: false };
                        immediateCheck: { alias: 'immediateCheck'; required: false };
                        horizontal: { alias: 'horizontal'; required: false };
                        alwaysCallback: { alias: 'alwaysCallback'; required: false };
                        fromRoot: { alias: 'fromRoot'; required: false };
                        },
                        { scrolled: 'scrolled'; scrolledUp: 'scrolledUp' },
                        never,
                        never,
                        false,
                        never
                        >;

                          property ɵfac

                          static ɵfac: i0.ɵɵFactoryDeclaration<InfiniteScrollDirective, never>;

                            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 {}

                                                property ɵfac

                                                static ɵfac: i0.ɵɵFactoryDeclaration<InfiniteScrollModule, never>;

                                                  property ɵinj

                                                  static ɵinj: i0.ɵɵInjectorDeclaration<InfiniteScrollModule>;

                                                    property ɵmod

                                                    static ɵmod: i0.ɵɵNgModuleDeclaration<
                                                    InfiniteScrollModule,
                                                    [typeof i1.InfiniteScrollDirective],
                                                    never,
                                                    [typeof i1.InfiniteScrollDirective]
                                                    >;

                                                      class NgxInfiniteScrollService

                                                      class NgxInfiniteScrollService {}

                                                        constructor

                                                        constructor();

                                                          property ɵfac

                                                          static ɵfac: i0.ɵɵFactoryDeclaration<NgxInfiniteScrollService, never>;

                                                            property ɵprov

                                                            static ɵprov: i0.ɵɵInjectableDeclaration<NgxInfiniteScrollService>;

                                                              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 (5)

                                                                                            Dependencies (1)

                                                                                            Dev Dependencies (0)

                                                                                            No dev dependencies.

                                                                                            Peer Dependencies (2)

                                                                                            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>