refactor: Move editor console to tab (#3578)

theopensystemslab · Aug 28, 2024 · 6e40f0c · 6e40f0c
1 parent c4b3bf4
commit 6e40f0c
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 57 deletions.
diff --git a/editor.planx.uk/src/pages/FlowEditor/components/Sidebar/StyledTab.tsx b/editor.planx.uk/src/pages/FlowEditor/components/Sidebar/StyledTab.tsx
@@ -0,0 +1,39 @@
+import { styled } from "@mui/material/styles";
+import Tab, { tabClasses, TabProps } from "@mui/material/Tab";
+import React from "react";
+import { FONT_WEIGHT_SEMI_BOLD } from "theme";
+
+interface StyledTabProps extends TabProps {
+  tabTheme?: "light" | "dark";
+}
+
+const StyledTab = styled(({ tabTheme, ...props }: StyledTabProps) => (
+  <Tab {...props} disableFocusRipple disableTouchRipple disableRipple />
+))<StyledTabProps>(({ theme, tabTheme }) => ({
+  position: "relative",
+  zIndex: 1,
+  textTransform: "none",
+  background: "transparent",
+  border: `1px solid transparent`,
+  borderBottomColor: theme.palette.border.main,
+  color: theme.palette.primary.main,
+  fontWeight: FONT_WEIGHT_SEMI_BOLD,
+  minHeight: "36px",
+  margin: theme.spacing(0, 0.5),
+  marginBottom: "-1px",
+  padding: "0.5em",
+  [`&.${tabClasses.selected}`]: {
+    background:
+      tabTheme === "dark"
+        ? theme.palette.background.dark
+        : theme.palette.background.default,
+    borderColor: theme.palette.border.main,
+    borderBottomColor: theme.palette.common.white,
+    color:
+      tabTheme === "dark"
+        ? theme.palette.common.white
+        : theme.palette.text.primary,
+  },
+}));
+
+export default StyledTab;
diff --git a/editor.planx.uk/src/pages/FlowEditor/components/Sidebar/index.tsx b/editor.planx.uk/src/pages/FlowEditor/components/Sidebar/index.tsx
@@ -1,5 +1,4 @@
 import LanguageIcon from "@mui/icons-material/Language";
-import MenuOpenIcon from "@mui/icons-material/MenuOpen";
 import OpenInNewIcon from "@mui/icons-material/OpenInNew";
 import OpenInNewOffIcon from "@mui/icons-material/OpenInNewOff";
 import Badge from "@mui/material/Badge";
@@ -12,7 +11,6 @@ import DialogContent from "@mui/material/DialogContent";
 import DialogTitle from "@mui/material/DialogTitle";
 import Link from "@mui/material/Link";
 import { styled } from "@mui/material/styles";
-import Tab, { tabClasses } from "@mui/material/Tab";
 import Tabs from "@mui/material/Tabs";
 import Tooltip from "@mui/material/Tooltip";
 import Typography from "@mui/material/Typography";
@@ -35,13 +33,16 @@ import {
   ValidationChecks,
 } from "./PublishDialog";
 import Search from "./Search";
+import StyledTab from "./StyledTab";
 
-type SidebarTabs = "PreviewBrowser" | "History" | "Search";
+type SidebarTabs = "PreviewBrowser" | "History" | "Search" | "Console";
 
-const Console = styled(Box)(() => ({
+const Console = styled(Box)(({ theme }) => ({
   overflow: "auto",
-  padding: 20,
-  maxHeight: "50%",
+  padding: theme.spacing(2),
+  height: "100%",
+  backgroundColor: theme.palette.background.dark,
+  color: theme.palette.common.white,
 }));
 
 const Root = styled(Box)(({ theme }) => ({
@@ -114,27 +115,6 @@ const TabList = styled(Box)(({ theme }) => ({
   },
 }));
 
-const StyledTab = styled(Tab)(({ theme }) => ({
-  position: "relative",
-  zIndex: 1,
-  textTransform: "none",
-  background: "transparent",
-  border: `1px solid transparent`,
-  borderBottomColor: theme.palette.border.main,
-  color: theme.palette.primary.main,
-  fontWeight: "600",
-  minHeight: "36px",
-  margin: theme.spacing(0, 0.5),
-  marginBottom: "-1px",
-  padding: "0.5em",
-  [`&.${tabClasses.selected}`]: {
-    background: theme.palette.background.default,
-    borderColor: theme.palette.border.main,
-    borderBottomColor: theme.palette.common.white,
-    color: theme.palette.text.primary,
-  },
-})) as typeof Tab;
-
 const DebugConsole = () => {
   const [passport, breadcrumbs, flowId, cachedBreadcrumbs] = useStore(
     (state) => [
@@ -145,19 +125,20 @@ const DebugConsole = () => {
     ],
   );
   return (
-    <Console borderTop={2} borderColor="border.main" bgcolor="background.paper">
+    <Console>
       <Typography variant="body2">
         <a
           href={`${
             import.meta.env.VITE_APP_API_URL
           }/flows/${flowId}/download-schema`}
           target="_blank"
           rel="noopener noreferrer"
+          style={{ color: "inherit" }}
         >
           Download the flow schema
         </a>
       </Typography>
-      <pre>
+      <pre style={{ whiteSpace: "pre-wrap", fontSize: "medium" }}>
         {JSON.stringify({ passport, breadcrumbs, cachedBreadcrumbs }, null, 2)}
       </pre>
     </Console>
@@ -270,12 +251,6 @@ const Sidebar: React.FC<{
             value={props.url.replace("/published", "/preview")}
           />
 
-          <Tooltip arrow title="Toggle debug console">
-            <MenuOpenIcon
-              onClick={() => setDebugConsoleVisibility(!showDebugConsole)}
-            />
-          </Tooltip>
-
           <Permission.IsPlatformAdmin>
             <Tooltip arrow title="Open draft service">
               <Link
@@ -415,29 +390,12 @@ const Sidebar: React.FC<{
       </Header>
       <TabList>
         <Tabs centered onChange={handleChange} value={activeTab} aria-label="">
-          <StyledTab
-            disableFocusRipple
-            disableTouchRipple
-            disableRipple
-            value="PreviewBrowser"
-            label="Preview"
-          />
-          <StyledTab
-            disableFocusRipple
-            disableTouchRipple
-            disableRipple
-            value="History"
-            label="History"
-          />
+          <StyledTab value="PreviewBrowser" label="Preview" tabTheme="light" />
+          <StyledTab value="History" label="History" tabTheme="light" />
           {hasFeatureFlag("SEARCH") && (
-            <StyledTab
-              disableFocusRipple
-              disableTouchRipple
-              disableRipple
-              value="Search"
-              label="Search"
-            />
+            <StyledTab value="Search" label="Search" tabTheme="light" />
           )}
+          <StyledTab value="Console" label="Console" tabTheme="dark" />
         </Tabs>
       </TabList>
       {activeTab === "PreviewBrowser" && (
@@ -466,7 +424,11 @@ const Sidebar: React.FC<{
           <Search />
         </SidebarContainer>
       )}
-      {showDebugConsole && <DebugConsole />}
+      {activeTab === "Console" && (
+        <SidebarContainer>
+          <DebugConsole />
+        </SidebarContainer>
+      )}
     </Root>
   );
 });