@pareto-engineering/design-system 2.0.0-alpha.41 → 2.0.0-alpha.42

package/src/ui/a/Popover/Popover.jsx

@@ -0,0 +1,157 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useRef, useLayoutEffect } from 'react'
+
+import PropTypes from 'prop-types'
+
+import styleNames from '@pareto-engineering/bem'
+
+// Local Definitions
+import { useDynamicPosition } from 'ui/utils'
+
+const baseClassName = styleNames.base
+
+const componentClassName = 'popover'
+
+/**
+ * This is the component description.
+ */
+const Popover = ({
+  id,
+  className:userClassName,
+  style,
+  color,
+  children,
+  isOpen,
+  parentRef,
+  preferredPrimaryOrder,
+  preferredSecondaryOrder,
+  offsetXPx,
+  offsetYPx,
+  // ...otherProps
+}) => {
+  useLayoutEffect(() => {
+    import('./styles.scss')
+  }, [])
+
+  const popoverRef = useRef(null)
+  const {
+    primaryPosition,
+    secondaryPosition,
+  } = useDynamicPosition({
+    preferredPrimaryOrder,
+    preferredSecondaryOrder,
+    elementRef:popoverRef,
+    parentRef,
+    offsetXPx,
+    offsetYPx,
+  })
+
+  return (
+    <div
+      id={id}
+      className={[
+        baseClassName,
+        componentClassName,
+        userClassName,
+        isOpen && 'open',
+        `x-${color}`,
+        primaryPosition,
+        secondaryPosition,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={style}
+      ref={popoverRef}
+      // {...otherProps}
+    >
+      {children}
+    </div>
+  )
+}
+
+Popover.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 children JSX
+   */
+  children:PropTypes.node,
+
+  /**
+   * The base color of the popover
+   */
+  color:PropTypes.string,
+
+  /**
+   * Whether the popover should be visible or not
+   */
+  isOpen:PropTypes.bool,
+
+  /**
+   * The preferred primary position order of the popover
+   */
+  preferredPrimaryOrder:PropTypes.arrayOf(
+    PropTypes.oneOf([
+      'bottom',
+      'top',
+      'right',
+      'left',
+    ]),
+  ),
+
+  /**
+   * The preferred secondary position order of the popover
+   */
+  preferredSecondaryOrder:PropTypes.arrayOf(
+    PropTypes.oneOf([
+      'left',
+      'right',
+      'bottom',
+      'top',
+    ]),
+  ),
+
+  /**
+   * The horizonal offset in pixels from the anchor point to the popover
+   */
+  offsetXPx:PropTypes.number,
+
+  /**
+   * The vertical offset in pixels from the anchor point to the popover
+   */
+  offsetYPx:PropTypes.number,
+
+  /**
+   * The reference to the parent element
+   */
+  parentRef:PropTypes.oneOfType([
+    PropTypes.func,
+    PropTypes.shape({ current: PropTypes.instanceOf(Element) }),
+  ]),
+}
+
+Popover.defaultProps = {
+  color                  :'background1',
+  isOpen                 :false,
+  preferredPrimaryOrder  :['bottom', 'top', 'right', 'left'],
+  preferredSecondaryOrder:['left', 'right', 'bottom', 'top'],
+  offsetXPx              :16,
+  offsetYPx              :0,
+}
+
+export default Popover

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

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

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

@@ -0,0 +1,43 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+@use "@pareto-engineering/bem";
+
+$default-padding: 1em;
+$default-margin: 1em;
+$default-border: var(--theme-border-style) var(--metadata);
+
+.#{bem.$base}.popover{
+    position: absolute;
+    z-index: 1;
+    background-color: var(--x);
+    padding: $default-padding;
+    border: $default-border;
+
+     &:not(.open) {
+        display: none;
+    }
+
+    > *:not(:last-child) {
+        margin-bottom: $default-margin / 2;
+    }
+
+  &.bottom {
+    top: 100%;
+    // bottom: 0;
+  }
+
+  &.left {
+    left: 0;
+  }
+
+  &.right {
+    right: 0;
+  }
+
+  &.top {
+    bottom: 100%;
+    top: auto;
+  }
+}
+
+
+

package/src/ui/a/index.js

@@ -28,3 +28,4 @@ export { OvalIllustration } from './OvalIllustration'
 export { SnapScroller } from './SnapScroller'
 export { BackgroundGradient } from './BackgroundGradient'
 export { ContentTree } from './ContentTree'
+export { Popover } from './Popover'

package/src/ui/index.js

@@ -4,3 +4,4 @@ export * from './b'
 export * from './c'
 export * from './d'
 export * from './f'
