All files / molecule/stepper/src index.js

100% Statements 6/6
100% Branches 8/8
100% Functions 1/1
100% Lines 6/6

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113                            1x                                         10x 10x 10x                                                               1x 1x                                                                                    
import {forwardRef, useRef} from 'react'
 
import cx from 'classnames'
import PropTypes from 'prop-types'
 
import useMergeRefs from '@s-ui/react-hooks/lib/useMergeRefs/index.js'
import Poly from '@s-ui/react-primitive-polymorphic-element'
 
import {StepsProvider, useStepsContext} from './context/index.js'
import Step from './Step/Step.js'
import Stepper from './Stepper/Stepper.js'
import {naturalNumber} from './prop-types.js'
import {ALIGNMENT, BASE_CLASS, DESIGN, JUSTIFY_CONTENT} from './settings.js'
 
const MoleculeStepper = forwardRef(
  (
    {
      as = 'ol',
      asSteps = 'li',
      children,
      design = DESIGN.DEFAULT,
      alignment = ALIGNMENT.HORIZONTAL,
      justifyContent = JUSTIFY_CONTENT.LEGACY,
      labels = [],
      steps,
      showLabel = true,
      step,
      icon,
      visitedIcon,
      currentIcon,
      hasConnector = true,
      onChange
    },
    forwardedRef
  ) => {
    const innerRef = useRef()
    const ref = useMergeRefs(innerRef, forwardedRef)
    return (
      <Poly
        as={as}
        ref={ref}
        role="list"
        data-steps={`${steps}`}
        className={cx(BASE_CLASS, [
          `${BASE_CLASS}--design-${design}`,
          `${BASE_CLASS}--alignment-${alignment}`,
          `${BASE_CLASS}--justifyContent-${justifyContent}`
        ])}
      >
        <StepsProvider
          design={design}
          alignment={alignment}
          icon={icon}
          visitedIcon={visitedIcon}
          currentIcon={currentIcon}
          justifyContent={justifyContent}
          as={asSteps}
          hasConnector={hasConnector}
          onChange={onChange}
        >
          <Stepper showLabel={showLabel} steps={steps} step={step} labels={labels}>
            {children}
          </Stepper>
        </StepsProvider>
      </Poly>
    )
  }
)
 
MoleculeStepper.displayName = 'MoleculeStepper'
MoleculeStepper.propTypes = {
  /** element tag **/
  as: PropTypes.element,
  /** element children's tag **/
  asSteps: PropTypes.element,
  /** element orientation **/
  alignment: PropTypes.oneOf(Object.values(ALIGNMENT)),
  /** inner content **/
  children: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.instanceOf(Step)])),
  /** different look and feels **/
  design: PropTypes.oneOf(Object.values(DESIGN)),
  /** element position alignements **/
  justifyContent: PropTypes.oneOf(Object.values(JUSTIFY_CONTENT)),
  /** an array of step tags if there is no children declared **/
  labels: PropTypes.arrayOf(PropTypes.string),
  /** show or not the label **/
  showLabel: PropTypes.bool,
  /** number of steps needed to be inner created **/
  steps: naturalNumber,
  /** current step position **/
  step: naturalNumber,
  /** react-node icon passed to all inner steps **/
  icon: PropTypes.node,
  /** react-node icon passed to all inner visited steps **/
  visitedIcon: PropTypes.node,
  /** react-node icon passed to inner current steps **/
  currentIcon: PropTypes.node,
  /** has or not a connector element between steps **/
  hasConnector: PropTypes.bool,
  /** change handler to get the step fired **/
  onChange: PropTypes.func
}
 
export default MoleculeStepper
 
export {
  ALIGNMENT as moleculeStepperAlignment,
  DESIGN as moleculeStepperDesign,
  JUSTIFY_CONTENT as moleculeStepperJustifyContent,
  useStepsContext,
  Step
}