Class GlobalSearchState

Hierarchy (View Summary)

SearchState
- GlobalSearchState

Index

Constructors

Properties

cachedSearches value

Methods

cache changeSort clear clearInitialSearch currPageProvidesSearch getInitialSearch getValue intializeValue isCached params setValue stickyParams

Constructors

constructor

new GlobalSearchState(cachedSearches?: never[]): GlobalSearchState
Parameters
- cachedSearches: never[] = []
Returns GlobalSearchState
Overrides SearchState.constructor
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:10

Properties

`Protected`cachedSearches

cachedSearches: Set<string>

`Protected`value

value: string = ''

Methods

cache

cache(query: string): void
Mark that we have already searched for this query so that we don't have to ping the endpoint again.
Parameters
- query: string
Returns void
Inherited from SearchState.cache
- Defined in flarum/framework/core/js/src/forum/states/SearchState.ts:41

changeSort

changeSort(sort: string): void
Redirect to the index page using the given sort parameter.
Parameters
- sort: string
Returns void
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:91

clear

clear(): void
Clear the search input and the current controller's active search.

Returns void
Overrides SearchState.clear
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:45

`Protected`clearInitialSearch

clearInitialSearch(): void
Redirect to the index page without a search filter. This is called when the 'x' is clicked in the search box in the header.

Returns void
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:59

`Protected`currPageProvidesSearch

currPageProvidesSearch(): boolean
Returns boolean
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:31

getInitialSearch

getInitialSearch(): string
If we are displaying the full results of a search (not just a preview), this value should return the query that prompted that search.

In this generic class, full page searching is not supported. This method should be implemented by subclasses that do support it.

Returns string

See
Search
Overrides SearchState.getInitialSearch
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:38

getValue

getValue(): string
Returns string
Overrides SearchState.getValue
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:14

`Protected`intializeValue

intializeValue(): void
Returns void
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:26

isCached

isCached(query: string): boolean
Check if this query has been searched before.
Parameters
- query: string
Returns boolean
Inherited from SearchState.isCached
- Defined in flarum/framework/core/js/src/forum/states/SearchState.ts:48

params

params(): SearchParams
Get parameters to be used in the current page.

Returns SearchParams
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:80

setValue

setValue(value: string): void
Parameters
- value: string
Returns void
Inherited from SearchState.setValue
- Defined in flarum/framework/core/js/src/forum/states/SearchState.ts:26

stickyParams

stickyParams(): SearchParams
Get URL parameters that stick between filter changes.

This can be used to generate a link that clears filters.

Returns SearchParams
- Defined in flarum/framework/core/js/src/forum/states/GlobalSearchState.ts:70