1
0
mirror of https://github.com/flarum/core.git synced 2025-08-07 08:56:38 +02:00
Files
php-flarum/js/dist-typings/forum/states/GlobalSearchState.d.ts
flarum-bot c3a684c7ed Bundled output for commit 3537f76eab
Includes transpiled JS/TS, and Typescript declaration files (typings).

[skip ci]
2021-05-12 23:29:46 +00:00

38 lines
1.1 KiB
TypeScript

import SearchState from './SearchState';
declare type SearchParams = Record<string, string>;
export default class GlobalSearchState extends SearchState {
private initialValueSet;
constructor(cachedSearches?: never[]);
getValue(): string;
protected intializeValue(): void;
protected currPageProvidesSearch(): boolean;
/**
* @inheritdoc
*/
getInitialSearch(): string;
/**
* Clear the search input and the current controller's active search.
*/
clear(): 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.
*/
protected clearInitialSearch(): void;
/**
* Get URL parameters that stick between filter changes.
*
* This can be used to generate a link that clears filters.
*/
stickyParams(): SearchParams;
/**
* Get parameters to be used in the current page.
*/
params(): SearchParams;
/**
* Redirect to the index page using the given sort parameter.
*/
changeSort(sort: string): void;
}
export {};