Interface SearchBox

The SearchBox controller allows users to enter a query and submit it to the Insight engine.

interface SearchBox {
    state: SearchBoxState;
    clear(): void;
    selectSuggestion(value: string): void;
    showSuggestions(): void;
    submit(): void;
    subscribe(listener: () => void): Unsubscribe;
    updateText(value: string): void;
}

Hierarchy (View Summary)

Controller
- SearchBox

Index

Methods

clear selectSuggestion showSuggestions submit subscribe updateText

Properties

Methods

clear

clear(): void
Clears the search box text and the suggestions.

Returns void
- Defined in packages/headless/src/controllers/insight/search-box/headless-insight-search-box.ts:50

selectSuggestion

selectSuggestion(value: string): void
Selects a suggestion and calls submit.
Parameters
- value: string
  The string value of the suggestion to select
Returns void
- Defined in packages/headless/src/controllers/insight/search-box/headless-insight-search-box.ts:62

showSuggestions

showSuggestions(): void
Shows the suggestions for the current search box value.

Returns void
- Defined in packages/headless/src/controllers/insight/search-box/headless-insight-search-box.ts:55

submit

submit(): void
Deselects all facets and triggers a search query.

Returns void
- Defined in packages/headless/src/controllers/insight/search-box/headless-insight-search-box.ts:67

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

updateText

updateText(value: string): void
Updates the search box text value and shows the suggestions for that value.
Parameters
- value: string
  The string value to update the search box with.
Returns void
- Defined in packages/headless/src/controllers/insight/search-box/headless-insight-search-box.ts:45

Properties

state

state: SearchBoxState

The state of the SearchBox controller.