@pareto-engineering/design-system 2.0.0-alpha.6 → 2.0.0-alpha.60

package/src/ui/a/BackgroundGradient/BackgroundGradient.jsx

@@ -0,0 +1,76 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useLayoutEffect } from 'react'
+
+import PropTypes from 'prop-types'
+
+import styleNames from '@pareto-engineering/bem'
+
+// Local Definitions
+
+const baseClassName = styleNames.base
+
+const componentClassName = 'background-gradient'
+
+/**
+ * This is the component description.
+ */
+const BackgroundGradient = ({
+  id,
+  className:userClassName,
+  style,
+  height,
+  // ...otherProps
+}) => {
+  useLayoutEffect(() => {
+    import('./styles.scss')
+  }, [])
+
+  return (
+    <div
+      id={id}
+      className={[
+
+        baseClassName,
+
+        componentClassName,
+        userClassName,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={{
+        ...style,
+        '--gradient-height':height,
+      }}
+    />
+  )
+}
+
+BackgroundGradient.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id:PropTypes.string,
+
+  /**
+   * The HTML class names for this element
+   */
+  className:PropTypes.string,
+
+  /**
+   * The React-written, css properties for this element.
+   */
+  style:PropTypes.objectOf(PropTypes.string),
+
+  /**
+   * The height of the shape.
+   */
+  height:PropTypes.string,
+}
+
+BackgroundGradient.defaultProps = {
+  // someProp: false,
+}
+
+export default BackgroundGradient

package/src/ui/a/BackgroundGradient/index.js

@@ -0,0 +1,2 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+export { default as BackgroundGradient } from './BackgroundGradient'

package/src/ui/a/BackgroundGradient/styles.scss

@@ -0,0 +1,16 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+@use "@pareto-engineering/bem";
+
+.#{bem.$base}.background-gradient{
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: var(--gradient-height);
+    background-image: linear-gradient(var(--background1), var(--y) 25%, var(--light-y) 75%, var(--background1));
+    opacity: .4;
+    z-index: -1;
+}
+
+
+

package/src/ui/a/ContentTree/ContentTree.jsx

