feat(docked nav): add support for docked nav layout #12175
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
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,223 @@ | ||
| import { useRef, useState, useEffect } from 'react'; | ||
| import { | ||
| Compass, | ||
| CompassContent, | ||
| CompassMainHeader, | ||
| CompassPanel, | ||
| Title, | ||
| NavItem, | ||
| NavList, | ||
| Nav, | ||
| Brand, | ||
| MastheadLogo, | ||
| MastheadBrand, | ||
| MastheadContent, | ||
| MastheadMain, | ||
| Masthead, | ||
| Toolbar, | ||
| ToolbarContent, | ||
| ToolbarItem, | ||
| ToolbarGroup, | ||
| Dropdown, | ||
| DropdownList, | ||
| MenuToggle, | ||
| MenuToggleElement, | ||
| DropdownItem, | ||
| Button, | ||
| ButtonVariant, | ||
| Avatar, | ||
| Tooltip, | ||
| Divider | ||
| } from '@patternfly/react-core'; | ||
| import CubeIcon from '@patternfly/react-icons/dist/esm/icons/cube-icon'; | ||
| import FolderIcon from '@patternfly/react-icons/dist/esm/icons/folder-icon'; | ||
| import QuestionCircleIcon from '@patternfly/react-icons/dist/esm/icons/question-circle-icon'; | ||
| import CloudIcon from '@patternfly/react-icons/dist/esm/icons/cloud-icon'; | ||
| import CodeIcon from '@patternfly/react-icons/dist/esm/icons/code-icon'; | ||
| import pfLogo from '../../assets/PF-IconLogo-color.svg'; | ||
| import imgAvatar from '../../assets/avatarImg.svg'; | ||
|
|
||
| interface NavOnSelectProps { | ||
| groupId: number | string; | ||
| itemId: number | string; | ||
| to: string; | ||
| } | ||
|
|
||
| export const CompassDockDemo: React.FunctionComponent = () => { | ||
| const [activeItem, setActiveItem] = useState<number>(0); | ||
| const [isDropdownOpen, setIsDropdownOpen] = useState(false); | ||
| const [isOpen, setIsOpen] = useState<boolean>(false); | ||
| const menuRef = useRef<HTMLDivElement>(null); | ||
| const toggleRef = useRef<HTMLButtonElement>(null); | ||
|
|
||
| const onNavSelect = (_event: React.FormEvent<HTMLInputElement>, selectedItem: NavOnSelectProps) => { | ||
| typeof selectedItem.itemId === 'number' && setActiveItem(selectedItem.itemId); | ||
| }; | ||
|
|
||
| const onDropdownToggle = () => { | ||
| setIsDropdownOpen(!isDropdownOpen); | ||
| }; | ||
|
|
||
| const onDropdownSelect = () => { | ||
| setIsDropdownOpen(!isDropdownOpen); | ||
| }; | ||
|
|
||
| const handleMenuKeys = (event: KeyboardEvent) => { | ||
| if (!isOpen) { | ||
| return; | ||
| } | ||
| if (menuRef.current?.contains(event.target as Node) || toggleRef.current?.contains(event.target as Node)) { | ||
| if (event.key === 'Escape') { | ||
| setIsOpen(!isOpen); | ||
| toggleRef.current?.focus(); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const handleClickOutside = (event: MouseEvent) => { | ||
| if (isOpen && !menuRef.current?.contains(event.target as Node)) { | ||
| setIsOpen(false); | ||
| } | ||
| }; | ||
|
|
||
| useEffect(() => { | ||
| window.addEventListener('keydown', handleMenuKeys); | ||
| window.addEventListener('click', handleClickOutside); | ||
|
|
||
| return () => { | ||
| window.removeEventListener('keydown', handleMenuKeys); | ||
| window.removeEventListener('click', handleClickOutside); | ||
| }; | ||
| }, [isOpen, menuRef]); | ||
|
Check warning on line 91 in packages/react-core/src/components/Compass/examples/CompassDockDemo.tsx
|
||
|
|
||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
| const userDropdownItems = [ | ||
| <> | ||
| <DropdownItem key="group 2 profile">My profile</DropdownItem> | ||
| <DropdownItem key="group 2 user">User management</DropdownItem> | ||
| <DropdownItem key="group 2 logout">Logout</DropdownItem> | ||
| </> | ||
| ]; | ||
|
|
||
| const navItem1Ref = useRef<HTMLAnchorElement>(null); | ||
| const navItem2Ref = useRef<HTMLAnchorElement>(null); | ||
| const navItem3Ref = useRef<HTMLAnchorElement>(null); | ||
| const navItem4Ref = useRef<HTMLAnchorElement>(null); | ||
| const dockContent = ( | ||
| <Masthead id="icon-router-link" variant="docked"> | ||
| <MastheadMain> | ||
| <MastheadBrand> | ||
| <MastheadLogo component={(props) => <a {...props} href="#" />}> | ||
| <Brand src={pfLogo} alt="PatternFly" heights={{ default: '36px' }} /> | ||
|
mcoker marked this conversation as resolved.
Outdated
|
||
| </MastheadLogo> | ||
| </MastheadBrand> | ||
| </MastheadMain> | ||
| <Divider /> | ||
| <MastheadContent> | ||
| <Toolbar id="toolbar" isVertical> | ||
| <ToolbarContent> | ||
| <ToolbarItem> | ||
| <Nav onSelect={onNavSelect} variant="docked" aria-label="Icon global" ouiaId="IconNav"> | ||
| <NavList> | ||
| <NavItem | ||
| key="nav-icon-link1" | ||
| preventDefault | ||
| id="nav-icon-link1" | ||
| to="#nav-icon-link1" | ||
| itemId={0} | ||
| isActive={activeItem === 0} | ||
| icon={<CubeIcon />} | ||
| ref={navItem1Ref} | ||
| /> | ||
| <NavItem | ||
| key="nav-icon-link2" | ||
| preventDefault | ||
| id="nav-icon-link2" | ||
| to="#nav-icon-link2" | ||
| itemId={1} | ||
| isActive={activeItem === 1} | ||
| icon={<FolderIcon />} | ||
| ref={navItem2Ref} | ||
| /> | ||
| <NavItem | ||
| key="nav-icon-link3" | ||
| preventDefault | ||
| id="nav-icon-link3" | ||
| to="#nav-icon-link3" | ||
| itemId={0} | ||
| isActive={activeItem === 2} | ||
| icon={<CloudIcon />} | ||
| ref={navItem3Ref} | ||
| /> | ||
| <NavItem | ||
| key="nav-icon-link4" | ||
| preventDefault | ||
| id="nav-icon-link4" | ||
| to="#nav-icon-link4" | ||
| itemId={0} | ||
| isActive={activeItem === 3} | ||
| icon={<CodeIcon />} | ||
| ref={navItem4Ref} | ||
| /> | ||
| </NavList> | ||
| </Nav> | ||
| <Tooltip triggerRef={navItem1Ref} content="Link 1"></Tooltip> | ||
| <Tooltip triggerRef={navItem2Ref} content="Link 2"></Tooltip> | ||
| <Tooltip triggerRef={navItem3Ref} content="Link 3"></Tooltip> | ||
| <Tooltip triggerRef={navItem4Ref} content="Link 4"></Tooltip> | ||
| </ToolbarItem> | ||
| <ToolbarGroup | ||
| variant="action-group-plain" | ||
| align={{ default: 'alignEnd' }} | ||
| gap={{ default: 'gapNone', md: 'gapMd' }} | ||
| > | ||
| <ToolbarGroup variant="action-group-plain" visibility={{ default: 'hidden', lg: 'visible' }}> | ||
| <ToolbarItem> | ||
| <Button aria-label="Settings" isSettings variant="plain" /> | ||
| </ToolbarItem> | ||
| <ToolbarItem> | ||
| <Button aria-label="Help" variant={ButtonVariant.plain} icon={<QuestionCircleIcon />} /> | ||
| </ToolbarItem> | ||
| </ToolbarGroup> | ||
| </ToolbarGroup> | ||
| <ToolbarItem> | ||
| <Dropdown | ||
| isOpen={isDropdownOpen} | ||
| onSelect={onDropdownSelect} | ||
| onOpenChange={(isOpen: boolean) => setIsDropdownOpen(isOpen)} | ||
| toggle={(toggleRef: React.Ref<MenuToggleElement>) => ( | ||
| <MenuToggle | ||
| ref={toggleRef} | ||
| onClick={onDropdownToggle} | ||
| isExpanded={isDropdownOpen} | ||
| icon={<Avatar src={imgAvatar} alt="" size="sm" />} | ||
| variant="plain" | ||
| ></MenuToggle> | ||
| )} | ||
| > | ||
| <DropdownList>{userDropdownItems}</DropdownList> | ||
| </Dropdown> | ||
| </ToolbarItem> | ||
| </ToolbarContent> | ||
| </Toolbar> | ||
| </MastheadContent> | ||
| </Masthead> | ||
| ); | ||
|
|
||
| const mainContent = ( | ||
| <> | ||
| <CompassMainHeader title={<Title headingLevel="h1">Content title</Title>} /> | ||
| <CompassContent> | ||
| <CompassPanel>Content</CompassPanel> | ||
| </CompassContent> | ||
| </> | ||
| ); | ||
|
|
||
| return ( | ||
| <Compass | ||
| dock={dockContent} | ||
| main={mainContent} | ||
| backgroundSrcDark="/assets/images/pf-background.svg" | ||
| backgroundSrcLight="/assets/images/pf-background.svg" | ||
| /> | ||
| ); | ||
| }; | ||
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.
Uh oh!
There was an error while loading. Please reload this page.