Skip to content

Commit

Permalink
Change index.ts extension to tsx to allow Storybook to extract JSDocs…
Browse files Browse the repository at this point in the history
… better, remove duplicate JSDocs
  • Loading branch information
ciampo committed Aug 21, 2024
1 parent 1aaedd7 commit 85471a9
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 28 deletions.
File renamed without changes.
28 changes: 0 additions & 28 deletions packages/components/src/navigator/navigator/component.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -272,32 +272,4 @@ function UnconnectedNavigator(
);
}

/**
* The `Navigator` component allows rendering nested views/panels/menus
* (via the `Navigator.Screen` component) and navigate between these different
* view (via the `Navigator.Button` and `Navigator.BackButton` components or the
* `useNavigator` hook).
*
* ```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>
* );
* ```
*/
export const Navigator = contextConnect( UnconnectedNavigator, 'Navigator' );

0 comments on commit 85471a9

Please sign in to comment.