Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Navigator: Split NaviagtorContainer from NavigatorProvider #46099

Closed
wants to merge 3 commits into from
Closed

Navigator: Split NaviagtorContainer from NavigatorProvider #46099

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b595e1
Split NaviagtorContainer from NavigatorProvider
noisysocks Nov 28, 2022
4fb51bd
Update rest of codebase to use NavigatorContainer
noisysocks Nov 28, 2022
9125ae9
Set className on NavigatorContainer
noisysocks Nov 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1055,6 +1055,12 @@
"markdown_source": "../packages/components/src/navigator/navigator-button/README.md",
"parent": "components"
},
{
"title": "NavigatorContainer",
"slug": "navigator-container",
"markdown_source": "../packages/components/src/navigator/navigator-container/README.md",
"parent": "components"
},
{
"title": "NavigatorProvider",
"slug": "navigator-provider",
Expand Down
83 changes: 44 additions & 39 deletions packages/block-editor/src/components/inserter/block-patterns-tab.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
__experimentalItem as Item,
__experimentalHStack as HStack,
__experimentalNavigatorProvider as NavigatorProvider,
__experimentalNavigatorContainer as NavigatorContainer,
__experimentalNavigatorScreen as NavigatorScreen,
__experimentalNavigatorButton as NavigatorButton,
__experimentalNavigatorBackButton as NavigatorBackButton,
Expand Down Expand Up @@ -252,47 +253,51 @@ function BlockPatternsTabNavigation( { onInsert, rootClientId } ) {

return (
<NavigatorProvider initialPath="/">
<NavigatorScreen path="/">
<ItemGroup>
{ categories.map( ( category ) => (
<NavigatorButton
key={ category.name }
path={ `/category/${ category.name }` }
as={ Item }
isAction
>
<HStack>
<FlexBlock>{ category.label }</FlexBlock>
<Icon
icon={
isRTL() ? chevronLeft : chevronRight
}
/>
</HStack>
</NavigatorButton>
) ) }
</ItemGroup>
</NavigatorScreen>
<NavigatorContainer>
<NavigatorScreen path="/">
<ItemGroup>
{ categories.map( ( category ) => (
<NavigatorButton
key={ category.name }
path={ `/category/${ category.name }` }
as={ Item }
isAction
>
<HStack>
<FlexBlock>{ category.label }</FlexBlock>
<Icon
icon={
isRTL() ? chevronLeft : chevronRight
}
/>
</HStack>
</NavigatorButton>
) ) }
</ItemGroup>
</NavigatorScreen>

{ categories.map( ( category ) => (
<NavigatorScreen
key={ category.name }
path={ `/category/${ category.name }` }
>
<NavigatorBackButton
icon={ isRTL() ? chevronRight : chevronLeft }
isSmall
aria-label={ __( 'Navigate to the categories list' ) }
{ categories.map( ( category ) => (
<NavigatorScreen
key={ category.name }
path={ `/category/${ category.name }` }
>
{ __( 'Back' ) }
</NavigatorBackButton>
<BlockPatternsCategoryPanel
category={ category }
rootClientId={ rootClientId }
onInsert={ onInsert }
/>
</NavigatorScreen>
) ) }
<NavigatorBackButton
icon={ isRTL() ? chevronRight : chevronLeft }
isSmall
aria-label={ __(
'Navigate to the categories list'
) }
>
{ __( 'Back' ) }
</NavigatorBackButton>
<BlockPatternsCategoryPanel
category={ category }
rootClientId={ rootClientId }
onInsert={ onInsert }
/>
</NavigatorScreen>
) ) }
</NavigatorContainer>
</NavigatorProvider>
);
}
Expand Down
85 changes: 45 additions & 40 deletions packages/block-editor/src/components/inserter/media-tab/media-tab.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
__experimentalItem as Item,
__experimentalHStack as HStack,
__experimentalNavigatorProvider as NavigatorProvider,
__experimentalNavigatorContainer as NavigatorContainer,
__experimentalNavigatorScreen as NavigatorScreen,
__experimentalNavigatorButton as NavigatorButton,
__experimentalNavigatorBackButton as NavigatorBackButton,
Expand Down Expand Up @@ -134,47 +135,51 @@ function MediaTab( {
function MediaTabNavigation( { onInsert, rootClientId, mediaCategories } ) {
return (
<NavigatorProvider initialPath="/">
<NavigatorScreen path="/">
<ItemGroup>
{ mediaCategories.map( ( category ) => (
<NavigatorButton
key={ category.name }
path={ `/category/${ category.name }` }
as={ Item }
isAction
>
<HStack>
<FlexBlock>{ category.label }</FlexBlock>
<Icon
icon={
isRTL() ? chevronLeft : chevronRight
}
/>
</HStack>
</NavigatorButton>
) ) }
</ItemGroup>
</NavigatorScreen>
{ mediaCategories.map( ( category ) => (
<NavigatorScreen
key={ category.name }
path={ `/category/${ category.name }` }
>
<NavigatorBackButton
className="rigatonious"
icon={ isRTL() ? chevronRight : chevronLeft }
isSmall
aria-label={ __( 'Navigate to the categories list' ) }
>
{ __( 'Back' ) }
</NavigatorBackButton>
<MediaCategoryPanel
rootClientId={ rootClientId }
onInsert={ onInsert }
category={ category }
/>
<NavigatorContainer>
<NavigatorScreen path="/">
<ItemGroup>
{ mediaCategories.map( ( category ) => (
<NavigatorButton
key={ category.name }
path={ `/category/${ category.name }` }
as={ Item }
isAction
>
<HStack>
<FlexBlock>{ category.label }</FlexBlock>
<Icon
icon={
isRTL() ? chevronLeft : chevronRight
}
/>
</HStack>
</NavigatorButton>
) ) }
</ItemGroup>
</NavigatorScreen>
) ) }
{ mediaCategories.map( ( category ) => (
<NavigatorScreen
key={ category.name }
path={ `/category/${ category.name }` }
>
<NavigatorBackButton
className="rigatonious"
icon={ isRTL() ? chevronRight : chevronLeft }
isSmall
aria-label={ __(
'Navigate to the categories list'
) }
>
{ __( 'Back' ) }
</NavigatorBackButton>
<MediaCategoryPanel
rootClientId={ rootClientId }
onInsert={ onInsert }
category={ category }
/>
</NavigatorScreen>
) ) }
</NavigatorContainer>
</NavigatorProvider>
);
}
Expand Down
4 changes: 4 additions & 0 deletions packages/components/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@

- NumberControl: refactor styles/tests/stories to TypeScript, replace fireEvent with user-event ([#45990](https://github.com/WordPress/gutenberg/pull/45990)).

### Experimental

- `Navigator`: `NavigatorScreen` components must now be placed in a `NavigatorCnotainer` component ([#XXX](https://github.com/WordPress/gutenberg/pull/XXX)).

## 22.1.0 (2022-11-16)

### Enhancements
Expand Down
1 change: 1 addition & 0 deletions packages/components/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ export { default as __experimentalNavigationItem } from './navigation/item';
export { default as __experimentalNavigationMenu } from './navigation/menu';
export {
NavigatorProvider as __experimentalNavigatorProvider,
NavigatorContainer as __experimentalNavigatorContainer,
NavigatorScreen as __experimentalNavigatorScreen,
NavigatorButton as __experimentalNavigatorButton,
NavigatorBackButton as __experimentalNavigatorBackButton,
Expand Down
1 change: 1 addition & 0 deletions packages/components/src/navigator/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export { NavigatorProvider } from './navigator-provider';
export { NavigatorContainer } from './navigator-container';
export { NavigatorScreen } from './navigator-screen';
export { NavigatorButton } from './navigator-button';
export { NavigatorBackButton } from './navigator-back-button';
Expand Down
2 changes: 1 addition & 1 deletion packages/components/src/navigator/navigator-back-button/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

The `NavigatorBackButton` component can be used to navigate to a screen and should be used in combination with the [`NavigatorProvider`](/packages/components/src/navigator/navigator-provider/README.md), the [`NavigatorScreen`](/packages/components/src/navigator/navigator-screen/README.md) and the [`NavigatorButton`](/packages/components/src/navigator/navigator-button/README.md) components (or the `useNavigator` hook).
The `NavigatorBackButton` component can be used to navigate to a screen and should be used in combination with the [`NavigatorProvider`](/packages/components/src/navigator/navigator-provider/README.md), the [`NavigatorContainer`](/packages/components/src/navigator/navigator-container/README.md), the [`NavigatorScreen`](/packages/components/src/navigator/navigator-screen/README.md) and the [`NavigatorButton`](/packages/components/src/navigator/navigator-button/README.md) components (or the `useNavigator` hook).

## Usage

Expand Down
30 changes: 17 additions & 13 deletions packages/components/src/navigator/navigator-back-button/component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,33 +23,37 @@ function UnconnectedNavigatorBackButton(
/**
* 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 (or the `useNavigator`
* `NavigatorContainer`, the `NavigatorScreen` and the `NavigatorButton`
* components (or the `useNavigator`
* hook).
*
* @example
* ```jsx
* import {
* __experimentalNavigatorProvider as NavigatorProvider,
* __experimentalNavigatorContainer as NavigatorContainer,
* __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>
* <NavigatorContainer>
* <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>
* <NavigatorScreen path="/child">
* <p>This is the child screen.</p>
* <NavigatorBackButton>
* Go back
* </NavigatorBackButton>
* </NavigatorScreen>
* </NavigatorContainer>
* </NavigatorProvider>
* );
* ```
Expand Down
2 changes: 1 addition & 1 deletion packages/components/src/navigator/navigator-button/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

The `NavigatorButton` component can be used to navigate to a screen and should be used in combination with the [`NavigatorProvider`](/packages/components/src/navigator/navigator-provider/README.md), the [`NavigatorScreen`](/packages/components/src/navigator/navigator-screen/README.md) and the [`NavigatorBackButton`](/packages/components/src/navigator/navigator-back-button/README.md) components (or the `useNavigator` hook).
The `NavigatorButton` component can be used to navigate to a screen and should be used in combination with the [`NavigatorProvider`](/packages/components/src/navigator/navigator-provider/README.md), the [`NavigatorContainer`](/packages/components/src/navigator/navigator-container/README.md), the [`NavigatorScreen`](/packages/components/src/navigator/navigator-screen/README.md) and the [`NavigatorBackButton`](/packages/components/src/navigator/navigator-back-button/README.md) components (or the `useNavigator` hook).

## Usage

Expand Down
34 changes: 19 additions & 15 deletions packages/components/src/navigator/navigator-button/component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,38 @@ function UnconnectedNavigatorButton(
}

/**
* 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 (or the `useNavigator` hook).
* The `NavigatorButton` component can be used to navigate to a screen and
* should be used in combination with the `NavigatorProvider`, the
* `NavigatorContainer`, the `NavigatorScreen` and the `NavigatorBackButton`
* components (or the `useNavigator` hook).
*
* @example
* ```jsx
* import {
* __experimentalNavigatorProvider as NavigatorProvider,
* __experimentalNavigatorContainer as NavigatorContainer,
* __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>
* <NavigatorContainer>
* <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>
* <NavigatorScreen path="/child">
* <p>This is the child screen.</p>
* <NavigatorBackButton>
* Go back
* </NavigatorBackButton>
* </NavigatorScreen>
* </NavigatorContainer>
* </NavigatorProvider>
* );
* ```
Expand Down
21 changes: 21 additions & 0 deletions packages/components/src/navigator/navigator-container/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# `NavigatorContainer`

<div class="callout callout-alert">
This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.
</div>

The `NavigatorContainer` component is a container for `NavigatorScreen` components to be placed in. It should be used in combination with the [`NavigatorProvider`](/packages/components/src/navigator/navigator-provider/README.md), the [`NavigatorContainer`](/packages/components/src/navigator/navigator-container/README.md), the [`NavigatorScreen`](/packages/components/src/navigator/navigator-screen/README.md) and the [`NavigatorBackButton`](/packages/components/src/navigator/navigator-back-button/README.md) components (or the `useNavigator` hook).

## Usage

Refer to [the `NavigatorProvider` component](/packages/components/src/navigator/navigator-provider/README.md#usage) for a usage example.

## Props

The component accepts the following props:

### `className`: `string`

Class name to add to the container element.

- Required: No
Loading