@@ -0,0 +1,88 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useLayoutEffect } from 'react'
+
+import PropTypes from 'prop-types'
+
+import styleNames from '@pareto-engineering/bem'
+
+// Local Definitions
+import { Tree, useContentTree } from './common'
+
+const baseClassName = styleNames.base
+
+const componentClassName = 'content-tree'
+
+/**
+ * This is the component description.
+ */
+const ContentTree = ({
+  id,
+  className:userClassName,
+  style,
+  target,
+  selectors,
+  // ...otherProps
+}) => {
+  useLayoutEffect(() => {
+    import('./styles.scss')
+  }, [])
+
+  const contentTree = useContentTree(target, selectors)
+
+  return (
+    <div
+      id={id}
+      className={[
+
+        baseClassName,
+
+        componentClassName,
+        userClassName,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={style}
+      // {...otherProps}
+    >
+      <Tree tree={contentTree} />
+    </div>
+  )
+}
+
+ContentTree.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id:PropTypes.string,
+
+  /**
+   * The HTML class names for this element
+   */
+  className:PropTypes.string,
+
+  /**
+   * The React-written, css properties for this element.
+   */
+  style:PropTypes.objectOf(PropTypes.string),
+
+  /**
+   * The selectors to use to extract the navigation tree from the content.
+   */
+  selectors:PropTypes.arrayOf(PropTypes.string),
+
+  /**
+   * The reference to the parent element.
+   */
+  target:PropTypes.oneOfType([
+    PropTypes.func,
+    PropTypes.shape({ current: PropTypes.instanceOf(Element) }),
+  ]),
+}
+
+ContentTree.defaultProps = {
+  selectors:['h2', 'h3'],
+}
+
+export default ContentTree

package/src/ui/a/ContentTree/common/Tree/Tree.jsx

@@ -0,0 +1,138 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useState, useEffect, useMemo } from 'react'
+
+import PropTypes from 'prop-types'
+
+import styleNames from '@pareto-engineering/bem'
+
+// Local Definitions
+
+import useFirstVisibleNode from '../useFirstVisibleNode'
+
+const baseClassName = styleNames.base
+
+const componentClassName = 'tree'
+
+/**
+ * This is the component description.
+ */
+const Tree = ({
+  id,
+  className:userClassName,
+  style,
+  tree,
+  displayDepth,
+  // ...otherProps
+}) => {
+  // The nodeIds to be used to get the first visible node
+  const [nodeIds, setNodeIds] = useState([])
+
+  // current visible nodeId
+  const visibleNodeId = useFirstVisibleNode(nodeIds)
+
+  useEffect(() => {
+    const node = document.getElementsByClassName(visibleNodeId)[0]
+    node?.classList.add(styleNames.modifierActive)
+
+    return () => {
+      node?.classList.remove(styleNames.modifierActive)
+    }
+  }, [visibleNodeId])
+
+  // Generate the tree structure from the content tree data depending on the display depth
+  const getNestedTree = (node, depth) => {
+    setNodeIds((prev) => [...prev, node.id])
+    if (depth <= 1) {
+      return (
+        <li key={node.id}>
+          <a
+            className={node.id}
+            href={node.id}
+          >
+            {node.text}
+          </a>
+        </li>
+      )
+    }
+    return (
+      <li key={node.id}>
+        <p>
+          <a
+            href={node.id}
+            className={node.id}
+          >
+            {node.text}
+          </a>
+        </p>
+        {node.children.length > 0 && (
+        <ul>
+          {node.children.map((child) => getNestedTree(child, depth - 1))}
+        </ul>
+        )}
+      </li>
+    )
+  }
+
+  const ContentTree = useMemo(
+    () => tree.map((node) => getNestedTree(node, displayDepth)),
+    [tree],
+  )
+
+  return (
+    <ul
+      id={id}
+      className={[
+
+        baseClassName,
+
+        componentClassName,
+        userClassName,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={style}
+    >
+      {ContentTree}
+    </ul>
+  )
+}
+Tree.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id:PropTypes.string,
+
+  /**
+   * The HTML class names for this element
+   */
+  className:PropTypes.string,
+
+  /**
+   * The React-written, css properties for this element.
+   */
+  style:PropTypes.objectOf(PropTypes.string),
+
+  /**
+   * The tree to render.
+   */
+  tree:PropTypes.arrayOf(PropTypes.shape({
+    text    :PropTypes.string,
+    id      :PropTypes.string,
+    children:PropTypes.arrayOf(PropTypes.shape({
+      text:PropTypes.string, id:PropTypes.string,
+    })),
+  })),
+
+  /**
+   * The levels of the tree to display.
+   */
+  displayDepth:PropTypes.number,
+}
+
+Tree.defaultProps = {
+  displayDepth:4,
+}
+
+export default Tree

package/src/ui/a/ContentTree/common/Tree/index.js

@@ -0,0 +1,2 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+export { default as Tree } from './Tree'

package/src/ui/a/ContentTree/common/index.js

@@ -0,0 +1,3 @@
+export { default as useContentTree } from './useContentTree'
+export { default as useFirstVisibleNode } from './useFirstVisibleNode'
+export { Tree } from './Tree'

package/src/ui/a/ContentTree/common/useContentTree.js

@@ -0,0 +1,83 @@
+import { useState, useEffect, useCallback } from 'react'
+
+const useContentTree = (target, selectors) => {
+  const [contentTree, setContentTree] = useState([])
+
+  const getNodes = useCallback((parentTag) => {
+    const nodeList = parentTag.querySelectorAll(selectors.join(', '))
+    const nodes = []
+
+    nodeList.forEach((nodeNode) => {
+      const { id, innerText, tagName } = nodeNode
+
+      nodes.push({
+        id   :`#${id}`,
+        text :innerText,
+        level:selectors.indexOf(tagName.toLowerCase()),
+      })
+    })
+
+    return nodes
+  }, [selectors])
+
+  const buildTree = useCallback((nodes) => {
+    // Track the nodes we've seen so far in the same level
+    const currentSameLevelNodes = []
+    // Track nodes of the next level which will be children of the current node
+    let nextLevelNodes = []
+    // Track the current node level
+    let lastLevel = -1
+
+    // If the nodes are empty, return an empty tree
+    if (nodes.length === 0) {
+      return []
+    }
+
+    const buildSubTree = () => {
+      if (nextLevelNodes.length > 0) {
+        currentSameLevelNodes[currentSameLevelNodes.length - 1].children.push(
+          ...buildTree(nextLevelNodes),
+        )
+      }
+    }
+
+    nodes.forEach((node) => {
+      // If the node is of a greater level, we need to build the sub tree
+      if (lastLevel !== -1 && lastLevel < node.level) {
+        nextLevelNodes.push(node)
+        return
+      }
+
+      // build a subtree
+      buildSubTree()
+
+      // reset the next level nodes
+      lastLevel = node.level
+      // add the current node to the current level nodes
+      currentSameLevelNodes.push({
+        id      :node.id,
+        text    :node.text,
+        children:[],
+      })
+      // reset the next level nodes after building the subtree
+      nextLevelNodes = []
+    })
+
+    // build subtree
+    buildSubTree()
+
+    return currentSameLevelNodes
+  }, [])
+
+  useEffect(() => {
+    if (target.current) {
+      const nodes = getNodes(target.current)
+      const tree = buildTree(nodes)
+      setContentTree(tree)
+    }
+  }, [target.current])
+
+  return contentTree
+}
+
+export default useContentTree

package/src/ui/a/ContentTree/common/useFirstVisibleNode.js

@@ -0,0 +1,59 @@
+import {
+  useState, useEffect, useMemo, useCallback,
+} from 'react'
+import debounce from 'lodash/debounce'
+
+const useFirstVisibleNode = (nodeIds, config) => {
+  const [visibleNodeId, setVisibleNodeId] = useState(null)
+
+  const { debounceMs = 25 } = config || {}
+
+  // get headlines nodes - Should only be recalculated when the ids change
+  const nodes = useMemo(() => {
+    if (nodeIds?.length > 0) {
+      return Array.from(document.querySelectorAll(nodeIds.join(',')))
+    }
+    return []
+  }, [nodeIds])
+
+  const getVisibleNodeId = useCallback(debounce(() => {
+    // Get the top postion of each headline node relative to the viewport
+    const topOffsets = nodes.map((node) => node.getBoundingClientRect().top)
+
+    // Get the node closer to zero (the top of the viewport)
+    // We have the default offset as Infinity so it's always greater that the first node Y position
+    const visibleNode = topOffsets.reduce(
+      (prev, currentOffset, currentIndex) => {
+        const node = Math.abs(currentOffset - 0) < Math.abs(prev.offset - 0)
+          ? { node: nodes[currentIndex], offset: currentOffset }
+          : prev
+
+        return node
+      }, { node: nodes[0], offset: Infinity },
+    )
+
+    // Set the visible node id
+    setVisibleNodeId(`#${visibleNode?.node?.id}`)
+  }, debounceMs), [nodes])
+
+  // Recalculate the visible node id when the page is scrolled
+  useEffect(() => {
+    window.addEventListener('scroll', getVisibleNodeId)
+
+    return () => {
+      window.removeEventListener('scroll', getVisibleNodeId)
+    }
+  }, [getVisibleNodeId])
+
+  // Recalculate the visible node id when the page is resized
+  useEffect(() => {
+    window.addEventListener('resize', getVisibleNodeId)
+    return () => {
+      window.removeEventListener('resize', getVisibleNodeId)
+    }
+  }, [getVisibleNodeId])
+
+  return visibleNodeId
+}
+
+export default useFirstVisibleNode

package/src/ui/a/ContentTree/index.js

@@ -0,0 +1,2 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+export { default as ContentTree } from './ContentTree'

package/src/ui/a/ContentTree/styles.scss

@@ -0,0 +1,33 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+@use "@pareto-engineering/bem";
+
+$default-margin: 1em;
+$default-padding: 1em;
+
+.#{bem.$base}.content-tree{
+
+    ul {
+        list-style: none;
+    }
+
+    .#{bem.$base}.tree {
+       position: sticky;
+       top: 0;
+       padding: 0;
+
+       .#{bem.$modifier-active} {
+         color: var(--main2);
+         transition: color 0.2s;
+       }
+
+       li:not(:last-child) {
+           margin-bottom: $default-margin;
+           ul {
+               padding-left: $default-padding;
+           }
+       }
+    }
+}
+
+
+

