UNPKG

@wordpress/components

Version:
152 lines (151 loc) • 5.35 kB
import { Navigator } from "./navigator/component.mjs"; import { NavigatorScreen as NavigatorScreen$1 } from "./navigator-screen/component.mjs"; import { NavigatorButton as NavigatorButton$1 } from "./navigator-button/component.mjs"; import { NavigatorBackButton as NavigatorBackButton$1 } from "./navigator-back-button/component.mjs"; import { NavigatorToParentButton as NavigatorToParentButton$1 } from "./navigator-to-parent-button/component.mjs"; import { useNavigator } from "./use-navigator.mjs"; // packages/components/src/navigator/legacy.ts /** * The `NavigatorProvider` component allows rendering nested views/panels/menus * (via the `NavigatorScreen` component and navigate between them * (via the `NavigatorButton` and `NavigatorBackButton` components). * * ```jsx * import { * __experimentalNavigatorProvider as NavigatorProvider, * __experimentalNavigatorScreen as NavigatorScreen, * __experimentalNavigatorButton as NavigatorButton, * __experimentalNavigatorBackButton as NavigatorBackButton, * } from '@wordpress/components'; * * const MyNavigation = () => ( * <NavigatorProvider initialPath="/"> * <NavigatorScreen path="/"> * <p>This is the home screen.</p> * <NavigatorButton path="/child"> * Navigate to child screen. * </NavigatorButton> * </NavigatorScreen> * * <NavigatorScreen path="/child"> * <p>This is the child screen.</p> * <NavigatorBackButton> * Go back * </NavigatorBackButton> * </NavigatorScreen> * </NavigatorProvider> * ); * ``` */ const NavigatorProvider = Object.assign(Navigator, { displayName: "NavigatorProvider" }); /** * The `NavigatorScreen` component represents a single view/screen/panel and * should be used in combination with the `NavigatorProvider`, the * `NavigatorButton` and the `NavigatorBackButton` components. * * @example * ```jsx * import { * __experimentalNavigatorProvider as NavigatorProvider, * __experimentalNavigatorScreen as NavigatorScreen, * __experimentalNavigatorButton as NavigatorButton, * __experimentalNavigatorBackButton as NavigatorBackButton, * } from '@wordpress/components'; * * const MyNavigation = () => ( * <NavigatorProvider initialPath="/"> * <NavigatorScreen path="/"> * <p>This is the home screen.</p> * <NavigatorButton path="/child"> * Navigate to child screen. * </NavigatorButton> * </NavigatorScreen> * * <NavigatorScreen path="/child"> * <p>This is the child screen.</p> * <NavigatorBackButton> * Go back * </NavigatorBackButton> * </NavigatorScreen> * </NavigatorProvider> * ); * ``` */ const NavigatorScreen = Object.assign(NavigatorScreen$1, { displayName: "NavigatorScreen" }); /** * The `NavigatorButton` component can be used to navigate to a screen and should * be used in combination with the `NavigatorProvider`, the `NavigatorScreen` * and the `NavigatorBackButton` components. * * @example * ```jsx * import { * __experimentalNavigatorProvider as NavigatorProvider, * __experimentalNavigatorScreen as NavigatorScreen, * __experimentalNavigatorButton as NavigatorButton, * __experimentalNavigatorBackButton as NavigatorBackButton, * } from '@wordpress/components'; * * const MyNavigation = () => ( * <NavigatorProvider initialPath="/"> * <NavigatorScreen path="/"> * <p>This is the home screen.</p> * <NavigatorButton path="/child"> * Navigate to child screen. * </NavigatorButton> * </NavigatorScreen> * * <NavigatorScreen path="/child"> * <p>This is the child screen.</p> * <NavigatorBackButton> * Go back * </NavigatorBackButton> * </NavigatorScreen> * </NavigatorProvider> * ); * ``` */ const NavigatorButton = Object.assign(NavigatorButton$1, { displayName: "NavigatorButton" }); /** * The `NavigatorBackButton` component can be used to navigate to a screen and * should be used in combination with the `NavigatorProvider`, the * `NavigatorScreen` and the `NavigatorButton` components. * * @example * ```jsx * import { * __experimentalNavigatorProvider as NavigatorProvider, * __experimentalNavigatorScreen as NavigatorScreen, * __experimentalNavigatorButton as NavigatorButton, * __experimentalNavigatorBackButton as NavigatorBackButton, * } from '@wordpress/components'; * * const MyNavigation = () => ( * <NavigatorProvider initialPath="/"> * <NavigatorScreen path="/"> * <p>This is the home screen.</p> * <NavigatorButton path="/child"> * Navigate to child screen. * </NavigatorButton> * </NavigatorScreen> * * <NavigatorScreen path="/child"> * <p>This is the child screen.</p> * <NavigatorBackButton> * Go back (to parent) * </NavigatorBackButton> * </NavigatorScreen> * </NavigatorProvider> * ); * ``` */ const NavigatorBackButton = Object.assign(NavigatorBackButton$1, { displayName: "NavigatorBackButton" }); /** * _Note: this component is deprecated. Please use the `NavigatorBackButton` * component instead._ * * @deprecated */ const NavigatorToParentButton = Object.assign(NavigatorToParentButton$1, { displayName: "NavigatorToParentButton" }); export { NavigatorBackButton, NavigatorButton, NavigatorProvider, NavigatorScreen, NavigatorToParentButton, useNavigator }; //# sourceMappingURL=legacy.mjs.map