-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Prevent scrollbar from overlapping side navigation content (#3002)
- Loading branch information
Showing
5 changed files
with
183 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
// SPDX-License-Identifier: Apache-2.0 | ||
import React from 'react'; | ||
|
||
import AppLayout from '~components/app-layout'; | ||
import Select from '~components/select'; | ||
import SideNavigation, { SideNavigationProps } from '~components/side-navigation'; | ||
|
||
import labels from './utils/labels'; | ||
|
||
const items: SideNavigationProps.Item[] = new Array(50).fill(null).map((_, index) => ({ | ||
type: 'link', | ||
text: `Link to page ${index + 1} with long enough text to wrap`, | ||
href: '#', | ||
})); | ||
|
||
const itemsControl = ( | ||
<Select | ||
options={[ | ||
{ value: 'option1', label: 'Option 1' }, | ||
{ value: 'option2', label: 'Option 2' }, | ||
]} | ||
selectedOption={{ value: 'option1', label: 'Option 1' }} | ||
onChange={() => null} | ||
/> | ||
); | ||
|
||
export default function SideNavigationPage() { | ||
const [open, setOpen] = React.useState(true); | ||
|
||
return ( | ||
<AppLayout | ||
navigationOpen={open} | ||
onNavigationChange={({ detail }) => { | ||
setOpen(detail.open); | ||
}} | ||
ariaLabels={labels} | ||
navigation={ | ||
<SideNavigation | ||
header={{ | ||
href: '#/', | ||
text: 'Header title', | ||
}} | ||
items={items} | ||
itemsControl={itemsControl} | ||
/> | ||
} | ||
content={ | ||
<> | ||
<h1>App Layout with scrollable Side navigation</h1> | ||
</> | ||
} | ||
/> | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
// SPDX-License-Identifier: Apache-2.0 | ||
import useBrowser from '@cloudscape-design/browser-test-tools/use-browser'; | ||
|
||
// Workaround until scrollbars are generally shown in tests (AWSUI-59983) | ||
|
||
interface TestFunction { | ||
(browser: WebdriverIO.Browser): Promise<void> | void; | ||
} | ||
|
||
const options = { | ||
capabilities: { | ||
'goog:chromeOptions': { | ||
args: [ | ||
// Same array as in | ||
// https://github.com/cloudscape-design/browser-test-tools/blob/4aaed9e410b13e05a7d5dbace17231776d250b97/src/browsers/capabilities.ts | ||
// but without --hide-scrollbar. | ||
'--disable-background-timer-throttling', | ||
'--disable-breakpad', | ||
'--disable-client-side-phishing-detection', | ||
'--disable-cloud-import', | ||
'--disable-default-apps', | ||
'--disable-dev-shm-usage', | ||
'--disable-extensions', | ||
'--disable-gesture-typing', | ||
'--disable-hang-monitor', | ||
'--disable-infobars', | ||
'--disable-notifications', | ||
'--disable-offer-store-unmasked-wallet-cards', | ||
'--disable-offer-upload-credit-cards', | ||
'--disable-popup-blocking', | ||
'--disable-print-preview', | ||
'--disable-prompt-on-repost', | ||
'--disable-setuid-sandbox', | ||
'--disable-speech-api', | ||
'--disable-sync', | ||
'--disable-tab-for-desktop-share', | ||
'--disable-translate', | ||
'--disable-voice-input', | ||
'--disable-wake-on-wifi', | ||
'--disk-cache-size=33554432', | ||
'--enable-async-dns', | ||
'--enable-simple-cache-backend', | ||
'--enable-tcp-fast-open', | ||
'--enable-webgl', | ||
'--ignore-gpu-blacklist', | ||
'--media-cache-size=33554432', | ||
'--metrics-recording-only', | ||
'--mute-audio', | ||
'--no-default-browser-check', | ||
'--no-first-run', | ||
'--no-pings', | ||
'--no-zygote', | ||
'--password-store=basic', | ||
'--prerender-from-omnibox=disabled', | ||
'--no-sandbox', | ||
'--disable-gpu', | ||
'--headless=new', | ||
], | ||
}, | ||
}, | ||
}; | ||
|
||
export default function (testFn: TestFunction): () => Promise<void> { | ||
return useBrowser(options, testFn); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
// 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 createWrapper from '../../../lib/components/test-utils/selectors'; | ||
import useBrowserWithScrollbars from '../../__integ__/use-browser-with-scrollbars'; | ||
import { getUrlParams, Theme } from './utils'; | ||
|
||
const wrapper = createWrapper().findAppLayout().findNavigation(); | ||
|
||
function setupTest(testFn: (page: BasePageObject) => Promise<void>, theme: Theme) { | ||
return useBrowserWithScrollbars(async browser => { | ||
const page = new BasePageObject(browser); | ||
const params = getUrlParams(theme); | ||
await browser.url(`#/light/app-layout/navigation-with-scrollbar?${params}`); | ||
await page.waitForVisible(createWrapper().findSideNavigation().toSelector()); | ||
await testFn(page); | ||
})(); | ||
} | ||
|
||
describe('Navigation slot', () => { | ||
describe('has expected inline size when a scrollbar is present', () => { | ||
test.each(['classic', 'refresh-toolbar'] as const)('%s', theme => | ||
setupTest(async page => { | ||
const { width } = await page.getBoundingBox(wrapper.toSelector()); | ||
expect(width).toBe(280); | ||
const navigation = wrapper.findSideNavigation(); | ||
const navigationWidth = (await page.getBoundingBox(navigation.toSelector())).width; | ||
expect(navigationWidth).toBeLessThan(280); | ||
}, theme) | ||
); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters