Interface StandaloneSearchBoxSetActionCreators

The commerce standalone search box set action creators.

interface StandaloneSearchBoxSetActionCreators {
    fetchRedirectUrl(
        payload: FetchRedirectUrlPayload,
    ): AsyncThunkAction<
        string,
        FetchRedirectUrlPayload,
        AsyncThunkCommerceOptions<StateNeededForRedirect>,
    >;
    registerStandaloneSearchBox(
        payload: RegisterStandaloneSearchBoxPayload,
    ): { payload: RegisterStandaloneSearchBoxPayload; type: string };
    resetStandaloneSearchBox(
        payload: ResetStandaloneSearchBoxPayload,
    ): { payload: ResetStandaloneSearchBoxPayload; type: string };
    updateStandaloneSearchBoxRedirectionUrl(
        payload: RegisterStandaloneSearchBoxPayload,
    ): { payload: RegisterStandaloneSearchBoxPayload; type: string };
}

Index

Methods

fetchRedirectUrl registerStandaloneSearchBox resetStandaloneSearchBox updateStandaloneSearchBoxRedirectionUrl

Methods

fetchRedirectUrl

fetchRedirectUrl(
    payload: FetchRedirectUrlPayload,
): AsyncThunkAction<
    string,
    FetchRedirectUrlPayload,
    AsyncThunkCommerceOptions<StateNeededForRedirect>,
>
Preprocesses the query for the current headless state, and retrieves a redirection URL if a redirect trigger was fired in the query pipeline.
Parameters
- payload: FetchRedirectUrlPayload
  The action creator payload.
Returns AsyncThunkAction<
    string,
    FetchRedirectUrlPayload,
    AsyncThunkCommerceOptions<StateNeededForRedirect>,
>
A dispatchable action.
- Defined in packages/headless/src/features/commerce/standalone-search-box-set/standalone-search-box-set-actions-loader.ts:35

registerStandaloneSearchBox

registerStandaloneSearchBox(
payload: RegisterStandaloneSearchBoxPayload,
): { payload: RegisterStandaloneSearchBoxPayload; type: string }
Registers a standalone search box.
Parameters
- payload: RegisterStandaloneSearchBoxPayload
  The action creator payload.
Returns { payload: RegisterStandaloneSearchBoxPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/standalone-search-box-set/standalone-search-box-set-actions-loader.ts:49

resetStandaloneSearchBox

resetStandaloneSearchBox(
payload: ResetStandaloneSearchBoxPayload,
): { payload: ResetStandaloneSearchBoxPayload; type: string }
Resets the standalone search box state. To be dispatched on single page applications after the redirection has been triggered.
Parameters
- payload: ResetStandaloneSearchBoxPayload
  The action creator payload.
Returns { payload: ResetStandaloneSearchBoxPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/standalone-search-box-set/standalone-search-box-set-actions-loader.ts:59

updateStandaloneSearchBoxRedirectionUrl

updateStandaloneSearchBoxRedirectionUrl(
payload: RegisterStandaloneSearchBoxPayload,
): { payload: RegisterStandaloneSearchBoxPayload; type: string }
Updates the redirection URL of the standalone search box.
Parameters
- payload: RegisterStandaloneSearchBoxPayload
  The action creator payload.
Returns { payload: RegisterStandaloneSearchBoxPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/standalone-search-box-set/standalone-search-box-set-actions-loader.ts:68

Interface StandaloneSearchBoxSetActionCreators

Index

Methods

Methods

fetchRedirectUrl

Parameters

Returns AsyncThunkAction<
    string,
    FetchRedirectUrlPayload,
    AsyncThunkCommerceOptions<StateNeededForRedirect>,
>

registerStandaloneSearchBox

Parameters

Returns { payload: RegisterStandaloneSearchBoxPayload; type: string }

resetStandaloneSearchBox

Parameters

Returns { payload: ResetStandaloneSearchBoxPayload; type: string }

updateStandaloneSearchBoxRedirectionUrl

Parameters

Returns { payload: RegisterStandaloneSearchBoxPayload; type: string }

Settings

On This Page

Interface StandaloneSearchBoxSetActionCreators

Index

Methods

Methods

fetchRedirectUrl

Parameters

Returns AsyncThunkAction< string, FetchRedirectUrlPayload, AsyncThunkCommerceOptions<StateNeededForRedirect>,>

registerStandaloneSearchBox

Parameters

Returns { payload: RegisterStandaloneSearchBoxPayload; type: string }

resetStandaloneSearchBox

Parameters

Returns { payload: ResetStandaloneSearchBoxPayload; type: string }

updateStandaloneSearchBoxRedirectionUrl

Parameters

Returns { payload: RegisterStandaloneSearchBoxPayload; type: string }

Settings

On This Page

Returns AsyncThunkAction<
string,
FetchRedirectUrlPayload,
AsyncThunkCommerceOptions<StateNeededForRedirect>,
>