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

Constructors

constructor

Properties

change hasNext hasPrev index item? items page? pages?

Methods

generatePages next prev setPerPage setTo

Constructors

constructor

Properties

Readonlychange

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

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

hasNext

hasNext: boolean = false

Whether there is a next item or page or not.

hasPrev

hasPrev: boolean = false

Whether there is a next item or page or not.

index

index: number = 0

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

Optionalitem

item?: T

Current item (in case of non-multi).

items

items: T[]

List of items

Optionalpage

page?: T[]

Current page (in case of multi).

Optionalpages

pages?: T[][]

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

Methods

generatePages

  • generatePages(): void

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

    Returns void

    See

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

next

prev

setPerPage

  • setPerPage(value): boolean

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

    Parameters

    • value: number

    Returns boolean

setTo

Settings

Member Visibility

On This Page

Constructors
Properties
Methods