@amirsavand/ngx-common - v5.3.0
    Preparing search index...

    Class ListItemCycle<T>

    Takes a list and cycles through them.

    This is good for showing a single item on the UI and letting user cycle through then with a click of a button.

    Type Parameters

    • T
    Index

    Constructors

    constructor

    Properties

    change hasNext hasPrev index item? items page? pages? perPage

    Accessors

    isMulti

    Methods

    generatePages next prev setPerPage setTo

    Constructors

    • Type Parameters

      • T

      Parameters

      • items: T[]

        List of items

      • perPage: number = 0

        Number of items in a page in case of multi.

      Returns ListItemCycle<T>

    Properties

    change: EventEmitter<T | T[]> = ...

    Event that is triggered when current item changes. Or page changes in case of multi.

    hasNext: boolean = false

    Whether there is a next item or page or not.

    hasPrev: boolean = false

    Whether there is a next item or page or not.

    index: number = 0

    Current item or page (in case of multi) index.

    item?: T

    Current item (in case of non-multi).

    items: T[]

    List of items

    Optionalpage

    page?: T[]

    Current page (in case of multi).

    pages?: T[][]

    List of pages of list of items per page. Used in case of multi.

    perPage: number = 0

    Number of items in a page in case of multi.

    Accessors

    • get isMulti(): boolean

      Returns boolean

      true if cycle is for pages (multi per page).

    Methods

    • Generate list of pages of items based on per page.

      Returns void

      • ListItemCycle.perPage
      • ListItemCycle.pages
      • ListItemCycle.page

    • Change to next item

      Returns void

    • Change to previous item

      Returns void

    • To change the value of perPage call this method. It validates the value and regenerates pages as well.

      Parameters

      • value: number

      Returns boolean

    • Change current item/page to given index.

      Parameters

      • index: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods