Class PostListState<P>

Type Parameters

P extends PostListParams = PostListParams

Hierarchy (View Summary)

PaginatedListState<Post, P>
- PostListState

Constructors

constructor

new PostListState<P extends PostListParams = PostListParams>(
    params: P,
    page?: number,
    pageSize?: number | null,
): PostListState<P>
Type Parameters
- P extends PostListParams = PostListParams
Parameters
- params: P
- page: number = 1
- pageSize: number | null = null
Returns PostListState<P>
Overrides PaginatedListState.constructor
- Defined in flarum/framework/core/js/src/forum/states/PostListState.ts:17

Properties

`Protected`eventEmitter

eventEmitter: EventEmitter

`Protected`extraPosts

extraPosts: Post[] = []

`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<Post>[] = []

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

type

get type(): string
Returns string
Overrides PaginatedListState.type
- Defined in flarum/framework/core/js/src/forum/states/PostListState.ts:23

Methods

changeFilter

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

hasItems

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

Returns boolean
See
isEmpty
Inherited from PaginatedListState.hasItems
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:245

hasNext

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

hasPrev

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

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
Inherited from PaginatedListState.isEmpty
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:255

isInitialLoading

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

isLoading

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

isLoadingNext

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

isLoadingPrev

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

isSearchResults

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

Returns boolean
Inherited from PaginatedListState.isSearchResults
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:307

loadNext

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

`Protected`loadPage

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

loadPrev

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

`Protected`paramsChanged

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

`Protected`parseResults

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

push

push(model: Post): void
Parameters
- model: Post
Returns void
Inherited from PaginatedListState.push
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:311

refresh

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

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
Inherited from PaginatedListState.refreshParams
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:182

`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
Overrides PaginatedListState.requestParams
- Defined in flarum/framework/core/js/src/forum/states/PostListState.ts:27

sortMap

sortMap(): any
Get a map of sort keys (which appear in the URL, and are used for translation) to the API sort value that they represent.

Returns any
Overrides PaginatedListState.sortMap
- Defined in flarum/framework/core/js/src/forum/states/PostListState.ts:67

sortValue

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

Class PostListState<P>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PostListState<P>

Properties

ProtectedeventEmitter

ProtectedextraPosts

ProtectedinitialLoading

ProtectedloadingNext

ProtectedloadingPage

ProtectedloadingPrev

Protectedlocation

Protectedpages

pageSize

Protectedparams

totalItems

StaticDEFAULT_PAGE_SIZE

Accessors

type

Returns string

Methods

changeFilter

Parameters

Returns void

changeSort

Parameters

Returns void

clear

Returns void

currentSort

Returns string | undefined

ProtectedgetAllItems

Returns Post[]

getLocation

Returns PaginationLocation

ProtectedgetNextPageNumber

Returns number

getPages

Returns Page<Post>[]

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

`Protected`eventEmitter

`Protected`extraPosts

`Protected`initialLoading

`Protected`loadingNext

`Protected`loadingPage

`Protected`loadingPrev

`Protected`location

`Protected`pages

`Protected`params

`Static`DEFAULT_PAGE_SIZE

`Protected`getAllItems

`Protected`getNextPageNumber

`Protected`getPrevPageNumber

`Protected`loadPage

`Protected`paramsChanged

`Protected`parseResults

`Abstract`requestParams