UNPKG

@wordpress/components

Version:
136 lines (135 loc) • 4.35 kB
"use strict"; Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } }); let __navigator_component_tsx = require("./navigator/component.cjs"); let __navigator_screen_component_tsx = require("./navigator-screen/component.cjs"); let __navigator_button_component_tsx = require("./navigator-button/component.cjs"); let __navigator_back_button_component_tsx = require("./navigator-back-button/component.cjs"); let __use_navigator_ts = require("./use-navigator.cjs"); // packages/components/src/navigator/index.tsx /** * The `Navigator` component allows rendering nested views/panels/menus * (via the `Navigator.Screen` component) and navigate between them * (via the `Navigator.Button` and `Navigator.BackButton` components). * * ```jsx * import { Navigator } from '@wordpress/components'; * * const MyNavigation = () => ( * <Navigator initialPath="/"> * <Navigator.Screen path="/"> * <p>This is the home screen.</p> * <Navigator.Button path="/child"> * Navigate to child screen. * </Navigator.Button> * </Navigator.Screen> * * <Navigator.Screen path="/child"> * <p>This is the child screen.</p> * <Navigator.BackButton> * Go back * </Navigator.BackButton> * </Navigator.Screen> * </Navigator> * ); * ``` */ const Navigator = Object.assign(__navigator_component_tsx.Navigator, { /** * The `Navigator.Screen` component represents a single view/screen/panel and * should be used in combination with the `Navigator`, the `Navigator.Button` * and the `Navigator.BackButton` components. * * @example * ```jsx * import { Navigator } from '@wordpress/components'; * * const MyNavigation = () => ( * <Navigator initialPath="/"> * <Navigator.Screen path="/"> * <p>This is the home screen.</p> * <Navigator.Button path="/child"> * Navigate to child screen. * </Navigator.Button> * </Navigator.Screen> * * <Navigator.Screen path="/child"> * <p>This is the child screen.</p> * <Navigator.BackButton> * Go back * </Navigator.BackButton> * </Navigator.Screen> * </Navigator> * ); * ``` */ Screen: Object.assign(__navigator_screen_component_tsx.NavigatorScreen, { displayName: "Navigator.Screen" }), /** * The `Navigator.Button` component can be used to navigate to a screen and * should be used in combination with the `Navigator`, the `Navigator.Screen` * and the `Navigator.BackButton` components. * * @example * ```jsx * import { Navigator } from '@wordpress/components'; * * const MyNavigation = () => ( * <Navigator initialPath="/"> * <Navigator.Screen path="/"> * <p>This is the home screen.</p> * <Navigator.Button path="/child"> * Navigate to child screen. * </Navigator.Button> * </Navigator.Screen> * * <Navigator.Screen path="/child"> * <p>This is the child screen.</p> * <Navigator.BackButton> * Go back * </Navigator.BackButton> * </Navigator.Screen> * </Navigator> * ); * ``` */ Button: Object.assign(__navigator_button_component_tsx.NavigatorButton, { displayName: "Navigator.Button" }), /** * The `Navigator.BackButton` component can be used to navigate to a screen and * should be used in combination with the `Navigator`, the `Navigator.Screen` * and the `Navigator.Button` components. * * @example * ```jsx * import { Navigator } from '@wordpress/components'; * * const MyNavigation = () => ( * <Navigator initialPath="/"> * <Navigator.Screen path="/"> * <p>This is the home screen.</p> * <Navigator.Button path="/child"> * Navigate to child screen. * </Navigator.Button> * </Navigator.Screen> * * <Navigator.Screen path="/child"> * <p>This is the child screen.</p> * <Navigator.BackButton> * Go back * </Navigator.BackButton> * </Navigator.Screen> * </Navigator> * ); * ``` */ BackButton: Object.assign(__navigator_back_button_component_tsx.NavigatorBackButton, { displayName: "Navigator.BackButton" }) }); exports.Navigator = Navigator; Object.defineProperty(exports, "useNavigator", { enumerable: true, get: function() { return __use_navigator_ts.useNavigator; } }); //# sourceMappingURL=index.cjs.map