Repository navigation
feat: AppLayout visual changes #5325
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
d1dcf97
4a71d8b
fe70562
52fa7ef
d7214c0
fcd994b
2840454
d28d256
7917bdd
40ab1cb
1f1ddc2
b598c0d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| import { BasePageObject } from '@cloudscape-design/browser-test-tools/page-objects'; | ||
| import useBrowser from '@cloudscape-design/browser-test-tools/use-browser'; | ||
|
|
||
| import createWrapper from '../../../lib/components/test-utils/selectors'; | ||
| import { getUrlParams } from './utils'; | ||
|
|
||
| const appLayout = createWrapper().findAppLayout(); | ||
| const toolbar = appLayout.findToolbar(); | ||
| const appLayoutBreadcrumbs = appLayout.findBreadcrumbs().findBreadcrumbGroup(); | ||
| const consumerBreadcrumbs = createWrapper().find('[data-testid="global-nav-header"]').findBreadcrumbGroup(); | ||
|
|
||
| class HideToolbarPage extends BasePageObject { | ||
| clickTestId(testId: string) { | ||
| return this.click(`[data-testid="${testId}"]`); | ||
| } | ||
|
|
||
| /** | ||
| * Distance from the top of App Layout to the first header of the page content. | ||
| * The content region itself is `display: contents` and has no box to measure. | ||
| */ | ||
| async getContentOffset() { | ||
| const { top: rootTop } = await this.getBoundingBox(appLayout.toSelector()); | ||
| const { top: contentTop } = await this.getBoundingBox(appLayout.findContentRegion().findHeader().toSelector()); | ||
| return contentTop - rootTop; | ||
| } | ||
| } | ||
|
|
||
| function setupTest(params: Record<string, string>, testFn: (page: HideToolbarPage) => Promise<void>) { | ||
| return useBrowser(async browser => { | ||
| const page = new HideToolbarPage(browser); | ||
| await browser.url(`#/app-layout/global-nav-breadcrumbs?${getUrlParams('refresh-toolbar', params)}`); | ||
| await page.waitForVisible(appLayout.findContentRegion().toSelector()); | ||
| await testFn(page); | ||
| }); | ||
| } | ||
|
|
||
| const hiddenToolbarParams = { appLayoutHideToolbar: 'true' }; | ||
|
|
||
| describe('appLayoutHideToolbar flag', () => { | ||
| test( | ||
| 'renders a visible toolbar without the flag', | ||
| setupTest({}, async page => { | ||
| await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(true); | ||
| await expect(page.isDisplayed(appLayoutBreadcrumbs.toSelector())).resolves.toBe(true); | ||
| }) | ||
| ); | ||
|
|
||
| test( | ||
| 'keeps the toolbar and its breadcrumbs in the DOM but not displayed', | ||
| setupTest(hiddenToolbarParams, async page => { | ||
| await expect(page.isExisting(toolbar.toSelector())).resolves.toBe(true); | ||
| await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(false); | ||
| await expect(page.isExisting(appLayoutBreadcrumbs.toSelector())).resolves.toBe(true); | ||
| await expect(page.isDisplayed(appLayoutBreadcrumbs.toSelector())).resolves.toBe(false); | ||
| }) | ||
| ); | ||
|
|
||
| // Global flags are read once on page load, so each toolbar state is measured in its own browser session | ||
| // instead of switching the URL (and relying on a reload) within one session. | ||
| test('does not reserve space for the hidden toolbar', async () => { | ||
| let toolbarHeight = 0; | ||
| let offsetWithToolbar = 0; | ||
| let offsetWithHiddenToolbar = 0; | ||
|
|
||
| await setupTest({}, async page => { | ||
| await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(true); | ||
| ({ height: toolbarHeight } = await page.getBoundingBox(toolbar.toSelector())); | ||
| offsetWithToolbar = await page.getContentOffset(); | ||
| })(); | ||
|
|
||
| await setupTest(hiddenToolbarParams, async page => { | ||
| await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(false); | ||
| offsetWithHiddenToolbar = await page.getContentOffset(); | ||
| })(); | ||
|
|
||
| expect(toolbarHeight).toBeGreaterThan(0); | ||
| // allow 1px for sub-pixel rounding | ||
| expect(Math.abs(offsetWithToolbar - toolbarHeight - offsetWithHiddenToolbar)).toBeLessThanOrEqual(1); | ||
| }); | ||
|
|
||
| test( | ||
| 'publishes breadcrumbs to registerBreadcrumbsConsumer and keeps them updated', | ||
| setupTest(hiddenToolbarParams, async page => { | ||
| await page.clickTestId('toggle-nav-header'); | ||
| await page.waitForVisible(consumerBreadcrumbs.toSelector()); | ||
| await expect(page.getText(consumerBreadcrumbs.toSelector())).resolves.toContain('Resource'); | ||
| await expect(page.getText(consumerBreadcrumbs.toSelector())).resolves.not.toContain('Level 3'); | ||
|
|
||
| await page.clickTestId('append-breadcrumb'); | ||
| await page.waitForAssertion(() => | ||
| expect(page.getText(consumerBreadcrumbs.toSelector())).resolves.toContain('Level 3') | ||
| ); | ||
| await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(false); | ||
| }) | ||
| ); | ||
|
|
||
| test( | ||
| 'publishes breadcrumbs to a consumer that registers after App Layout rendered', | ||
| setupTest(hiddenToolbarParams, async page => { | ||
| await page.clickTestId('delay-nav-header'); | ||
| await page.waitForVisible(consumerBreadcrumbs.toSelector()); | ||
| await expect(page.getText(consumerBreadcrumbs.toSelector())).resolves.toContain('Resource'); | ||
| }) | ||
| ); | ||
| }); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| import React from 'react'; | ||
| import { cleanup, render, waitFor } from '@testing-library/react'; | ||
|
|
||
| import AppLayout from '../../../lib/components/app-layout'; | ||
| import { isAppLayoutHideToolbar } from '../../../lib/components/app-layout/utils/feature-flags'; | ||
| import BreadcrumbGroup, { BreadcrumbGroupProps } from '../../../lib/components/breadcrumb-group'; | ||
| import { clearInitialMessages } from '../../../lib/components/internal/plugins/widget/core'; | ||
| import * as widgetPlugins from '../../../lib/components/plugins'; | ||
| import { describeEachAppLayout, renderComponent, setPendingGlobalFlag } from './utils'; | ||
|
|
||
| import skeletonStyles from '../../../lib/components/app-layout/visual-refresh-toolbar/skeleton/styles.css.js'; | ||
| import toolbarStyles from '../../../lib/components/app-layout/visual-refresh-toolbar/toolbar/styles.css.js'; | ||
|
|
||
| const breadcrumbItems: BreadcrumbGroupProps['items'] = [ | ||
| { text: 'Home', href: '/home' }, | ||
| { text: 'Resource', href: '/resource' }, | ||
| ]; | ||
|
|
||
| function isToolbarHidden(toolbar: HTMLElement) { | ||
| return toolbar.classList.contains(toolbarStyles['toolbar-hidden']); | ||
| } | ||
|
|
||
| afterEach(() => setPendingGlobalFlag('appLayoutHideToolbar', undefined)); | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll replace |
||
|
|
||
| describe('isAppLayoutHideToolbar', () => { | ||
| test('returns false when the flag is not set', () => { | ||
| expect(isAppLayoutHideToolbar()).toBe(false); | ||
| }); | ||
|
|
||
| test('returns false when the flag is false', () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', false); | ||
| expect(isAppLayoutHideToolbar()).toBe(false); | ||
| }); | ||
|
|
||
| test('returns true when the flag is true', () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| expect(isAppLayoutHideToolbar()).toBe(true); | ||
| }); | ||
| }); | ||
|
|
||
| describeEachAppLayout({ themes: ['refresh-toolbar'] }, () => { | ||
| test('renders a visible toolbar when the flag is not set', () => { | ||
| const { wrapper } = renderComponent(<AppLayout navigation="nav" />); | ||
| expect(wrapper.findToolbar()).toBeTruthy(); | ||
| expect(isToolbarHidden(wrapper.findToolbar()!.getElement())).toBe(false); | ||
| }); | ||
|
|
||
| test('keeps the toolbar mounted but hidden when the flag is set', () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| const { wrapper } = renderComponent(<AppLayout navigation="nav" tools="tools" />); | ||
| expect(wrapper.findToolbar()).toBeTruthy(); | ||
| expect(isToolbarHidden(wrapper.findToolbar()!.getElement())).toBe(true); | ||
| // toggles are rendered inside the hidden toolbar | ||
| expect(wrapper.findToolbar()!.getElement()).toContainElement(wrapper.findNavigationToggle()!.getElement()); | ||
| expect(wrapper.findToolbar()!.getElement()).toContainElement(wrapper.findToolsToggle()!.getElement()); | ||
| }); | ||
|
|
||
| test('renders a top border for the content area in place of the hidden toolbar', () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| const { wrapper } = renderComponent(<AppLayout navigation="nav" />); | ||
| const toolbar = wrapper.findToolbar()!.getElement(); | ||
| const border = toolbar.nextElementSibling; | ||
| expect(border).toHaveClass(skeletonStyles['hidden-toolbar-border']); | ||
| expect(wrapper.findAllByClassName(skeletonStyles['hidden-toolbar-border'])).toHaveLength(1); | ||
| }); | ||
|
|
||
| test('does not render the content area top border when the flag is not set', () => { | ||
| const { wrapper } = renderComponent(<AppLayout navigation="nav" />); | ||
| expect(wrapper.findByClassName(skeletonStyles['hidden-toolbar-border'])).toBeNull(); | ||
| }); | ||
|
|
||
| test('keeps rendering breadcrumbs inside the hidden toolbar', () => { | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The purpose is the same - make sure that global breadcrumbs keep working when the toolbar is hidden |
||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| const { wrapper } = renderComponent(<AppLayout breadcrumbs={<BreadcrumbGroup items={breadcrumbItems} />} />); | ||
| const breadcrumbs = wrapper.findBreadcrumbs()!.findBreadcrumbGroup()!; | ||
| expect(breadcrumbs.findBreadcrumbLinks().map(link => link.getElement().textContent)).toEqual(['Home', 'Resource']); | ||
| expect(wrapper.findToolbar()!.getElement()).toContainElement(breadcrumbs.getElement()); | ||
| }); | ||
|
|
||
| test('keeps rendering the content and open navigation when the flag is set', () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| const { wrapper } = renderComponent( | ||
| <AppLayout navigation="nav" navigationOpen={true} onNavigationChange={() => {}} content="main content" /> | ||
| ); | ||
| expect(isToolbarHidden(wrapper.findToolbar()!.getElement())).toBe(true); | ||
| expect(wrapper.findContentRegion().getElement()).toHaveTextContent('main content'); | ||
| expect(wrapper.findNavigation().getElement()).toHaveTextContent('nav'); | ||
| }); | ||
|
|
||
| test('keeps rendering an open tools drawer when the flag is set', () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| const { wrapper } = renderComponent(<AppLayout tools="tools content" toolsOpen={true} onToolsChange={() => {}} />); | ||
| expect(isToolbarHidden(wrapper.findToolbar()!.getElement())).toBe(true); | ||
| expect(wrapper.findTools().getElement()).toHaveTextContent('tools content'); | ||
| }); | ||
| }); | ||
|
|
||
| describeEachAppLayout({ themes: ['refresh-toolbar'], sizes: ['desktop'] }, () => { | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I also considered moving these tests to this file: https://github.com/cloudscape-design/components/blob/main/src/app-layout/__tests__/runtime-breadcrumbs-widgetized.test.tsx but decided to keep them here since they help prevent regressions related to this feature |
||
| beforeEach(() => clearInitialMessages()); | ||
| afterEach(() => { | ||
| cleanup(); | ||
| clearInitialMessages(); | ||
| }); | ||
|
|
||
| test('reports breadcrumbs to registerBreadcrumbsConsumer when the flag is set', async () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| const onBreadcrumbsChange = jest.fn(); | ||
| const registration = widgetPlugins.registerBreadcrumbsConsumer({ onBreadcrumbsChange }); | ||
| const onFollow = jest.fn(); | ||
|
|
||
| render(<AppLayout breadcrumbs={<BreadcrumbGroup items={breadcrumbItems} onFollow={onFollow} />} />); | ||
|
|
||
| await waitFor(() => | ||
| expect(onBreadcrumbsChange).toHaveBeenLastCalledWith( | ||
| expect.objectContaining({ items: breadcrumbItems, onFollow }) | ||
| ) | ||
| ); | ||
| registration.unregister(); | ||
| }); | ||
|
|
||
| test('reports breadcrumb updates to registerBreadcrumbsConsumer when the flag is set', async () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| const onBreadcrumbsChange = jest.fn(); | ||
| const registration = widgetPlugins.registerBreadcrumbsConsumer({ onBreadcrumbsChange }); | ||
|
|
||
| const { rerender } = render(<AppLayout breadcrumbs={<BreadcrumbGroup items={breadcrumbItems} />} />); | ||
| await waitFor(() => | ||
| expect(onBreadcrumbsChange).toHaveBeenLastCalledWith(expect.objectContaining({ items: breadcrumbItems })) | ||
| ); | ||
|
|
||
| const updatedItems = [...breadcrumbItems, { text: 'Details', href: '/details' }]; | ||
| rerender(<AppLayout breadcrumbs={<BreadcrumbGroup items={updatedItems} />} />); | ||
| await waitFor(() => | ||
| expect(onBreadcrumbsChange).toHaveBeenLastCalledWith(expect.objectContaining({ items: updatedItems })) | ||
| ); | ||
| registration.unregister(); | ||
| }); | ||
| }); | ||
|
|
||
| describeEachAppLayout({ themes: ['classic', 'refresh'] }, () => { | ||
| test('does not affect non-toolbar designs', () => { | ||
| setPendingGlobalFlag('appLayoutHideToolbar', true); | ||
| const { wrapper } = renderComponent(<AppLayout navigation="nav" content="main content" />); | ||
| expect(wrapper.findNavigation().getElement()).toHaveTextContent('nav'); | ||
| expect(wrapper.findContentRegion().getElement()).toHaveTextContent('main content'); | ||
| }); | ||
| }); | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The connection between the
registerBreadcrumbsConsumerand hidden toolbar is that the breadcrumbs that are rendered within the toolbar produce events with breadcrumbs items which a higher level than AppLayout (details in DM) consume and render breadcrumbs in a different place. The purpose of this and further tests is to make sure this mechanism isn't broken