UNPKG

@shopify/app-bridge-host

Version:

App Bridge Host contains components and middleware to be consumed by the app's host, as well as the host itself. The middleware and `Frame` component are responsible for facilitating communication between the client and host, and used to act on actions se

28 lines (27 loc) 1.14 kB
import type { Location, Navigate } from '@shopify/app-bridge-core/actions/Navigation/Redirect'; import type { FeatureWithRouterApi } from '../../../../withFeature'; import type { NavigationActionCreatorsMap, NavigationStore } from '../..'; import reducer, { defaultNavigationStore } from './reducer'; /** Remote UI doesn't support passing an `URL` through so this is * more limited than the App Bridge Client useNavigate interface */ export type To = Location | string; export interface WithFeature { actions: NavigationActionCreatorsMap; store: NavigationStore; api: { navigate: Navigate<To>; }; } /** * An object containing the key, actions, initial state and reducer of the Navigation feature * Can be used with the `withFeature` decorator to add the reducer * and then make its actions and store available to the wrapped component * @public * */ export declare const feature: FeatureWithRouterApi<WithFeature['store'], WithFeature['actions'], WithFeature['api']>; export default reducer; export * from './actionCreators'; export * from './actions'; export * from './types'; export { defaultNavigationStore };