Skip to content

feat: Add mobile navbar #3186

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 25, 2022
Merged

feat: Add mobile navbar #3186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8847560
feat: Add mobile navbar
BrunoQuaresma Jul 25, 2022
2dcbd65
Add story for smaller viewports
BrunoQuaresma Jul 25, 2022
c53fd56
Add option to chromatic
BrunoQuaresma Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions site/src/components/NavbarView/NavbarView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,17 @@ ForMember.args = {
return Promise.resolve()
},
}

export const SmallViewport = Template.bind({})
SmallViewport.args = {
user: MockUser,
onSignOut: () => {
return Promise.resolve()
},
}
SmallViewport.parameters = {
viewport: {
defaultViewport: "tablet",
},
chromatic: { viewports: [420] },
}
149 changes: 105 additions & 44 deletions site/src/components/NavbarView/NavbarView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import Drawer from "@material-ui/core/Drawer"
import IconButton from "@material-ui/core/IconButton"
import List from "@material-ui/core/List"
import ListItem from "@material-ui/core/ListItem"
import { fade, makeStyles } from "@material-ui/core/styles"
import MenuIcon from "@material-ui/icons/Menu"
import { useState } from "react"
import { NavLink, useLocation } from "react-router-dom"
import * as TypesGen from "../../api/typesGenerated"
import { navHeight } from "../../theme/constants"
Expand All @@ -19,41 +23,66 @@ export const Language = {
users: "Users",
}

export const NavbarView: React.FC<NavbarViewProps> = ({ user, onSignOut }) => {
const NavItems: React.FC<{ className?: string; linkClassName?: string }> = ({ className }) => {
Copy link
Member

Choose a reason for hiding this comment

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

You can just import FC as a standalone if you wish

const styles = useStyles()
const location = useLocation()

return (
<List className={combineClasses([styles.navItems, className])}>
Copy link
Member

Choose a reason for hiding this comment

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

What's the benefit of using combineClasses instead of template literals?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It handles, null, undefined and conditional styles like { isActive: styles.active }.

<ListItem button className={styles.item}>
<NavLink
className={combineClasses([styles.link, location.pathname.startsWith("/@") && "active"])}
to="/workspaces"
>
{Language.workspaces}
</NavLink>
</ListItem>
<ListItem button className={styles.item}>
<NavLink className={styles.link} to="/templates">
{Language.templates}
</NavLink>
</ListItem>
<ListItem button className={styles.item}>
<NavLink className={styles.link} to="/users">
{Language.users}
</NavLink>
</ListItem>
</List>
)
}

export const NavbarView: React.FC<NavbarViewProps> = ({ user, onSignOut }) => {
const styles = useStyles()
const [isDrawerOpen, setIsDrawerOpen] = useState(false)
Copy link
Contributor

Choose a reason for hiding this comment

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

nit Maybe worth a discussion in FE Variety, but I think by convention the setter function need not have the verb like is or has. For example, I would use setDrawerOpen here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think this would be nice!


return (
<nav className={styles.root}>
<List className={styles.fixed}>
<ListItem className={styles.item}>
<NavLink className={styles.logo} to="/workspaces">
<IconButton
aria-label="Open menu"
className={styles.mobileMenuButton}
onClick={() => {
setIsDrawerOpen(true)
}}
>
<MenuIcon />
</IconButton>

<Drawer anchor="left" open={isDrawerOpen} onClose={() => setIsDrawerOpen(false)}>
<div className={styles.drawer}>
<div className={styles.drawerHeader}>
<Logo fill="white" opacity={1} width={125} />
</NavLink>
</ListItem>
<ListItem button className={styles.item}>
<NavLink
className={combineClasses([
styles.link,
location.pathname.startsWith("/@") && "active",
])}
to="/workspaces"
>
{Language.workspaces}
</NavLink>
</ListItem>
<ListItem button className={styles.item}>
<NavLink className={styles.link} to="/templates">
{Language.templates}
</NavLink>
</ListItem>
<ListItem button className={styles.item}>
<NavLink className={styles.link} to="/users">
{Language.users}
</NavLink>
</ListItem>
</List>
<div className={styles.fullWidth} />
<div className={styles.fixed}>
</div>
<NavItems />
</div>
</Drawer>

<NavLink className={styles.logo} to="/workspaces">
<Logo fill="white" opacity={1} width={125} />
</NavLink>

<NavItems className={styles.desktopNavItems} />

<div className={styles.profileButton}>
{user && <UserDropdown user={user} onSignOut={onSignOut} />}
</div>
</nav>
Expand All @@ -64,9 +93,7 @@ const useStyles = makeStyles((theme) => ({
root: {
position: "relative",
display: "flex",
flex: 0,
flexDirection: "row",
justifyContent: "center",
justifyContent: "space-between",
alignItems: "center",
height: navHeight,
background: theme.palette.background.paper,
Expand All @@ -76,14 +103,37 @@ const useStyles = makeStyles((theme) => ({
borderTop: `1px solid ${theme.palette.divider}`,
},
borderBottom: `1px solid ${theme.palette.divider}`,

[theme.breakpoints.up("md")]: {
justifyContent: "flex-start",
},
},
fixed: {
flex: 0,
display: "flex",
drawer: {
width: 250,
},
drawerHeader: {
padding: theme.spacing(2),
paddingTop: theme.spacing(4),
paddingBottom: theme.spacing(4),
},
navItems: {
padding: 0,
},
fullWidth: {
flex: 1,
desktopNavItems: {
display: "none",
[theme.breakpoints.up("md")]: {
display: "flex",
},
},
profileButton: {
[theme.breakpoints.up("md")]: {
marginLeft: "auto",
},
},
mobileMenuButton: {
[theme.breakpoints.up("md")]: {
display: "none",
},
},
logo: {
alignItems: "center",
Expand All @@ -107,8 +157,7 @@ const useStyles = makeStyles((theme) => ({
color: "hsl(220, 11%, 71%)",
display: "flex",
fontSize: 16,
height: navHeight,
padding: `0 ${theme.spacing(3)}px`,
padding: `${theme.spacing(1.5)}px ${theme.spacing(2)}px`,
textDecoration: "none",
transition: "background-color 0.3s ease",

Expand All @@ -124,13 +173,25 @@ const useStyles = makeStyles((theme) => ({

"&::before": {
content: `" "`,
bottom: 0,
left: theme.spacing(3),
left: 0,
width: 2,
height: "100%",
background: theme.palette.secondary.dark,
right: theme.spacing(3),
height: 2,
position: "absolute",

[theme.breakpoints.up("md")]: {
bottom: 0,
left: theme.spacing(3),
width: `calc(100% - 2 * ${theme.spacing(3)}px)`,
Copy link
Contributor

Choose a reason for hiding this comment

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

nit A comment describing the calculation here would be nice.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I put the commit on auto merge but I will address this when I touch it again.

right: theme.spacing(3),
height: 2,
},
},
},

[theme.breakpoints.up("md")]: {
height: navHeight,
padding: `0 ${theme.spacing(3)}px`,
},
},
}))