A rendered search result that has been actioned by a user.
A search result that can be rendered by a Workspace component.
Union type that includes Home's built in search result actions.
Representation of a search response from a specific invocation of a HomeProvider's onUserInput listener function.
Can optionally be used to push search results to the Home UI.
function onUserInput(req: HomeSearchListenerRequest, res: HomeSearchListenerResponse) {
searchListenerResponse.open();
const myLongRunningQuery = makeMyLongRunningQuery(searchListenerRequest.query);
myLongRunningQuery.onNewResults(myNewResults => {
searchListenerResponse.respond(myNewResults);
});
searchListenerRequest.onClose(() => {
myLongRunningQuery.close();
});
}
A search result that can be rendered by Home UI.
A listener called when a search result generated by this provider is dispatched.
searchTopic.dispatch("My Provider Name", searchResult, "My Action");
The order to sort scored search results in.
Render an item in the navigation bar of Storefront with a description and image.
Render an item in the navigation bar of Storefront.
The options to build your custom template composition layout.
A function that listens for search requests on a search topic. Returns a set of search results based on arguments provided.
The search request coming in
EXPERIMENTAL - streaming response
Namespace for Home integrations.
Namespace for Legacy integrations.
Namespace for Storefront integrations.
Generated using TypeDoc
Each action is defined by its title and a hotkey