package/src/ui/a/Conversation/Conversation.jsx

@@ -28,14 +28,13 @@ const Conversation = ({
   ourColor,
   theirColor,
   children,
+  hasTriangle,
   // ...otherProps
 }) => {
   useLayoutEffect(() => {
     import('./styles.scss')
   }, [])
 
-  // const messageColors = { ours: color, theirs: 'main2' }
-
   return (
     <ConversationContext.Provider
       value={{
@@ -49,6 +48,7 @@ const Conversation = ({
           baseClassName,
           componentClassName,
           userClassName,
+          hasTriangle && 'has-triangle',
           `y-${backgroundColor}`,
           'u1',
         ]
@@ -76,11 +76,13 @@ Conversation.propTypes = {
   /**
    * The React-written, css properties for this element.
    */
-  style     :PropTypes.objectOf(PropTypes.string),
+  style:PropTypes.objectOf(PropTypes.string),
+
   /**
    * The base color to our messages component
    */
-  ourColor  :PropTypes.string,
+  ourColor:PropTypes.string,
+
   /**
    * The base color to their messages component
    */
@@ -94,12 +96,18 @@ Conversation.propTypes = {
    *  The children JSX
    */
   children       :PropTypes.node,
+
+  /**
+   * whether to add triangle to bubble chats
+   */
+  hasTriangle:PropTypes.bool,
 }
 
 Conversation.defaultProps = {
-  backgroundColor:'background',
-  ourColor       :'main2',
-  theirColor     :'background2',
+  backgroundColor:'background2',
+  ourColor       :'background1',
+  theirColor     :'background1',
+  hasTriangle    :false,
 }
 
 Conversation.Message = Message

package/src/ui/a/Conversation/common/Message/Message.jsx

@@ -23,6 +23,9 @@ const Message = ({
   message,
   sender,
   from,
+  attachment,
+  attachmentIcon,
+  attachmentColor,
   // ...otherProps
 }) => {
   const { ourColor, theirColor } = useConversation()
@@ -36,6 +39,7 @@ const Message = ({
         userClassName,
         `x-${from === 'ours' ? ourColor : theirColor}`,
         from === 'ours' && 'ours',
+        'v1',
       ]
         .filter((e) => e)
         .join(' ')}
@@ -49,11 +53,19 @@ const Message = ({
         <p>
           {message}
         </p>
+        {attachment
+      && (
+      <div className={`attachment y-${attachmentColor}`}>
+        <span className="f-icons">{attachmentIcon}</span>
+        <p className="ml-v">
+          {attachment}
+        </p>
+      </div>
+      )}
       </div>
     </div>
   )
 }
-
 Message.propTypes = {
   /**
    * The HTML id for this element
@@ -65,26 +77,46 @@ Message.propTypes = {
    */
   className:PropTypes.string,
 
+  /**
+   * The React-written, css properties for this element.
+   */
+  style:PropTypes.objectOf(PropTypes.string),
+
   /**
    * The message in the conversation
    */
   message:PropTypes.string.isRequired,
+
   /**
    * The sender of the message
    */
-  sender :PropTypes.string.isRequired,
+  sender:PropTypes.string.isRequired,
+
   /**
    * The owner of the message
    */
-  from   :PropTypes.oneOf(['ours', 'theirs']),
+  from:PropTypes.oneOf(['ours', 'theirs']),
+
   /**
-   * The React-written, css properties for this element.
+   * name of the attachment file
+   */
+  attachment:PropTypes.string,
+
+  /**
+   * source of the attachment icon
+   */
+  attachmentIcon:PropTypes.string,
+
+  /**
+   * background color of the attachment box
    */
-  style  :PropTypes.objectOf(PropTypes.string),
+  attachmentColor:PropTypes.string,
 }
 
 Message.defaultProps = {
-  from:'theirs',
+  from           :'theirs',
+  attachmentIcon :'A',
+  attachmentColor:'main4',
 }
 
 export default Message