feat: Add optional "inline" mode for displaying nodes

This uses up less space, and reads nicely (more text-like) for `λ`/`∀`/`Λ` nodes. We can trigger this mode through the tree/text toggle. This is a slight abuse of this element, and we'll likely revisit this if/when we have more optional display behaviour. On the other hand, this display option is fairly experimental for now, and it may well be that we don't keep both tree styles around in the long run. Signed-off-by: George Thomas <[email protected]>
hackworthltd · Aug 2, 2023 · e4b3ca9 · e4b3ca9
1 parent 67f5cfd
commit e4b3ca9
Show file tree

Hide file tree

Showing 7 changed files with 150 additions and 52 deletions.
diff --git a/src/components/Edit/index.tsx b/src/components/Edit/index.tsx
@@ -48,8 +48,10 @@ import {
 } from "@/primer-api";
 import {
   defaultTreeReactFlowProps,
+  inlineTreeReactFlowProps,
   ScrollToDef,
 } from "@/components/TreeReactFlow";
+import { Mode } from "../Toolbar";
 
 // hardcoded values (for now)
 const initialLevel: Level = "Expert";
@@ -198,6 +200,8 @@ const AppNoError = ({
   undoAvailable: boolean;
   redoAvailable: boolean;
 }): JSX.Element => {
+  const initialMode = "tree 1";
+  const [mode, setMode] = useState<Mode>(initialMode);
   const [level, setLevel] = useState<Level>(initialLevel);
   const toggleLevel = (): void => {
     switch (level) {
@@ -265,14 +269,25 @@ const AppNoError = ({
     .sort((a, b) => cmpName(a.name, b.name))
     .map((d) => d.name.baseName);
 
+  const treeProps = (() => {
+    switch (mode) {
+      case "text":
+        return defaultTreeReactFlowProps;
+      case "tree 1":
+        return defaultTreeReactFlowProps;
+      case "tree 2":
+        return inlineTreeReactFlowProps;
+    }
+  })();
+
   return (
     <div className="grid h-[100dvh] grid-cols-[auto_20rem]">
       <div className="relative h-full">
         <ReactFlowProvider>
           <TreeReactFlow
             scrollToDefRef={scrollToDefRef}
             scrollToTypeDefRef={scrollToTypeDefRef}
-            {...defaultTreeReactFlowProps}
+            {...treeProps}
             {...(selection && { selection })}
             onNodeClick={(_e, sel) => sel && setSelection(sel)}
             defs={p.module.defs}
@@ -286,9 +301,7 @@ const AppNoError = ({
 
             <div className="absolute bottom-4 right-4 z-30">
               <Toolbar
-                onModeChange={() => {
-                  console.log("Toggle mode");
-                }}
+                onModeChange={setMode}
                 level={level}
                 onLevelChange={toggleLevel}
                 undoAvailable={p.undoAvailable}
@@ -307,7 +320,7 @@ const AppNoError = ({
                     })
                     .then(p.setProg);
                 }}
-                initialMode="tree"
+                initialMode={mode}
               />
             </div>
 
@@ -324,6 +337,7 @@ const AppNoError = ({
               defs={defs}
               initialEvalDef={evalTarget}
               typeOrKind={p.selectionTypeOrKind}
+              extraTreeProps={treeProps}
             />
           </TreeReactFlow>
         </ReactFlowProvider>

diff --git a/src/components/EvalFull/index.tsx b/src/components/EvalFull/index.tsx
@@ -2,7 +2,10 @@ import { useState } from "react";
 import { NodeChange, ReactFlowProvider, useReactFlow } from "reactflow";
 import { EvalFullResp, GlobalName, Level } from "@/primer-api";
 import { SelectMenu, TreeReactFlowOne } from "@/components";
-import { defaultTreeReactFlowProps } from "../TreeReactFlow";
+import {
+  TreeReactFlowOneProps,
+  defaultTreeReactFlowProps,
+} from "../TreeReactFlow";
 
 export type EvalFullProps = {
   moduleName: string[];
@@ -13,12 +16,14 @@ export type EvalFullProps = {
   level: Level;
   defs: string[];
   initialEvalDef: string | undefined;
+  extraTreeProps: Partial<TreeReactFlowOneProps>;
 };
 
 const Evaluated = (p: {
   defName: GlobalName;
   evaluated?: EvalFullResp;
   level: Level;
+  extraTreeProps: Partial<TreeReactFlowOneProps>;
 }) => {
   const padding = 1.0;
   const { fitView } = useReactFlow();
@@ -34,6 +39,7 @@ const Evaluated = (p: {
       zoomBarProps={{ padding }}
       onNodesChange={onNodesChange}
       fitViewOptions={{ padding }}
+      {...p.extraTreeProps}
     />
   );
 };
@@ -47,6 +53,7 @@ export const EvalFull = ({
   moduleName,
   level,
   initialEvalDef,
+  extraTreeProps,
 }: EvalFullProps): JSX.Element => {
   const [evalDef, setEvalDef0] = useState(initialEvalDef ?? disableEval);
   const setEvalDef = (e: string) => {
@@ -73,6 +80,7 @@ export const EvalFull = ({
                 defName={{ qualifiedModule: moduleName, baseName: evalDef }}
                 {...(evalFull.result ? { evaluated: evalFull.result } : {})}
                 level={level}
+                extraTreeProps={extraTreeProps}
               />
             </ReactFlowProvider>
           </div>

diff --git a/src/components/SelectionInfo/index.tsx b/src/components/SelectionInfo/index.tsx
@@ -1,14 +1,22 @@
 import { NodeChange, ReactFlowProvider, useReactFlow } from "reactflow";
 import { Level, TypeOrKind } from "@/primer-api";
 import { TreeReactFlowOne } from "@/components";
-import { defaultTreeReactFlowProps } from "../TreeReactFlow";
+import {
+  TreeReactFlowOneProps,
+  defaultTreeReactFlowProps,
+} from "../TreeReactFlow";
 
 export type SelectionInfoProps = {
   typeOrKind: TypeOrKind | undefined;
   level: Level;
+  extraTreeProps: Partial<TreeReactFlowOneProps>;
 };
 
-const TypeOrKindTree = (p: { typeOrKind: TypeOrKind; level: Level }) => {
+const TypeOrKindTree = (p: {
+  typeOrKind: TypeOrKind;
+  level: Level;
+  extraTreeProps: Partial<TreeReactFlowOneProps>;
+}) => {
   const padding = 1.0;
   const { fitView } = useReactFlow();
   const onNodesChange = (_: NodeChange[]) => {
@@ -23,13 +31,15 @@ const TypeOrKindTree = (p: { typeOrKind: TypeOrKind; level: Level }) => {
       zoomBarProps={{ padding }}
       onNodesChange={onNodesChange}
       fitViewOptions={{ padding }}
+      {...p.extraTreeProps}
     />
   );
 };
 
 export const SelectionInfo = ({
   typeOrKind,
   level,
+  extraTreeProps,
 }: SelectionInfoProps): JSX.Element => {
   return (
     <div className="flex h-full flex-col overflow-auto">
@@ -40,7 +50,11 @@ export const SelectionInfo = ({
           </div>
           <div className="grow">
             <ReactFlowProvider>
-              <TypeOrKindTree typeOrKind={typeOrKind} level={level} />
+              <TypeOrKindTree
+                typeOrKind={typeOrKind}
+                level={level}
+                extraTreeProps={extraTreeProps}
+              />
             </ReactFlowProvider>
           </div>
         </>

diff --git a/src/components/Toolbar/index.tsx b/src/components/Toolbar/index.tsx
@@ -23,7 +23,7 @@ export type ToolbarProps = {
   undoAvailable: boolean;
   onClickUndo: MouseEventHandler<HTMLButtonElement>;
 };
-export type Mode = "text" | "tree";
+export type Mode = "text" | "tree 1" | "tree 2";
 
 const iconClasses = "stroke-[2] p-1";
 const heavyIconClasses = "w-7 stroke-[3] p-1";
@@ -32,16 +32,19 @@ const modeSvg = (m: Mode) => {
   switch (m) {
     case "text":
       return <CodeBracketIcon className={iconClasses} />;
-    case "tree":
+    case "tree 1":
+    case "tree 2":
       return <ShareIcon className={classNames(iconClasses, "rotate-90")} />;
   }
 };
 
 const nextMode = (m: Mode): Mode => {
   switch (m) {
     case "text":
-      return "tree";
-    case "tree":
+      return "tree 1";
+    case "tree 1":
+      return "tree 2";
+    case "tree 2":
       return "text";
   }
 };

diff --git a/src/components/TreeReactFlow/TreeReactFlow.stories.tsx b/src/components/TreeReactFlow/TreeReactFlow.stories.tsx
@@ -1,6 +1,7 @@
 import { ComponentStory, ComponentMeta } from "@storybook/react";
 import {
   defaultTreeReactFlowProps,
+  inlineTreeReactFlowProps,
   TreeReactFlow,
   TreeReactFlowProps,
 } from "./";
@@ -294,3 +295,20 @@ export const OddAndEvenMiscStyles: ComponentStory<typeof TreeReactFlow> = (
       contents: { def: def5.name, node: { nodeType: "BodyNode", meta: 5 } },
     },
   });
+export const OddAndEvenInline: ComponentStory<typeof TreeReactFlow> = (
+  args: TreeReactFlowProps
+) =>
+  treeSized({
+    ...inlineTreeReactFlowProps,
+    ...args,
+    defs: oddEvenTrees.map(([baseName, term]) => ({
+      name: { qualifiedModule: [], baseName },
+      term,
+      type_: emptyTypeTree(baseName),
+    })),
+    typeDefs: [],
+    selection: {
+      tag: "SelectionDef",
+      contents: { def: def5.name, node: { nodeType: "BodyNode", meta: 5 } },
+    },
+  });
diff --git a/src/components/TreeReactFlow/Types.ts b/src/components/TreeReactFlow/Types.ts
@@ -195,6 +195,7 @@ export type PrimerCommonNodeProps = {
   width: number;
   height: number;
   selected: boolean;
+  style: "inline" | "corner";
 };
 
 /** Our edge type. Much like `PrimerNode`, `PrimerEdge` extends ReactFlow's `Edge`.