@xyo-network/react-typedoc 2.68.2 → 2.69.0

package/src/ReflectionViewer/NameViewer.tsx

@@ -19,17 +19,19 @@ export const NameViewer: React.FC<NameViewerProps> = ({ reflectionViewer, varian
       <FlexRow marginRight={1}>
         <Typography variant={variant} noWrap>
           {reflection.name}
-          {reflection.type ? <>:&nbsp;</> : null}
+          {reflection.type ?
+            <>:&nbsp;</>
+          : null}
         </Typography>
         <SomeTypeViewer reflection={reflection} reflectionViewer={reflectionViewer} />
       </FlexRow>
       <Stack direction="row" spacing={1}>
         <Chip size="small" label={reflection.kind} />
-        {reflection.flags
-          ? Object.entries(reflection.flags).map(([flag, value]) => {
-              return value ? <Chip size="small" key={flag} label={trimFlagLabel(flag)} variant="outlined" /> : null
-            })
-          : null}
+        {reflection.flags ?
+          Object.entries(reflection.flags).map(([flag, value]) => {
+            return value ? <Chip size="small" key={flag} label={trimFlagLabel(flag)} variant="outlined" /> : null
+          })
+        : null}
       </Stack>
       {document && document?.location.hostname === 'localhost' && (
         <JsonViewerButton jsonViewProps={{ collapsed: 1 }} size="small" variant="contained" padding={0} marginX={1} src={reflection} />

package/src/ReflectionViewer/Project.tsx

@@ -19,7 +19,7 @@ export const ProjectReflectionViewer: React.FC<ContainerReflectionViewerProps<Pr
         return reflection.groups?.map((group: ReflectionGroup) => {
           return (
             <ReflectionGroupViewer
-              autoscroll
+              autoScroll
               variant="h6"
               lookup={lookup}
               key={group.title}

package/src/ReflectionViewer/ReflectionGroupViewer.tsx

@@ -10,14 +10,24 @@ import { ReflectionViewer } from './ReflectionViewer'
 import { FlagFilter, ReflectionViewerProps } from './ReflectionViewerProps'
 
 export interface ReflectionGroupViewerProps extends ReflectionViewerProps<ContainerReflection> {
-  autoscroll?: boolean
+  autoScroll?: boolean
   group: ReflectionGroup
   reflection: ContainerReflection
   renderer?: React.FC<ReflectionViewerProps>
 }
 
+const hide = (flags?: ReflectionFlags, hiddenFlags: FlagFilter[] = []) => {
+  let hide = false
+  hiddenFlags.map((hiddenFlag) => {
+    if (flags?.[hiddenFlag]) {
+      hide = true
+    }
+  })
+  return hide
+}
+
 export const ReflectionGroupViewer: React.FC<ReflectionGroupViewerProps> = ({
-  autoscroll = false,
+  autoScroll = false,
   children,
   hiddenFlags,
   group,
@@ -26,52 +36,43 @@ export const ReflectionGroupViewer: React.FC<ReflectionGroupViewerProps> = ({
   variant,
   ...props
 }) => {
-  const hide = (flags?: ReflectionFlags, hiddenFlags: FlagFilter[] = []) => {
-    let hide = false
-    hiddenFlags.map((hiddenFlag) => {
-      if (flags?.[hiddenFlag]) {
-        hide = true
-      }
-    })
-    return hide
-  }
-
-  const resolvedChildern = resolveChildren(group, lookup) ?? []
+  const resolvedChildren = resolveChildren(group, lookup) ?? []
 
-  const visibleChildren = hiddenFlags
-    ? resolvedChildern.reduce((acc, item) => {
+  const visibleChildren =
+    hiddenFlags ?
+      resolvedChildren.reduce((acc, item) => {
         return acc + (hide(item.flags, hiddenFlags) ? 0 : 1)
       }, 0)
     : 1
 
   const { hash } = useLocation()
   useEffect(() => {
-    if (hash && autoscroll) {
+    if (hash && autoScroll) {
       document.querySelector(hash)?.scrollIntoView({ behavior: 'smooth' })
     }
-  }, [hash, autoscroll])
-  return visibleChildren > 0 ? (
-    <FlexCol title="ReflectionGroupViewer" {...props}>
-      <FlexRow marginY={1} justifyContent="flex-start">
-        <Typography variant={variant}>{group.title}</Typography>
-        <JsonViewerButton
-          jsonViewProps={{ collapsed: 1 }}
-          size="small"
-          variant="contained"
-          padding={0}
-          marginX={1}
-          src={resolveChildren(group, lookup)}
-        />
-      </FlexRow>
-      {resolveChildren(group, lookup).map((reflection) => {
-        return reflection ? (
-          // I wrap this in a div since React does not understand that they have keys using the Renderer
-          <div id={reflection.name} key={reflection.id}>
-            {renderer({ hiddenFlags, lookup, margin: 1, padding: 1, reflection })}
-          </div>
-        ) : null
-      })}
-      {children}
-    </FlexCol>
-  ) : null
+  }, [hash, autoScroll])
+  return visibleChildren > 0 ?
+      <FlexCol title="ReflectionGroupViewer" {...props}>
+        <FlexRow marginY={1} justifyContent="flex-start">
+          <Typography variant={variant}>{group.title}</Typography>
+          <JsonViewerButton
+            jsonViewProps={{ collapsed: 1 }}
+            size="small"
+            variant="contained"
+            padding={0}
+            marginX={1}
+            src={resolveChildren(group, lookup)}
+          />
+        </FlexRow>
+        {resolveChildren(group, lookup).map((reflection) => {
+          return reflection ?
+              // I wrap this in a div since React does not understand that they have keys using the Renderer
+              <div id={reflection.name} key={reflection.id}>
+                {renderer({ hiddenFlags, lookup, margin: 1, padding: 1, reflection })}
+              </div>
+            : null
+        })}
+        {children}
+      </FlexCol>
+    : null
 }

package/src/ReflectionViewer/ReflectionViewer.tsx

@@ -20,24 +20,24 @@ export const ReflectionViewer: React.FC<ReflectionViewerProps> = ({ variant, nam
   const someReflection = reflection as SomeReflection
 
   return hide(reflection?.flags, hiddenFlags) ? null : (
-    <FlexCol title="ReflectionViewer" alignItems="stretch" {...props}>
-      {nameViewer === undefined ? (
-        <NameViewer marginY={0.25} variant={variant} reflection={someReflection} reflectionViewer={ReflectionViewer} />
-      ) : (
-        nameViewer
-      )}
-      {reflection.comment ? <CommentViewer comment={reflection.comment} /> : null}
-      {/*sources && reflection.sources && children ? (
+      <FlexCol title="ReflectionViewer" alignItems="stretch" {...props}>
+        {nameViewer === undefined ?
+          <NameViewer marginY={0.25} variant={variant} reflection={someReflection} reflectionViewer={ReflectionViewer} />
+        : nameViewer}
+        {reflection.comment ?
+          <CommentViewer comment={reflection.comment} />
+        : null}
+        {/*sources && reflection.sources && children ? (
         <>
           {reflection.sources.map((source, index) => {
             return <SourceViewer key={index} source={source} />
           })}
         </>
         ) : null*/}
-      {someReflection.parameters?.map((parameter) => {
-        return <ReflectionViewer hiddenFlags={hiddenFlags} marginY={0.25} marginX={1} key={parameter.id} reflection={parameter} />
-      }) ?? null}
-      {children}
-    </FlexCol>
-  )
+        {someReflection.parameters?.map((parameter) => {
+          return <ReflectionViewer hiddenFlags={hiddenFlags} marginY={0.25} marginX={1} key={parameter.id} reflection={parameter} />
+        }) ?? null}
+        {children}
+      </FlexCol>
+    )
 }

package/src/TreeViewer/Reflection.tsx

@@ -41,18 +41,18 @@ export const ReflectionTreeViewer: React.FC<ReflectionTreeViewerProps> = ({ look
             {group.children.map((child, jndex) => {
               const searchTermTrimmed = searchTerm?.trim().toLowerCase()
               const childReflection = typeof child === 'number' ? lookup?.[child as number] : child
-              return childReflection && (!searchTermTrimmed || childReflection.name.toLowerCase().includes(searchTermTrimmed)) ? (
-                <TreeItem
-                  key={`secondary-${index}- ${jndex}`}
-                  nodeId={`declaration-${childReflection?.id}`}
-                  label={childReflection.name}
-                  onClick={() => {
-                    const hash = `#${childReflection.name}`
-                    navigate({ hash })
-                    document.querySelector(hash)?.scrollIntoView({ behavior: 'smooth' })
-                  }}
-                />
-              ) : null
+              return childReflection && (!searchTermTrimmed || childReflection.name.toLowerCase().includes(searchTermTrimmed)) ?
+                  <TreeItem
+                    key={`secondary-${index}- ${jndex}`}
+                    nodeId={`declaration-${childReflection?.id}`}
+                    label={childReflection.name}
+                    onClick={() => {
+                      const hash = `#${childReflection.name}`
+                      navigate({ hash })
+                      document.querySelector(hash)?.scrollIntoView({ behavior: 'smooth' })
+                    }}
+                  />
+                : null
             })}
           </TreeItem>
         ))}

package/src/TreeViewer/ReflectionGroup.tsx

@@ -27,10 +27,10 @@ export const ReflectionGroupTreeViewer: React.FC<ReflectionGroupViewerProps> = (
         />
       </FlexRow>
       {resolveChildren(group, lookup).map((reflection) => {
-        return reflection ? (
-          // I wrap this in a div since React does not understand that they have keys using the Renderer
-          <div key={reflection.id}>{renderer({ lookup, margin: 1, reflection })}</div>
-        ) : null
+        return reflection ?
+            // I wrap this in a div since React does not understand that they have keys using the Renderer
+            <div key={reflection.id}>{renderer({ lookup, margin: 1, reflection })}</div>
+          : null
       })}
       {children}
     </FlexCol>

package/src/TwoPanelReflectionViewer.tsx

@@ -25,7 +25,7 @@ export const TwoPanelReflectionViewer: React.FC<ContainerReflectionViewerProps>
     return reflection.groups?.map((group: ReflectionGroup) => {
       return (
         <ReflectionGroupViewer
-          autoscroll
+          autoScroll
           variant="h6"
           lookup={lookup}
           renderer={itemRenderer}