import GlobalSearchState from 'flarum/states/GlobalSearchState'

public class | source

GlobalSearchState

Extends:

SearchState → GlobalSearchState

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	value: *

Method Summary

Public Methods
public	changeSort(sort: String) Redirect to the index page using the given sort parameter.
public	clear() Clear the search input and the current controller's active search.
public	clearInitialSearch() Redirect to the index page without a search filter.
public	getInitialSearch(): String Return the current search query, if any.
public	getValue(): *
public	params(): Object Get parameters to pass to the DiscussionList component.
public	stickyParams(): Object Get URL parameters that stick between filter changes.

Inherited Summary

From class SearchState
public	cachedSearches: *
public	value: *
public	cache(query: *) Mark that we have already searched for this query so that we don't have to ping the endpoint again.
public	clear() Clear the search value.
public	getValue(): *
public	isCached(query: ): Check if this query has been searched before.
public	setValue(value: *)

Public Constructors

public constructor() source

Override:

SearchState#constructor

Public Members

public value: * source

Override:

SearchState#value

Public Methods

public changeSort(sort: String) source

Redirect to the index page using the given sort parameter.

Params:

Name	Type	Attribute	Description
sort	String

public clear() source

Clear the search input and the current controller's active search.

Override:

SearchState#clear

public clearInitialSearch() source

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

See:

public getInitialSearch(): String source

Return the current search query, if any. This is implemented to activate the search box in the header.

GlobalSearchState

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public value: * source

Override:

Public Methods

public changeSort(sort: String) source

Params:

public clear() source

Override:

public clearInitialSearch() source

See:

public getInitialSearch(): String source

Return:

See:

public getValue(): * source

Override:

Return:

public params(): Object source

Return:

public stickyParams(): Object source

Return: