Skip to content
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

Cancel selection by clicking background, and hide action panel #833

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Cancel selection by clicking background, and hide action panel #833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccbc573
(WIP) Use ReactFlow for selection handling, rather than doing it more…
georgefst Mar 21, 2023
77efa82
Hide action panel when no node is selected
georgefst Mar 21, 2023
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
44 changes: 25 additions & 19 deletions src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
useQueryClient,
UseQueryResult,
} from "@tanstack/react-query";
import deepEqual from "deep-equal";
import { DependencyList, useEffect, useState } from "react";
import { useParams } from "react-router-dom";
import {
Expand Down Expand Up @@ -158,7 +159,7 @@ const AppNoError = ({
module: Module;
imports: Module[];
selection: Selection | undefined;
setSelection: (s: Selection) => void;
setSelection: (s: Selection | undefined) => void;
setProg: (p: Prog) => void;
}): JSX.Element => {
const [level, setLevel] = useState<Level>(initialLevel);
Expand Down Expand Up @@ -186,7 +187,13 @@ const AppNoError = ({
[p.module]
);
return (
<div className="grid h-screen grid-cols-[18rem_auto_20rem]">
<div
className={
selection
? "grid h-screen grid-cols-[18rem_auto_20rem]"
: "grid h-screen grid-cols-[18rem_auto]"
}
>
<div className="overflow-scroll">
<Sidebar
initialMode="T&D"
Expand Down Expand Up @@ -223,20 +230,21 @@ const AppNoError = ({
</div>
<TreeReactFlow
{...(selection && { selection })}
onNodeClick={(_e, node) => {
if (!("nodeType" in node.data)) {
setSelection({
def: node.data.def,
});
} else {
const id = Number(node.id);
// Non-numeric IDs correspond to non-selectable nodes (those with no ID in backend) e.g. pattern constructors.
if (!isNaN(id)) {
setSelection({
def: node.data.def,
node: { id, nodeType: node.data.nodeType },
});
}
onNodeClick={(node) => {
const s: Selection | undefined =
node == undefined
? undefined
: node.type == "primer-def-name"
? {
def: node.data.def,
}
: {
def: node.data.def,
node: { id: Number(node.id), nodeType: node.data.nodeType },
};
// guard needed to avoid infinite loop
if (!deepEqual(selection, s)) {
setSelection(s);
}
}}
defs={p.module.defs}
Expand Down Expand Up @@ -280,9 +288,7 @@ const AppNoError = ({
}}
/>
) : (
<div className="p-10">
Click something on the canvas to see available actions!
</div>
<></>
)}
{showCreateDefModal ? (
<CreateDefModal
Expand Down
3 changes: 2 additions & 1 deletion src/components/TreeReactFlow/Types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ export type PrimerEdge = Edge<Empty> & { zIndex: number };
export type PrimerNode<T = unknown> = {
id: string;
zIndex: number;
selected: boolean;
selectable: boolean; // in the long run, this will be `false` precisely for box nodes
data: PrimerCommonNodeProps & T;
} & (
| { type: "primer"; data: PrimerNodeProps }
Expand Down Expand Up @@ -161,7 +163,6 @@ export type PrimerDefNameNodeProps = {
export type PrimerCommonNodeProps = {
width: number;
height: number;
selected: boolean;
};

export type Positioned<T> = T & {
Expand Down
69 changes: 46 additions & 23 deletions src/components/TreeReactFlow/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import {
NodeProps,
Background,
HandleType,
useNodesState,
useEdgesState,
} from "reactflow";
import "./reactflow.css";
import { useEffect, useId, useState } from "react";
Expand Down Expand Up @@ -62,10 +64,7 @@ type NodeParams = {
};
export type TreeReactFlowProps = {
defs: Def[];
onNodeClick?: (
event: React.MouseEvent,
node: Positioned<PrimerNodeWithDef>
) => void;
onNodeClick: (node: PrimerNodeWithDef | undefined) => void;
treePadding: number;
forestLayout: "Horizontal" | "Vertical";
} & NodeParams;
Expand All @@ -82,8 +81,8 @@ const nodeTypes = {
<div
className={classNames(
{
"ring-4 ring-offset-4": p.data.selected,
"hover:ring-opacity-50": !p.data.selected,
"ring-4 ring-offset-4": p.selected,
"hover:ring-opacity-50": !p.selected,
},
"flex items-center justify-center rounded-md border-4 text-grey-tertiary",
flavorClasses(p.data.flavor)
Expand Down Expand Up @@ -124,8 +123,8 @@ const nodeTypes = {
<div
className={classNames(
{
"ring-4 ring-offset-4": p.data.selected,
"hover:ring-opacity-50": !p.data.selected,
"ring-4 ring-offset-4": p.selected,
"hover:ring-opacity-50": !p.selected,
},
"flex items-center justify-center rounded-md border-4 text-grey-tertiary",
flavorClasses(p.data.flavor)
Expand Down Expand Up @@ -196,10 +195,10 @@ const nodeTypes = {
"rounded-md",
"bg-grey-primary",
"border-8 border-grey-tertiary ring-grey-tertiary",
p.data.selected && "ring-4 ring-offset-4",
p.selected && "ring-4 ring-offset-4",
commonHoverClasses,
"hover:ring-grey-tertiary",
!p.data.selected && "hover:ring-opacity-50"
!p.selected && "hover:ring-opacity-50"
)}
style={{
width: p.data.width,
Expand All @@ -220,7 +219,7 @@ const nodeTypes = {
assertType<
Equal<
PrimerNode,
{ id: string; zIndex: number } & {
{ id: string; zIndex: number; selectable: boolean; selected: boolean } & {
[T in keyof typeof nodeTypes]: {
type: T;
data: Parameters<(typeof nodeTypes)[T]>[0]["data"];
Expand Down Expand Up @@ -284,7 +283,6 @@ const makePrimerNode = async (
const common = {
width: p.nodeWidth,
height: p.nodeHeight,
selected,
nodeType,
...p,
};
Expand Down Expand Up @@ -316,6 +314,8 @@ const makePrimerNode = async (
...common,
},
zIndex,
selectable: true,
selected,
},
(child) => ({
className: flavorEdgeClasses(flavor),
Expand All @@ -337,6 +337,8 @@ const makePrimerNode = async (
...common,
},
zIndex,
selectable: flavor != "PatternCon",
selected,
},
(child) => ({
className: flavorEdgeClasses(flavor),
Expand Down Expand Up @@ -366,6 +368,8 @@ const makePrimerNode = async (
width: 130,
},
zIndex,
selectable: flavor != "PatternApp",
selected,
},
makeChild,
[],
Expand All @@ -382,6 +386,8 @@ const makePrimerNode = async (
width: common.height,
},
zIndex,
selectable: flavor != "PatternApp",
selected,
},
makeChild,
[],
Expand Down Expand Up @@ -412,6 +418,8 @@ const makePrimerNode = async (
height: bodyLayout.height + p.boxPadding,
},
zIndex,
selectable: false,
selected,
},
(child) => ({
className: flavorEdgeClasses(flavor),
Expand Down Expand Up @@ -444,12 +452,17 @@ type PrimerNodeWithDef = Positioned<PrimerNodeWithDefNoPos>;
// It ensures that these are clearly displayed as "one atomic thing",
// i.e. to avoid confused readings that group the type of 'foo' with the body of 'bar' (etc)
export const TreeReactFlow = (p: TreeReactFlowProps) => {
const [{ nodes, edges }, setLayout] = useState<
Graph<PrimerNodeWithDef, PrimerEdge>
>({
nodes: [],
edges: [],
});
console.log(p.selection);
const [nodes1, setNodes, onNodesChange] = useNodesState([]);
const [edges1, setEdges, onEdgesChange] = useEdgesState([]);
const { nodes, edges }: Graph<PrimerNodeWithDef, PrimerEdge> = {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
nodes: nodes1,
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
edges: edges1,
};

useEffect(() => {
(async () => {
Expand All @@ -471,11 +484,12 @@ export const TreeReactFlow = (p: TreeReactFlowProps) => {
def: def.name,
height: p.nodeHeight * 2,
width: p.nodeWidth * 3,
selected:
deepEqual(p.selection?.def, def.name) && !p.selection?.node,
},
type: "primer-def-name",
zIndex: 0,
selectable: true,
selected:
deepEqual(p.selection?.def, def.name) && !p.selection?.node,
};
const defEdge = async (
tree: APITree,
Expand Down Expand Up @@ -559,9 +573,11 @@ export const TreeReactFlow = (p: TreeReactFlowProps) => {
},
[[], 0]
)[0];
setLayout(combineGraphs([...graphs, ...nested.flat()]));
const { nodes, edges } = combineGraphs([...graphs, ...nested.flat()]);
setNodes(nodes);
setEdges(edges);
})();
}, [p]);
}, [p, setEdges, setNodes]);

// ReactFlow requires a unique id to be passed in if there are
// multiple flows on one page. We simply get react to generate
Expand All @@ -570,12 +586,19 @@ export const TreeReactFlow = (p: TreeReactFlowProps) => {

return (
<ReactFlowSafe
onSelectionChange={(ps) => {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
p.onNodeClick(ps.nodes[0]);
}}
id={id}
{...(p.onNodeClick && { onNodeClick: p.onNodeClick })}
nodes={nodes}
edges={edges}
nodeTypes={nodeTypes}
proOptions={{ hideAttribution: true, account: "paid-pro" }}
onNodesChange={onNodesChange}
onEdgesChange={onEdgesChange}
nodesDraggable={false}
>
<Background gap={25} size={1.6} color="#81818a" />
</ReactFlowSafe>
Expand Down