+export * from './utils'

package/src/ui/utils/hooks/index.js

@@ -0,0 +1,2 @@
+export { default as useWindowSize } from './useWindowSize'
+export { default as useDynamicPosition } from './useDynamicPosition'

package/src/ui/utils/hooks/useDynamicPosition.js

@@ -0,0 +1,104 @@
+import {
+  useState, useEffect, useMemo, useCallback,
+} from 'react'
+import throttle from 'lodash/throttle'
+import useWindowSize from './useWindowSize'
+
+const verticalPositions = ['top', 'bottom']
+const horizontalPositions = ['left', 'right']
+
+const findCompatiblePositions = (primary, secondaryArray) => {
+  if (verticalPositions.includes(primary)) {
+    return secondaryArray.filter((secondary) => horizontalPositions.includes(secondary))
+  } if (horizontalPositions.includes(primary)) {
+    return secondaryArray.filter((secondary) => verticalPositions.includes(secondary))
+  }
+  return []
+}
+
+const useDynamicPosition = ({
+  elementRef,
+  parentRef,
+  preferredPrimaryOrder,
+  preferredSecondaryOrder,
+  // offsetYPx,
+  offsetXPx,
+  throttleMs = 200,
+}) => {
+  const isClient = typeof window === 'object'
+  const {
+    height:currentHeight,
+    width:currentWidth,
+  } = useWindowSize()
+
+  const [primaryPosition, setPrimaryPosition] = useState(preferredPrimaryOrder[0])
+  const compatibleSecondaryPositions = useMemo(
+    () => findCompatiblePositions(
+      primaryPosition,
+      preferredSecondaryOrder,
+    ), [primaryPosition, preferredSecondaryOrder],
+  )
+  const [secondaryPosition, setSecondaryPosition] = useState(compatibleSecondaryPositions[0])
+
+  const handle = useCallback(
+    throttle(() => {
+      const parentNode = parentRef?.current
+      const elementNode = elementRef?.current
+
+      const {
+        top:parentTop,
+        bottom: parentBottom,
+        right: parentRight,
+        left: parentLeft,
+      } = parentNode?.getBoundingClientRect() || {}
+
+      const {
+        width:elementWidth,
+        height:elementHeight,
+      } = elementNode?.getBoundingClientRect() || {}
+
+      const availablePositions = {
+        top   :parentTop >= elementHeight,
+        bottom:currentHeight - parentBottom >= elementHeight,
+        right :parentRight >= elementWidth,
+        left  :currentWidth - parentLeft >= elementWidth,
+      }
+
+      for (let i = 0; i < preferredPrimaryOrder.length; i += 1) {
+        const position = preferredPrimaryOrder[i]
+        if (availablePositions[position]) {
+          setPrimaryPosition(position)
+          break
+        }
+      }
+
+      for (let i = 0; i < compatibleSecondaryPositions.length; i += 1) {
+        const position = compatibleSecondaryPositions[i]
+        if (availablePositions[position]) {
+          setSecondaryPosition(position)
+          break
+        }
+      }
+    }, throttleMs),
+    [elementRef, offsetXPx, throttleMs],
+  )
+
+  useEffect(() => {
+    if (!isClient) {
+      return false
+    }
+
+    handle()
+    window.addEventListener('scroll', handle)
+    window.addEventListener('resize', handle)
+
+    return () => {
+      window.removeEventListener('scroll', handle)
+      window.removeEventListener('resize', handle)
+    }
+  }, [handle])
+
+  return { primaryPosition, secondaryPosition }
+}
+
+export default useDynamicPosition

package/src/ui/utils/hooks/useWindowSize.js

@@ -0,0 +1,32 @@
+import { useCallback, useState, useEffect } from 'react'
+import debounce from 'lodash/debounce'
+
+const useWindowSize = (debounceMs = 700) => {
+  const isClient = typeof window === 'object'
+
+  const getSize = () => ({
+    width :isClient ? window.innerWidth : undefined,
+    height:isClient ? window.innerHeight : undefined,
+  })
+
+  const [windowSize, setWindowSize] = useState(getSize)
+
+  const handle = useCallback(
+    debounce(() => {
+      setWindowSize(getSize())
+    }, debounceMs),
+  )
+
+  useEffect(() => {
+    if (!isClient) {
+      return false
+    }
+
+    window.addEventListener('resize', handle)
+    return () => window.removeEventListener('resize', handle)
+  }, [getSize, handle, isClient])
+
+  return windowSize
+}
+
+export default useWindowSize

package/src/ui/utils/index.js

@@ -0,0 +1 @@
+export { useWindowSize, useDynamicPosition } from './hooks'