feat: add children for custom content and visualContext props to top navigation #4594
There are no files selected for viewing
This file contains hidden or 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,68 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| import React, { useState } from 'react'; | ||
|
|
||
| import Input from '~components/input'; | ||
| import TopNavigation from '~components/top-navigation'; | ||
|
|
||
| import { SimplePage } from '../app/templates'; | ||
| import { I18N_STRINGS } from './common'; | ||
| import logo from './logos/simple-logo.svg'; | ||
|
|
||
| function CustomNav({ searchValue, onSearchChange }: { searchValue: string; onSearchChange: (value: string) => void }) { | ||
| return ( | ||
| <div style={{ display: 'flex', alignItems: 'center', paddingInline: 24, height: 48, gap: 16 }}> | ||
| <img src={logo} alt="Service" style={{ height: 24 }} /> | ||
| <div style={{ flex: 1, maxWidth: 320 }}> | ||
| <Input | ||
| type="search" | ||
| placeholder="Search..." | ||
| value={searchValue} | ||
| onChange={({ detail }) => onSearchChange(detail.value)} | ||
| ariaLabel="Search" | ||
| /> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export default function CustomContentPage() { | ||
| const [searchValue, setSearchValue] = useState(''); | ||
|
|
||
| return ( | ||
| <SimplePage title="TopNavigation children" screenshotArea={{}}> | ||
| <h2>Custom content (default visual context)</h2> | ||
| <TopNavigation> | ||
| <CustomNav searchValue={searchValue} onSearchChange={setSearchValue} /> | ||
| </TopNavigation> | ||
|
|
||
| <br /> | ||
|
|
||
| <h2>Custom content (visualContext="none")</h2> | ||
| <TopNavigation visualContext="none"> | ||
|
Member
There was a problem hiding this comment. I would also add one or two examples with visualContext="none" to some existing top-nav pages that use structured content |
||
| <CustomNav searchValue={searchValue} onSearchChange={setSearchValue} /> | ||
| </TopNavigation> | ||
|
|
||
| <br /> | ||
|
|
||
| <h2>Structured mode (unchanged)</h2> | ||
| <TopNavigation | ||
|
amanabiy marked this conversation as resolved.
|
||
| identity={{ href: '#', title: 'Structured Mode', logo: { src: logo, alt: 'Logo' } }} | ||
| i18nStrings={I18N_STRINGS} | ||
| utilities={[ | ||
| { type: 'button', iconName: 'notification', ariaLabel: 'Notifications', badge: true }, | ||
| { | ||
| type: 'menu-dropdown', | ||
| text: 'Jane Doe', | ||
| description: 'jane.doe@example.com', | ||
| iconName: 'user-profile', | ||
| items: [ | ||
| { id: 'profile', text: 'Profile' }, | ||
| { id: 'signout', text: 'Sign out' }, | ||
| ], | ||
| }, | ||
| ]} | ||
| /> | ||
| </SimplePage> | ||
| ); | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,93 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| import React from 'react'; | ||
| import { render } from '@testing-library/react'; | ||
|
|
||
| import createWrapper from '../../../lib/components/test-utils/dom'; | ||
| import TopNavigation, { TopNavigationProps } from '../../../lib/components/top-navigation'; | ||
|
|
||
| const I18N_STRINGS: TopNavigationProps.I18nStrings = { | ||
|
Member
There was a problem hiding this comment. Why are these strings needed in the custom content tests? |
||
| searchIconAriaLabel: 'Search', | ||
| searchDismissIconAriaLabel: 'Close search', | ||
| overflowMenuTriggerText: 'More', | ||
| overflowMenuTitleText: 'All', | ||
| overflowMenuBackIconAriaLabel: 'Back', | ||
| overflowMenuDismissIconAriaLabel: 'Close', | ||
| }; | ||
|
|
||
| const renderTopNavigation = (props: TopNavigationProps, children?: React.ReactNode) => { | ||
|
Member
There was a problem hiding this comment. nit: children is already a part of TopNavigationProps - why do we define it separately? |
||
| const { container } = render( | ||
| <TopNavigation i18nStrings={I18N_STRINGS} {...props}> | ||
| {children} | ||
| </TopNavigation> | ||
| ); | ||
| return createWrapper(container).findTopNavigation()!; | ||
| }; | ||
|
|
||
| describe('children', () => { | ||
| test('renders custom content when children are provided', () => { | ||
| const wrapper = renderTopNavigation({}, <div data-testid="custom">Custom Nav</div>); | ||
| expect(wrapper.findContent()).not.toBeNull(); | ||
| expect(wrapper.findContent()!.getElement()).toHaveTextContent('Custom Nav'); | ||
| }); | ||
|
|
||
| test('does not render identity when children are provided', () => { | ||
|
Member
There was a problem hiding this comment. nit: should we add these assertions to the 'renders custom content when children are provided' test instead: ? As custom content replaces everything else, I think it makes sense to check for everything in one place rather than creating separate tests for that. |
||
| const wrapper = renderTopNavigation({ identity: { href: '#', title: 'Should Not Render' } }, <div>Custom</div>); | ||
| expect(wrapper.findTitle()).toBeNull(); | ||
| expect(wrapper.findIdentityLink()).toBeNull(); | ||
| }); | ||
|
|
||
| test('does not render utilities when children are provided', () => { | ||
| const wrapper = renderTopNavigation( | ||
| { identity: { href: '#', title: 'Title' }, utilities: [{ type: 'button', text: 'Help' }] }, | ||
| <div>Custom</div> | ||
| ); | ||
| expect(wrapper.findUtilities()).toHaveLength(0); | ||
| }); | ||
|
|
||
| test('does not render search when children are provided', () => { | ||
| const wrapper = renderTopNavigation( | ||
| { identity: { href: '#', title: 'Title' }, search: <input placeholder="Search" /> }, | ||
| <div>Custom</div> | ||
| ); | ||
| expect(wrapper.findSearch()).toBeNull(); | ||
| }); | ||
|
|
||
| test('renders structured mode when children are not provided', () => { | ||
| const wrapper = renderTopNavigation({ identity: { href: '#', title: 'Structured' } }); | ||
| expect(wrapper.findContent()).toBeNull(); | ||
| expect(wrapper.findTitle()!.getElement()).toHaveTextContent('Structured'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('visualContext', () => { | ||
|
Member
There was a problem hiding this comment. Why do visual context related tests live inside top-navigation-custom-content.test? |
||
| test('defaults to top-navigation (dark visual context)', () => { | ||
| const { container } = render(<TopNavigation identity={{ href: '#', title: 'Title' }} i18nStrings={I18N_STRINGS} />); | ||
| expect(container.querySelector('[class*="awsui-context-top-navigation"]')).not.toBeNull(); | ||
| }); | ||
|
|
||
| test('applies visual context when visualContext is "top-navigation"', () => { | ||
|
Member
There was a problem hiding this comment. This test also checks custom content, but that is not explicitly called out. I recommend making test names better uniform to ensure we capture all 4 states explicitly. Alternatively, we can group tests together: |
||
| const { container } = render( | ||
| <TopNavigation visualContext="top-navigation"> | ||
| <div>Custom</div> | ||
| </TopNavigation> | ||
| ); | ||
| expect(container.querySelector('[class*="awsui-context-top-navigation"]')).not.toBeNull(); | ||
| }); | ||
|
|
||
| test('does not apply visual context when visualContext is "none"', () => { | ||
| const { container } = render( | ||
| <TopNavigation visualContext="none"> | ||
| <div>Custom</div> | ||
| </TopNavigation> | ||
| ); | ||
| expect(container.querySelector('[class*="awsui-context-top-navigation"]')).toBeNull(); | ||
| }); | ||
|
|
||
| test('visualContext="none" works with structured mode', () => { | ||
| const { container } = render( | ||
| <TopNavigation visualContext="none" identity={{ href: '#', title: 'Light Nav' }} i18nStrings={I18N_STRINGS} /> | ||
| ); | ||
| expect(container.querySelector('[class*="awsui-context-top-navigation"]')).toBeNull(); | ||
| }); | ||
| }); | ||
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
nit: this custom nav is not that custom. I would extend this example or even create a few more examples to feature more Cloudscape components that can be used inside the top-nav, such as button group, button dropdown, links, and more.