Class PaginatedListState<T, P>`Abstract`

Type Parameters

T extends Model
P extends PaginatedListParams = PaginatedListParams

Hierarchy (View Summary)

PaginatedListState

Constructors

`Protected`constructor

new PaginatedListState<
    T extends Model<T>,
    P extends PaginatedListParams = PaginatedListParams,
>(
    params?: P,
    page?: number,
    pageSize?: number,
): PaginatedListState<T, P>
Type Parameters
- T extends Model<T>
- P extends PaginatedListParams = PaginatedListParams
Parameters
- params: P = ...
- page: number = 1
- pageSize: number = 20
Returns PaginatedListState<T, P>
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:38

Properties

`Protected`initialLoading

initialLoading: boolean = false

`Protected`loadingNext

loadingNext: boolean = false

`Protected`loadingPrev

loadingPrev: boolean = false

`Protected`location

location: PaginationLocation

`Protected`pages

pages: Page<T>[] = []

`Protected`pageSize

pageSize: number

`Protected`params

params: P = ...

Accessors

`Abstract`type

get type(): string
Returns string
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:45

Methods

clear

clear(): void
Returns void
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:47

`Protected`getAllItems

getAllItems(): T[]
Returns T[]
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:243

getLocation

getLocation(): PaginationLocation
Returns PaginationLocation
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:168

`Protected`getNextPageNumber

getNextPageNumber(): number
Returns number
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:218

getPages

getPages(): Page<T>[]
Returns Page<T>[]
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:165

getParams

getParams(): P
Stored state parameters.

Returns P
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:214

`Protected`getPrevPageNumber

getPrevPageNumber(): number
Returns number
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:227

hasItems

hasItems(): boolean
Returns true when the number of items across all loaded pages is not 0.

Returns boolean
See
isEmpty
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:190

hasNext

hasNext(): boolean
Returns boolean
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:207

hasPrev

hasPrev(): boolean
Returns boolean
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:204

isEmpty

isEmpty(): boolean
Returns true when there aren't any items and the state has already done its initial loading. If you want to know whether there are items regardless of load state, use hasItems() instead

Returns boolean
See
hasItems
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:200

isInitialLoading

isInitialLoading(): boolean
Returns boolean
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:175

isLoading

isLoading(): boolean
Returns boolean
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:172

isLoadingNext

isLoadingNext(): boolean
Returns boolean
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:181

isLoadingPrev

isLoadingPrev(): boolean
Returns boolean
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:178

loadNext

loadNext(): Promise<void>
Returns Promise<void>
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:65

`Protected`loadPage

loadPage(page?: number): Promise<ApiResponsePlural<T>>
Load a new page of results.
Parameters
- page: number = 1
Returns Promise<ApiResponsePlural<T>>
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:102

loadPrev

loadPrev(): Promise<void>
Returns Promise<void>
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:53

`Protected`paramsChanged

paramsChanged(newParams: P): boolean
Parameters
- newParams: P
Returns boolean
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:239

`Protected`parseResults

parseResults(pg: number, results: ApiResponsePlural<T>): void
Parameters
- pg: number
- results: ApiResponsePlural<T>
Returns void
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:77

refresh

refresh(page?: number): Promise<void>
Parameters
- page: number = 1
Returns Promise<void>
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:148

refreshParams

refreshParams(newParams: P, page: number): Promise<void>
Update the this.params object, calling refresh if they have changed. Use requestParams for converting this.params into API parameters
Parameters
- newParams: P
- page: number
Returns Promise<void>
See
requestParams
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:138

`Protected` `Abstract`requestParams

requestParams(): PaginatedListRequestParams
Get the parameters that should be passed in the API request. Do not include page offset unless subclass overrides loadPage.

Returns PaginatedListRequestParams
See
loadPage
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:126