Merge branch 'master' into staging

Author: Theqwertypusher

src/app/components/ComponentMap.tsx

@@ -14,8 +14,10 @@ import getLinkComponent from './getLinkComponent';
 import { onHover, onHoverExit } from '../actions/actions'
 import { useStoreContext } from '../store'
 
-const defaultMargin = { top: 30, left: 30, right: 30, bottom: 70 };
+// setting the base margins for the Map to render in the Chrome extension window.
+const defaultMargin = { top: 30, left: 30, right: 30, bottom: 30 };
 
+// export these types because this will only be used on this page, interface not needed as it will not be re-used.
 export type LinkTypesProps = {
   width: number;
   height: number;
@@ -32,24 +34,26 @@ export default function ComponentMap({
 }: LinkTypesProps) {
 
   const [{ tabs, currentTab }, dispatch] = useStoreContext();
-  // preparing the data to be used for render
+  // This is where we select the last object in the snapshots array from props to allow hierarchy to parse the data for render on the component map per hierarchy layout specifications.
   const lastNode = snapshots.length - 1;
   const data = snapshots[lastNode];
+  // importing custom hooks for the selection tabs.
 
   const [layout, setLayout] = useState<string>('cartesian');
   const [orientation, setOrientation] = useState<string>('horizontal');
   const [linkType, setLinkType] = useState<string>('diagonal');
-  const [stepPercent, setStepPercent] = useState<number>(0.5);
+  const [stepPercent, setStepPercent] = useState<number>(10);
   const forceUpdate = useForceUpdate();
-  // setting the margins for the Map to render in the tab
+
   const innerWidth = totalWidth - margin.left - margin.right;
   const innerHeight = totalHeight - margin.top - margin.bottom;
 
   let origin: { x: number; y: number };
   let sizeWidth: number;
   let sizeHeight: number;
 
-  // rendering for the different tab selections
+  // Conditional statement sets the location of the root node in the middle of the window
+  // Else statement sets the location of the root node to the right or top of the window per dropdown selection.
   if (layout === 'polar') {
     origin = {
       x: innerWidth / 2,
@@ -67,7 +71,12 @@ export default function ComponentMap({
       sizeHeight = innerWidth;
     }
   }
-  // controls for the map
+
+  // render controls for the map
+  // svg - complete layout of self contained component map
+  // Tree is rendering each component from the component tree.
+  // rect- Contains both text and rectangle node information for rendering each component on the map.
+  // circle- setup and layout for the root node.
   const LinkComponent = getLinkComponent({ layout, linkType, orientation });
   return totalWidth < 10 ? null : (
     <div>
@@ -89,7 +98,7 @@ export default function ComponentMap({
           <Tree
             root={hierarchy(data, (d) => (d.isExpanded ? null : d.children))}
             size={[sizeWidth, sizeHeight]}
-            separation={(a, b) => (a.parent === b.parent ? 1 : 0.5) / a.depth}
+            separation={(a, b) => (a.parent === b.parent ? 10 : 0) / a.depth}
           >
             {(tree) => (
               <Group top={origin.y} left={origin.x}>
@@ -103,7 +112,7 @@ export default function ComponentMap({
                     fill='none'
                   />
                 ))}
-
+                translate
                 {tree.descendants().map((node, key) => {
                   const width = 40;
                   const height = 15;

src/app/components/LinkControls.tsx

@@ -1,7 +1,8 @@
+import { link } from 'fs';
 import React from 'react';
 
 const controlStyles = { fontSize: 10 };
-
+// props for orientation controls
 type Props = {
   layout: string;
   orientation: string;
@@ -12,7 +13,7 @@ type Props = {
   setLinkType: (linkType: string) => void;
   setStepPercent: (percent: number) => void;
 };
-
+// below are the control options for each of the drop downs.
 export default function LinkControls({
   layout,
   orientation,
@@ -54,7 +55,6 @@ export default function LinkControls({
       >
         <option value='diagonal'>Diagonal</option>
         <option value='step'>Step</option>
-        <option value='curve'>Curve</option>
         <option value='line'>Line</option>
       </select>
       {linkType === 'step' && layout !== 'polar' && (
@@ -65,7 +65,7 @@ export default function LinkControls({
             onClick={(e) => e.stopPropagation()}
             type='range'
             min={0}
-            max={1}
+            max={5}
             step={0.1}
             onChange={(e) => setStepPercent(Number(e.target.value))}
             value={stepPercent}

src/app/components/StateRoute.tsx

@@ -45,6 +45,7 @@ export interface StateRouteProps {
 const StateRoute = (props: StateRouteProps) => {
   const { snapshot, hierarchy, snapshots, viewIndex } = props;
 
+
   const [{ tabs, currentTab }, dispatch] = useStoreContext();
   const { hierarchy, sliderIndex, viewIndex } = tabs[currentTab];
   const isRecoil = snapshot.atomsComponents ? true : false;
@@ -71,13 +72,12 @@ const StateRoute = (props: StateRouteProps) => {
         </ParentSize>
       );
     }
-    return <div className="noState">{NO_STATE_MSG}</div>;
+    return <div className='noState'>{NO_STATE_MSG}</div>;
   };
 
   // the hierarchy gets set on the first click in the page
   // when the page is refreshed we may not have a hierarchy, so we need to check if hierarchy was initialized
-  // if true involk render chart with hierarchy
-  //* we wrap History in a ParentSize div, in order to make use of Visx's Zoom functionality
+  // if true invoke render chart with hierarchy
   const renderHistory = () => {
     if (hierarchy) {
       return (<History
@@ -87,7 +87,7 @@ const StateRoute = (props: StateRouteProps) => {
       viewIndex={viewIndex}
       />)
     }
-    return <div className="noState">{NO_STATE_MSG}</div>;
+    return <div className='noState'>{NO_STATE_MSG}</div>;
   };
 
   const renderAtomsRelationship = () => (
@@ -103,12 +103,12 @@ const StateRoute = (props: StateRouteProps) => {
 
   // the hierarchy gets set on the first click in the page
   // when the page is refreshed we may not have a hierarchy, so we need to check if hierarchy was initialized
-  // if true involk render Tree with snapshot
+  // if true invoke render Tree with snapshot
   const renderTree = () => {
     if (hierarchy) {
       return <Tree snapshot={snapshot} />;
     }
-    return <div className="noState">{NO_STATE_MSG}</div>;
+    return <div className='noState'>{NO_STATE_MSG}</div>;
   };
 
   const renderPerfView = () => {
@@ -134,55 +134,55 @@ const StateRoute = (props: StateRouteProps) => {
         // />
       );
     }
-    return <div className="noState">{NO_STATE_MSG}</div>;
+    return <div className='noState'>{NO_STATE_MSG}</div>;
   };
 
   return (
     <Router>
-      <div className="navbar">
+      <div className='navbar'>
         <NavLink
-          className="router-link"
-          activeClassName="is-active"
+          className='router-link'
+          activeClassName='is-active'
           exact
-          to="/"
+          to='/'
         >
           Tree
         </NavLink>
         <NavLink
-          className="router-link"
-          activeClassName="is-active"
-          to="/history"
+          className='router-link'
+          activeClassName='is-active'
+          to='/history'
         >
           History
         </NavLink>
-        <NavLink className="router-link" activeClassName="is-active" to="/map">
+        <NavLink className='router-link' activeClassName='is-active' to='/map'>
           Map
         </NavLink>
 
         {isRecoil && (
           <NavLink
-            className="router-link"
-            activeClassName="is-active"
-            to="/relationship"
+            className='router-link'
+            activeClassName='is-active'
+            to='/relationship'
           >
             AtomsRecoil
           </NavLink>
         )}
 
         <NavLink
-          className="router-link"
-          activeClassName="is-active"
-          to="/performance"
+          className='router-link'
+          activeClassName='is-active'
+          to='/performance'
         >
           Performance
         </NavLink>
       </div>
       <Switch>
-        <Route path="/map" render={renderComponentMap} />
-        <Route path="/history" render={renderHistory} />
-        <Route path="/relationship" render={renderAtomsRelationship} />
-        <Route path="/performance" render={renderPerfView} />
-        <Route path="/" render={renderTree} />
+        <Route path='/map' render={renderComponentMap} />
+        <Route path='/history' render={renderHistory} />
+        <Route path='/relationship' render={renderAtomsRelationship} />
+        <Route path='/performance' render={renderPerfView} />
+        <Route path='/' render={renderTree} />
       </Switch>
     </Router>
   );

src/app/components/getLinkComponent.ts

@@ -13,6 +13,7 @@ import {
   LinkRadialLine,
 } from '@visx/shape';
 
+// conditional's to adjust the controls for the componentMap drop downs
 export default function getLinkComponent({
   layout,
   linkType,
@@ -27,8 +28,6 @@ export default function getLinkComponent({
   if (layout === 'polar') {
     if (linkType === 'step') {
       LinkComponent = LinkRadialStep;
-    } else if (linkType === 'curve') {
-      LinkComponent = LinkRadialCurve;
     } else if (linkType === 'line') {
       LinkComponent = LinkRadialLine;
     } else {
@@ -37,17 +36,13 @@ export default function getLinkComponent({
   } else if (orientation === 'vertical') {
     if (linkType === 'step') {
       LinkComponent = LinkVerticalStep;
-    } else if (linkType === 'curve') {
-      LinkComponent = LinkVerticalCurve;
     } else if (linkType === 'line') {
       LinkComponent = LinkVerticalLine;
     } else {
       LinkComponent = LinkVertical;
     }
   } else if (linkType === 'step') {
     LinkComponent = LinkHorizontalStep;
-  } else if (linkType === 'curve') {
-    LinkComponent = LinkHorizontalCurve;
   } else if (linkType === 'line') {
     LinkComponent = LinkHorizontalLine;
   } else {