UNPKG

@wordpress/components

Version:
179 lines (173 loc) 5.77 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.NavigatorToParentButton = exports.NavigatorScreen = exports.NavigatorProvider = exports.NavigatorButton = exports.NavigatorBackButton = void 0; Object.defineProperty(exports, "useNavigator", { enumerable: true, get: function () { return _useNavigator.useNavigator; } }); var _component = require("./navigator/component"); var _component2 = require("./navigator-screen/component"); var _component3 = require("./navigator-button/component"); var _component4 = require("./navigator-back-button/component"); var _component5 = require("./navigator-to-parent-button/component"); var _useNavigator = require("./use-navigator"); /** * Internal dependencies */ /** * 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 = exports.NavigatorProvider = Object.assign(_component.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 = exports.NavigatorScreen = Object.assign(_component2.NavigatorScreen, { 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 = exports.NavigatorButton = Object.assign(_component3.NavigatorButton, { 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 = exports.NavigatorBackButton = Object.assign(_component4.NavigatorBackButton, { displayName: 'NavigatorBackButton' }); /** * _Note: this component is deprecated. Please use the `NavigatorBackButton` * component instead._ * * @deprecated */ const NavigatorToParentButton = exports.NavigatorToParentButton = Object.assign(_component5.NavigatorToParentButton, { displayName: 'NavigatorToParentButton' }); //# sourceMappingURL=legacy.js.map