feat: Editor in-page navigation

editor.planx.uk/src/components/EditorNavMenu.tsx

@@ -0,0 +1,196 @@
+import AdminPanelSettingsIcon from "@mui/icons-material/AdminPanelSettings";
+import FactCheckIcon from "@mui/icons-material/FactCheck";
+import FormatListBulletedIcon from "@mui/icons-material/FormatListBulleted";
+import GroupIcon from "@mui/icons-material/Group";
+import PaletteIcon from "@mui/icons-material/Palette";
+import RateReviewIcon from "@mui/icons-material/RateReview";
+import TuneIcon from "@mui/icons-material/Tune";
+import Box from "@mui/material/Box";
+import IconButton from "@mui/material/IconButton";
+import { styled } from "@mui/material/styles";
+import Tooltip, { tooltipClasses, TooltipProps } from "@mui/material/Tooltip";
+import Typography from "@mui/material/Typography";
+import React from "react";
+import { useCurrentRoute, useNavigation } from "react-navi";
+import { rootFlowPath } from "routes/utils";
+import { FONT_WEIGHT_SEMI_BOLD } from "theme";
+import EditorIcon from "ui/icons/Editor";
+
+interface Route {
+  title: string;
+  Icon: React.ElementType;
+  route: string;
+}
+
+interface EditorNavMenuProps {
+  routes: Route[];
+  compact?: boolean;
+}
+
+const globalLayoutRoutes: Route[] = [
+  {
+    title: "Select a team",
+    Icon: FormatListBulletedIcon,
+    route: "/",
+  },
+  {
+    title: "Admin panel",
+    Icon: AdminPanelSettingsIcon,
+    route: "admin-panel",
+  },
+  {
+    title: "Global settings",
+    Icon: TuneIcon,
+    route: "global-settings",
+  },
+];
+
+const teamLayoutRoutes: Route[] = [
+  {
+    title: "Services",
+    Icon: FormatListBulletedIcon,
+    route: "/",
+  },
+  {
+    title: "Team members",
+    Icon: GroupIcon,
+    route: "/members",
+  },
+  {
+    title: "Design",
+    Icon: PaletteIcon,
+    route: "/settings/design",
+  },
+];
+
+const flowLayoutRoutes: Route[] = [
+  {
+    title: "Editor",
+    Icon: EditorIcon,
+    route: "",
+  },
+  {
+    title: "Service settings",
+    Icon: TuneIcon,
+    route: "/service",
+  },
+  {
+    title: "Submissions log",
+    Icon: FactCheckIcon,
+    route: "/submissions-log",
+  },
+  {
+    title: "Feedback",
+    Icon: RateReviewIcon,
+    route: "/feedback",
+  },
+];
+
+const MENU_WIDTH_COMPACT = "52px";
+const MENU_WIDTH_FULL = "184px";
+
+const Root = styled(Box)<{ compact?: boolean }>(({ theme, compact }) => ({
+  width: compact ? MENU_WIDTH_COMPACT : MENU_WIDTH_FULL,
+  flexShrink: 0,
+  background: theme.palette.background.paper,
+  borderRight: `1px solid ${theme.palette.border.light}`,
+}));
+
+const MenuWrap = styled("ul")(({ theme }) => ({
+  listStyle: "none",
+  margin: 0,
+  padding: theme.spacing(2.5, 0.4, 0, 0.4),
+  position: "sticky",
+  top: 0,
+}));
+
+const MenuItem = styled("li")(({ theme }) => ({
+  margin: theme.spacing(0.75, 0),
+  padding: 0,
+}));
+
+const MenuTitle = styled(Typography)(({ theme }) => ({
+  fontWeight: FONT_WEIGHT_SEMI_BOLD,
+  paddingLeft: theme.spacing(0.5),
+  textAlign: "left",
+})) as typeof Typography;
+
+const TooltipWrap = styled(({ className, ...props }: TooltipProps) => (
+  <Tooltip {...props} arrow placement="right" classes={{ popper: className }} />
+))(() => ({
+  [`& .${tooltipClasses.arrow}`]: {
+    color: "#2c2c2c",
+  },
+  [`& .${tooltipClasses.tooltip}`]: {
+    backgroundColor: "#2c2c2c",
+    left: "-5px",
+    fontSize: "0.8em",
+    borderRadius: 0,
+    fontWeight: FONT_WEIGHT_SEMI_BOLD,
+  },
+}));
+
+const MenuButton = styled(IconButton, {
+  shouldForwardProp: (prop) => prop !== "isActive",
+})<{ isActive: boolean }>(({ theme, isActive }) => ({
+  color: theme.palette.text.primary,
+  width: "100%",
+  border: "1px solid transparent",
+  justifyContent: "flex-start",
+  borderRadius: "3px",
+  "&:hover": {
+    background: "white",
+    borderColor: theme.palette.border.light,
+  },
+  ...(isActive && {
+    background: theme.palette.common.white,
+    color: theme.palette.text.primary,
+    border: `1px solid ${theme.palette.border.main}`,
+  }),
+  "& > svg": {
+    opacity: 0.8,
+  },
+}));
+
+function EditorNavMenu({ routes, compact }: EditorNavMenuProps) {
+  const { navigate } = useNavigation();
+  const { url } = useCurrentRoute();
+  const rootPath = rootFlowPath();
+
+  const isActive = (route: string) => {
+    const currentPath = url.pathname.replace(rootPath, "");
+    return currentPath === route;
+  };
+
+  const handleClick = (route: string) => {
+    if (!isActive(route)) {
+      navigate(rootPath + route);
+    }
+  };
+
+  return (
+    <Root compact={compact}>
+      <MenuWrap>
+        {routes.map(({ title, Icon, route }) => (
+          <MenuItem onClick={() => handleClick(route)} key={title}>
+            {compact ? (
+              <TooltipWrap title={title}>
+                <MenuButton isActive={isActive(route)} disableRipple>
+                  <Icon />
+                </MenuButton>
+              </TooltipWrap>
+            ) : (
+              <MenuButton isActive={isActive(route)} disableRipple>
+                <Icon />
+                <MenuTitle variant="body2">{title}</MenuTitle>
+              </MenuButton>
+            )}
+          </MenuItem>
+        ))}
+      </MenuWrap>
+    </Root>
+  );
+}
+
+export { flowLayoutRoutes, globalLayoutRoutes, teamLayoutRoutes };
+export default EditorNavMenu;

