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 | null,
): PaginatedListState<T, P>
Type Parameters
- T extends Model<T>
- P extends PaginatedListParams = PaginatedListParams
Parameters
- params: P = ...
- page: number = 1
- pageSize: number | null = null
Returns PaginatedListState<T, P>
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:59

Properties

`Protected`initialLoading

initialLoading: boolean = false

`Protected`loadingNext

loadingNext: boolean = false

`Protected`loadingPage

loadingPage: boolean = false

`Protected`loadingPrev

loadingPrev: boolean = false

`Protected`location

location: PaginationLocation

`Protected`pages

pages: Page<T>[] = []

pageSize

pageSize: number | null

`Protected`params

params: P = ...

totalItems

totalItems: number | null = null

`Static`DEFAULT_PAGE_SIZE

DEFAULT_PAGE_SIZE: number = 20

This value should not be relied upon when preloading an API document. In those cases the pageSize should be taken from the meta information of the preloaded document. Checkout DiscussionListState.loadPage for an example.

Accessors

`Abstract`type

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

Methods

changeFilter

changeFilter(key: string, value: any): void
Parameters
- key: string
- value: any
Returns void
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:382

changeSort

changeSort(sort: string): void
Parameters
- sort: string
Returns void
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:372

clear

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

currentSort

currentSort(): string | undefined
Returns string | undefined
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:368

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:273

hasNext

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

hasPrev

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

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:283

isInitialLoading

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

isLoading

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

isLoadingNext

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

isLoadingPrev

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

isSearchResults

isSearchResults(): boolean
In the last request, has the user searched for a model?

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

loadNext

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

`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:123

loadPrev

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

`Protected`mutateRequestParams

mutateRequestParams(
params: ApiQueryParamsPlural,
page: number,
): ApiQueryParamsPlural
Parameters
- params: ApiQueryParamsPlural
- page: number
Returns ApiQueryParamsPlural
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:162

`Protected`paramsChanged

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

`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:98

push

push(model: T): void
Parameters
- model: T
Returns void
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:339

refresh

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

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:210

remove

remove(model: T): void
Parameters
- model: T
Returns void
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:395

`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:198

sortMap

sortMap(): SortMap
Returns SortMap
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:360

sortValue

sortValue(sort: SortMapItem): string | undefined
Parameters
- sort: SortMapItem
Returns string | undefined
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:364

Class PaginatedListState<T, P>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns PaginatedListState<T, P>

Properties

ProtectedinitialLoading

ProtectedloadingNext

ProtectedloadingPage

ProtectedloadingPrev

Protectedlocation

Protectedpages

pageSize

Protectedparams

totalItems

StaticDEFAULT_PAGE_SIZE

Accessors

Abstracttype

Returns string

Methods

changeFilter

Parameters

Returns void

changeSort

Parameters

Returns void

clear

Returns void

currentSort

Returns string | undefined

ProtectedgetAllItems

Returns T[]

getLocation

Returns PaginationLocation

ProtectedgetNextPageNumber

Returns number

getPages

Returns Page<T>[]

getParams

Returns P

ProtectedgetPrevPageNumber

Returns number

getSort

Returns string

goto

Parameters

Returns Promise<void>

hasItems

Returns boolean

See

hasNext

Returns boolean

hasPrev

Returns boolean

isEmpty

Returns boolean

See

isInitialLoading

Returns boolean

isLoading

Returns boolean

isLoadingNext

Returns boolean

isLoadingPrev

Returns boolean

isSearchResults

Returns boolean

loadNext

Returns Promise<void>

ProtectedloadPage

Parameters

Returns Promise<ApiResponsePlural<T>>

Class PaginatedListState<T, P>`Abstract`

`Protected`constructor

`Protected`initialLoading

`Protected`loadingNext

`Protected`loadingPage

`Protected`loadingPrev

`Protected`location

`Protected`pages

`Protected`params

`Static`DEFAULT_PAGE_SIZE

`Abstract`type

`Protected`getAllItems

`Protected`getNextPageNumber

`Protected`getPrevPageNumber

`Protected`loadPage

`Protected`mutateRequestParams

`Protected`paramsChanged

`Protected`parseResults

`Protected` `Abstract`requestParams