Interface SearchBarStateModel

Framework-independent SearchBar state.

interface SearchBarStateModel {
    activeScope(): SearchBarScope | undefined;
    clear(): boolean;
    nextScope(): SearchBarScope | undefined;
    previousScope(): SearchBarScope | undefined;
    query(): string;
    setOptions(options: CreateSearchBarStateOptions): void;
    setQuery(query: string): boolean;
    setScope(scopeId: string): boolean;
    submit(): boolean;
}

Index

Methods

activeScope clear nextScope previousScope query setOptions setQuery setScope submit

Methods

activeScope

activeScope(): SearchBarScope | undefined
Current scope, when configured.

Returns SearchBarScope | undefined
- Defined in components/input/search-bar/index.ts:97

clear

clear(): boolean
Clears the query when enabled.

Returns boolean
- Defined in components/input/search-bar/index.ts:99

nextScope

nextScope(): SearchBarScope | undefined
Advances to the next scope.

Returns SearchBarScope | undefined
- Defined in components/input/search-bar/index.ts:101

previousScope

previousScope(): SearchBarScope | undefined
Moves to the previous scope.

Returns SearchBarScope | undefined
- Defined in components/input/search-bar/index.ts:103

query

query(): string
Current controlled or uncontrolled query.

Returns string
- Defined in components/input/search-bar/index.ts:105

setOptions

setOptions(options: CreateSearchBarStateOptions): void
Replaces callbacks, controlled values, and scopes.
Parameters
- options: CreateSearchBarStateOptions
Returns void
- Defined in components/input/search-bar/index.ts:107

setQuery

setQuery(query: string): boolean
Requests a query change and reports whether enabled.
Parameters
- query: string
Returns boolean
- Defined in components/input/search-bar/index.ts:109

setScope

setScope(scopeId: string): boolean
Requests a scope change and reports whether enabled.
Parameters
- scopeId: string
Returns boolean
- Defined in components/input/search-bar/index.ts:111

submit

submit(): boolean
Submits the current query and scope when enabled.

Returns boolean
- Defined in components/input/search-bar/index.ts:113