Skip to content

Commit

Permalink
Style Book: should persist when browsing global styles panels (#59261)
Browse files Browse the repository at this point in the history
* Ensures that the style book remains open when browsing around the global styles panel.
Adds exceptions for the revisions panel. If it's closed, the panel should close by returning to root.
E2E tests as well :)

* With the style book activated in global styles revisions, the style book should remain open when closing the revisions panel

* We don't need to set the current path

Co-authored-by: ramonjd <ramonopoly@git.wordpress.org>
Co-authored-by: andrewserong <andrewserong@git.wordpress.org>
Co-authored-by: annezazu <annezazu@git.wordpress.org>
  • Loading branch information
4 people authored Feb 23, 2024
1 parent 57470e9 commit 671fbf9
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,11 @@ function ScreenRevisions() {

const onCloseRevisions = () => {
goTo( '/' ); // Return to global styles main panel.
setEditorCanvasContainerView( undefined );
const canvasContainerView =
editorCanvasContainerView === 'global-styles-revisions:style-book'
? 'style-book'
: undefined;
setEditorCanvasContainerView( canvasContainerView );
};

const restoreRevision = ( revision ) => {
Expand All @@ -99,7 +103,6 @@ function ScreenRevisions() {
! editorCanvasContainerView.startsWith( 'global-styles-revisions' )
) {
goTo( '/' ); // Return to global styles main panel.
setEditorCanvasContainerView( editorCanvasContainerView );
}
}, [ editorCanvasContainerView ] );

Expand Down
28 changes: 26 additions & 2 deletions packages/edit-site/src/components/global-styles/ui.js
Original file line number Diff line number Diff line change
Expand Up @@ -230,12 +230,14 @@ function GlobalStylesBlockLink() {
}

function GlobalStylesEditorCanvasContainerLink() {
const { goTo } = useNavigator();
const { goTo, location } = useNavigator();
const editorCanvasContainerView = useSelect(
( select ) =>
unlock( select( editSiteStore ) ).getEditorCanvasContainerView(),
[]
);
const path = location?.path;
const isRevisionsOpen = path === '/revisions';

// If the user switches the editor canvas container view, redirect
// to the appropriate screen. This effectively allows deep linking to the
Expand All @@ -249,11 +251,33 @@ function GlobalStylesEditorCanvasContainerLink() {
case 'global-styles-css':
goTo( '/css' );
break;
case 'style-book':
/*
* The stand-alone style book is open
* and the revisions panel is open,
* close the revisions panel.
* Otherwise keep the style book open while
* browsing global styles panel.
*/
if ( isRevisionsOpen ) {
goTo( '/' );
}
break;
default:
/*
* Example: the user has navigated to "Browse styles" or elsewhere
* and changes the editorCanvasContainerView, e.g., closes the style book.
* The panel should not be affected.
* Exclude revisions panel from this behavior,
* as it should close when the editorCanvasContainerView doesn't correspond.
*/
if ( path !== '/' && ! isRevisionsOpen ) {
return;
}
goTo( '/' );
break;
}
}, [ editorCanvasContainerView, goTo ] );
}, [ editorCanvasContainerView, isRevisionsOpen, goTo ] );
}

function GlobalStylesUI() {
Expand Down
29 changes: 29 additions & 0 deletions test/e2e/specs/site-editor/style-book.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,35 @@ test.describe( 'Style Book', () => {
'should close when Escape key is pressed'
).toBeHidden();
} );

test( 'should persist when navigating the global styles sidebar', async ( {
page,
} ) => {
await page
.getByRole( 'region', { name: 'Editor settings' } )
.getByRole( 'button', { name: 'Browse styles' } )
.click();

const styleBookRegion = page.getByRole( 'region', {
name: 'Style Book',
} );
await expect(
styleBookRegion,
'style book should be visible'
).toBeVisible();

await page.click( 'role=button[name="Navigate to the previous view"]' );

await page
.getByRole( 'region', { name: 'Editor settings' } )
.getByRole( 'button', { name: 'Typography' } )
.click();

await expect(
styleBookRegion,
'style book should be visible'
).toBeVisible();
} );
} );

class StyleBook {
Expand Down
32 changes: 32 additions & 0 deletions test/e2e/specs/site-editor/user-global-styles-revisions.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,38 @@ test.describe( 'Style Revisions', () => {
).toBeHidden();
} );

test( 'should close revisions panel and leave style book open if activated', async ( {
page,
editor,
userGlobalStylesRevisions,
} ) => {
await editor.canvas.locator( 'body' ).click();
await userGlobalStylesRevisions.openStylesPanel();
const revisionsButton = page.getByRole( 'button', {
name: 'Revisions',
} );
const styleBookButton = page.getByRole( 'button', {
name: 'Style Book',
} );
await revisionsButton.click();
await styleBookButton.click();

await expect(
page.getByLabel( 'Global styles revisions list' )
).toBeVisible();

await page.click( 'role=button[name="Navigate to the previous view"]' );

await expect(
page.getByLabel( 'Global styles revisions list' )
).toBeHidden();

// The site editor canvas has been restored.
await expect(
page.locator( 'iframe[name="style-book-canvas"]' )
).toBeVisible();
} );

test( 'should paginate', async ( {
page,
editor,
Expand Down

1 comment on commit 671fbf9

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flaky tests detected in 671fbf9.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/8013783668
📝 Reported issues:

Please sign in to comment.