Interface StandaloneSearchBox

The StandaloneSearchBox controller is responsible for handling a standalone search box.

interface StandaloneSearchBox {
    state: StandaloneSearchBoxState;
    afterRedirection(): void;
    clear(): void;
    selectSuggestion(value: string): void;
    showSuggestions(): void;
    submit(): void;
    subscribe(listener: () => void): Unsubscribe;
    updateRedirectUrl(url: string): void;
    updateText(value: string): void;
}

Hierarchy (View Summary)

SearchBox
- StandaloneSearchBox

Index

Methods

afterRedirection clear selectSuggestion showSuggestions submit subscribe updateRedirectUrl updateText

Properties

Methods

afterRedirection

afterRedirection(): void
Resets the standalone search box state. To be dispatched on single page applications after the redirection has been triggered.

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

clear

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

Returns void
Inherited from SearchBox.clear
- Defined in packages/headless/src/controllers/core/search-box/headless-core-search-box.ts:178

selectSuggestion

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

showSuggestions

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

Returns void
Inherited from SearchBox.showSuggestions
- Defined in packages/headless/src/controllers/core/search-box/headless-core-search-box.ts:183

submit

submit(): void
Triggers a redirection.

Returns void
Overrides SearchBox.submit
- Defined in packages/headless/src/controllers/commerce/standalone-search-box/headless-standalone-search-box.ts:46

subscribe

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 SearchBox.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

updateRedirectUrl

updateRedirectUrl(url: string): void
Updates the redirection url of the standalone search box.
Parameters
- url: string
  The new URL to redirect to.
Returns void
- Defined in packages/headless/src/controllers/commerce/standalone-search-box/headless-standalone-search-box.ts:51

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
Inherited from SearchBox.updateText
- Defined in packages/headless/src/controllers/core/search-box/headless-core-search-box.ts:173

Properties

state

state: StandaloneSearchBoxState

A scoped and simplified part of the headless state that is relevant to the StandaloneSearchBox controller.