editor.planx.uk/src/components/Header.tsx

@@ -62,7 +62,7 @@ const BreadcrumbsRoot = styled(Box)(() => ({
 const BreadcrumbsLink = styled(Link)(({ theme }) => ({
   color: theme.palette.common.white,
   textDecoration: "none",
-  borderBottom: "1px solid currentColor",
+  borderBottom: "1px solid rgba(255, 255, 255, 0.75)",
 })) as typeof Link;
 
 const StyledToolbar = styled(MuiToolbar)(() => ({
@@ -487,7 +487,7 @@ const EditorToolbar: React.FC<{
                       {user.lastName[0]}
                     </Avatar>
                     <Typography variant="body2" fontSize="small">
-                      Menu
+                      Account
                     </Typography>
                     <KeyboardArrowDown />
                   </IconButton>

editor.planx.uk/src/pages/FlowEditor/components/Settings/DesignSettings/index.tsx

@@ -1,5 +1,6 @@
 import Alert from "@mui/material/Alert";
 import Box from "@mui/material/Box";
+import Container from "@mui/material/Container";
 import Snackbar from "@mui/material/Snackbar";
 import { styled } from "@mui/material/styles";
 import Typography from "@mui/material/Typography";
@@ -75,7 +76,7 @@ const DesignSettings: React.FC = () => {
   const onSuccess = () => setOpen(true);
 
   return (
-    <Box maxWidth="formWrap" mx="auto">
+    <Container maxWidth="formWrap">
       <SettingsSection>
         <Typography variant="h2" component="h3" gutterBottom>
           Design
@@ -97,7 +98,7 @@ const DesignSettings: React.FC = () => {
           Theme updated successfully
         </Alert>
       </Snackbar>
-    </Box>
+    </Container>
   );
 };
 

editor.planx.uk/src/pages/FlowEditor/components/Settings/TeamSettings.tsx

@@ -1,12 +1,12 @@
-import Box from "@mui/material/Box";
+import Container from "@mui/material/Container";
 import Typography from "@mui/material/Typography";
 import React from "react";
 import { FeaturePlaceholder } from "ui/editor/FeaturePlaceholder";
 import SettingsSection from "ui/editor/SettingsSection";
 
 const Team: React.FC = () => {
   return (
-    <Box maxWidth="formWrap" mx="auto">
+    <Container maxWidth="formWrap">
       <SettingsSection>
         <Typography variant="h2" component="h3" gutterBottom>
           Team
@@ -30,7 +30,7 @@ const Team: React.FC = () => {
       <SettingsSection>
         <FeaturePlaceholder title="Feature in development" />
       </SettingsSection>
-    </Box>
+    </Container>
   );
 };
 export default Team;