@onewelcome/react-lib-components 1.3.0 → 1.4.0

package/src/Tooltip/Tooltip.tsx

@@ -16,6 +16,7 @@
 
 import React, {
   ComponentPropsWithRef,
+  ForwardRefRenderFunction,
   ReactElement,
   ReactNode,
   useEffect,
@@ -50,110 +51,110 @@ const defaultPosition: DefaultPosition = {
   transformOrigin: { horizontal: "left", vertical: "center" }
 };
 
-export const Tooltip = React.forwardRef<HTMLDivElement, Props>(
-  (
-    {
-      children,
-      className,
-      placement = defaultPosition.placement,
-      offset = defaultPosition.offset,
-      transformOrigin = defaultPosition.transformOrigin,
-      domRoot = document.body,
-      label,
-      ...rest
-    }: Props,
-    ref
-  ) => {
-    const [identifier] = useState(generateID());
-    const [visible, setVisible] = useState(false);
-
-    const relativeElement = useRef<HTMLDivElement>(null);
-    const elementToBePositioned = useRef<HTMLDivElement>(null);
-
-    const { top, bottom, right, left, calculatePosition } = usePosition({
-      relativeElement: relativeElement,
-      elementToBePositioned: elementToBePositioned,
-      placement: placement,
-      offset: offset,
-      transformOrigin: transformOrigin
-    });
-
-    useEffect(() => {
-      if (!visible) return;
-
-      function escapePressHandler(event: KeyboardEvent) {
-        if (event.key === "Escape") {
-          setVisible(false);
-        }
-      }
+const TooltipComponent: ForwardRefRenderFunction<HTMLDivElement, Props> = (
+  {
+    children,
+    className,
+    placement = defaultPosition.placement,
+    offset = defaultPosition.offset,
+    transformOrigin = defaultPosition.transformOrigin,
+    domRoot = document.body,
+    label,
+    ...rest
+  }: Props,
+  ref
+) => {
+  const [identifier] = useState(generateID());
+  const [visible, setVisible] = useState(false);
+
+  const relativeElement = useRef<HTMLDivElement>(null);
+  const elementToBePositioned = useRef<HTMLDivElement>(null);
+
+  const { top, bottom, right, left, calculatePosition } = usePosition({
+    relativeElement: relativeElement,
+    elementToBePositioned: elementToBePositioned,
+    placement: placement,
+    offset: offset,
+    transformOrigin: transformOrigin
+  });
 
-      document.addEventListener("keyup", escapePressHandler);
-
-      return () => {
-        document.removeEventListener("keyup", escapePressHandler);
-      };
-    }, [visible]);
-
-    useLayoutEffect(() => {
-      calculatePosition();
-    }, [visible]);
-
-    const renderChildren = () => {
-      if (React.isValidElement(label)) {
-        return React.cloneElement(label as ReactElement, {
-          onFocus: () => setVisible(true),
-          onBlur: () => setVisible(false),
-          "aria-describedby": identifier,
-          tabIndex: 0,
-          className: classes["label"]
-        });
+  useEffect(() => {
+    if (!visible) return;
+
+    function escapePressHandler(event: KeyboardEvent) {
+      if (event.key === "Escape") {
+        setVisible(false);
       }
+    }
+
+    document.addEventListener("keyup", escapePressHandler);
 
-      return (
-        <span
-          className={classes["label"]}
-          tabIndex={0}
-          onFocus={() => setVisible(true)}
-          onBlur={() => setVisible(false)}
-          aria-describedby={identifier}
-        >
-          {label}
-        </span>
-      );
+    return () => {
+      document.removeEventListener("keyup", escapePressHandler);
     };
+  }, [visible]);
+
+  useLayoutEffect(() => {
+    calculatePosition();
+  }, [visible]);
+
+  const renderChildren = () => {
+    if (React.isValidElement(label)) {
+      return React.cloneElement(label as ReactElement, {
+        onFocus: () => setVisible(true),
+        onBlur: () => setVisible(false),
+        "aria-describedby": identifier,
+        tabIndex: 0,
+        className: classes["label"]
+      });
+    }
 
     return (
-      <div {...rest} ref={ref} className={`${classes.wrapper} ${className ?? ""}`}>
-        {renderChildren()}
-        <div className={`${classes["tooltip-wrapper"]}`}>
-          <Icon
-            ref={relativeElement}
-            tag="div"
-            onMouseEnter={() => setVisible(true)}
-            onMouseLeave={() => setVisible(false)}
-            icon={Icons.InfoCircle}
-            className={classes.icon}
-          />
-          {createPortal(
-            <div
-              ref={elementToBePositioned}
-              style={{
-                ...rest.style,
-                top: top,
-                left: left,
-                right: right,
-                bottom: bottom
-              }}
-              aria-hidden={!visible}
-              id={identifier}
-              className={`${classes.tooltip} ${visible ? classes.visible : ""}`}
-            >
-              {children}
-            </div>,
-            domRoot
-          )}
-        </div>
-      </div>
+      <span
+        className={classes["label"]}
+        tabIndex={0}
+        onFocus={() => setVisible(true)}
+        onBlur={() => setVisible(false)}
+        aria-describedby={identifier}
+      >
+        {label}
+      </span>
     );
-  }
-);
+  };
+
+  return (
+    <div {...rest} ref={ref} className={`${classes.wrapper} ${className ?? ""}`}>
+      {renderChildren()}
+      <div className={`${classes["tooltip-wrapper"]}`}>
+        <Icon
+          ref={relativeElement}
+          tag="div"
+          onMouseEnter={() => setVisible(true)}
+          onMouseLeave={() => setVisible(false)}
+          icon={Icons.InfoCircle}
+          className={classes.icon}
+        />
+        {createPortal(
+          <div
+            ref={elementToBePositioned}
+            style={{
+              ...rest.style,
+              top: top,
+              left: left,
+              right: right,
+              bottom: bottom
+            }}
+            aria-hidden={!visible}
+            id={identifier}
+            className={`${classes.tooltip} ${visible ? classes.visible : ""}`}
+          >
+            {children}
+          </div>,
+          domRoot
+        )}
+      </div>
+    </div>
+  );
+};
+
+export const Tooltip = React.forwardRef(TooltipComponent);

package/src/Typography/Typography.tsx

@@ -14,7 +14,7 @@
  *    limitations under the License.
  */
 
-import React, { ComponentPropsWithRef, ReactNode } from "react";
+import React, { ForwardRefRenderFunction, ComponentPropsWithRef, ReactNode } from "react";
 import classes from "./Typography.module.scss";
 import { Spacing, useSpacing } from "../hooks/useSpacing";
 
@@ -56,51 +56,54 @@ export interface Props extends ComponentPropsWithRef<any> {
   spacing?: Spacing;
 }
 
-export const Typography = React.forwardRef<any, Props>(
-  ({ children, variant, tag, style, spacing, className = "", ...rest }: Props, ref) => {
-    if (!validVariants.includes(variant)) {
-      throw new Error(
-        `You entered an invalid variant. You can choose from: ${validVariants}, you entered: ${variant}`
-      );
-    }
+const TypographyComponent: ForwardRefRenderFunction<any, Props> = (
+  { children, variant, tag, style, spacing, className = "", ...rest }: Props,
+  ref
+) => {
+  if (!validVariants.includes(variant)) {
+    throw new Error(
+      `You entered an invalid variant. You can choose from: ${validVariants}, you entered: ${variant}`
+    );
+  }
 
-    const styleWithSpacing = useSpacing(spacing, style);
+  const styleWithSpacing = useSpacing(spacing, style);
 
-    if (!tag) {
-      switch (variant) {
-        case "h1":
-        case "h2":
-        case "h3":
-        case "h4":
-        case "code":
-          tag = variant;
-          break;
-        case "body":
-          tag = "p";
-          break;
-        case "body-bold":
-          tag = "p";
-          break;
-        case "sub-text":
-          tag = "span";
-          break;
-        default:
-          tag = "div";
-          break;
-      }
+  if (!tag) {
+    switch (variant) {
+      case "h1":
+      case "h2":
+      case "h3":
+      case "h4":
+      case "code":
+        tag = variant;
+        break;
+      case "body":
+        tag = "p";
+        break;
+      case "body-bold":
+        tag = "p";
+        break;
+      case "sub-text":
+        tag = "span";
+        break;
+      default:
+        tag = "div";
+        break;
     }
+  }
 
-    let TagName = tag;
+  let TagName = tag;
 
-    return (
-      <TagName
-        {...rest}
-        ref={ref}
-        style={styleWithSpacing}
-        className={`${classes["typography_style_" + variant]} ${className}`}
-      >
-        {children}
-      </TagName>
-    );
-  }
-);
+  return (
+    <TagName
+      {...rest}
+      ref={ref}
+      style={styleWithSpacing}
+      className={`${classes["typography_style_" + variant]} ${className}`}
+    >
+      {children}
+    </TagName>
+  );
+};
+
+export const Typography = React.forwardRef(TypographyComponent);

package/src/Wizard/BaseWizardSteps/BaseWizardSteps.tsx

@@ -14,7 +14,7 @@
  *    limitations under the License.
  */
 
-import React, { ComponentPropsWithRef, Fragment } from "react";
+import React, { ForwardRefRenderFunction, ComponentPropsWithRef, Fragment } from "react";
 import classes from "./BaseWizardSteps.module.scss";
 import { Icon, Icons } from "../../Icon/Icon";
 
@@ -32,59 +32,62 @@ export interface Props extends Omit<ComponentPropsWithRef<"div">, "onClick"> {
   futureStepsClickable?: boolean;
 }
 
-export const BaseWizardSteps = React.forwardRef<HTMLDivElement, Props>(
-  ({ steps, currentStepNo, onClick, futureStepsClickable = false, ...rest }: Props, ref) => {
-    const getStepState = (stepNo: number): StepState => {
-      if (currentStepNo === stepNo) {
-        return "current";
-      } else if (stepNo < currentStepNo) {
-        return "finished";
-      }
-      return "future";
-    };
+const BaseWizardStepsComponent: ForwardRefRenderFunction<HTMLDivElement, Props> = (
+  { steps, currentStepNo, onClick, futureStepsClickable = false, ...rest }: Props,
+  ref
+) => {
+  const getStepState = (stepNo: number): StepState => {
+    if (currentStepNo === stepNo) {
+      return "current";
+    } else if (stepNo < currentStepNo) {
+      return "finished";
+    }
+    return "future";
+  };
 
-    const getStepContent = (stepState: StepState, index: number, disabled?: boolean) => {
-      const stepNumberString = String(index + 1);
-      if (stepState === "finished") {
-        return disabled ? null : <Icon className={classes["checkmark"]} icon={Icons.Checkmark} />;
-      } else {
-        return <Fragment>{stepNumberString}</Fragment>;
-      }
-    };
+  const getStepContent = (stepState: StepState, index: number, disabled?: boolean) => {
+    const stepNumberString = String(index + 1);
+    if (stepState === "finished") {
+      return disabled ? null : <Icon className={classes["checkmark"]} icon={Icons.Checkmark} />;
+    } else {
+      return <Fragment>{stepNumberString}</Fragment>;
+    }
+  };
 
-    const generatedSteps = steps.map((step, index) => {
-      const stepState = getStepState(index);
-      const disabledStyleClassName = step.disabled ? classes["disabled"] : "";
-      const clickableClassName = futureStepsClickable ? classes["clickable"] : "";
-
-      return (
-        <button
-          key={step.label.toLowerCase().replace(/\s/, "-")}
-          disabled={
-            step.disabled ||
-            (stepState === "future" && !futureStepsClickable) ||
-            stepState === "current"
-          }
-          aria-current={stepState === "current" ? "step" : undefined}
-          onClick={() => onClick && onClick(index)}
-          className={`${classes["wizard-element"]} ${classes[stepState]} ${clickableClassName} ${disabledStyleClassName}`}
-        >
-          <div className={classes["number-wrapper"]}>
-            <span className={classes["number"]}>
-              {getStepContent(stepState, index, step.disabled)}
-            </span>
-          </div>
-          <div className={classes["two-line-text-overflow"]}>
-            <span className={classes["label"]}>{step.label}</span>
-          </div>
-        </button>
-      );
-    });
+  const generatedSteps = steps.map((step, index) => {
+    const stepState = getStepState(index);
+    const disabledStyleClassName = step.disabled ? classes["disabled"] : "";
+    const clickableClassName = futureStepsClickable ? classes["clickable"] : "";
 
     return (
-      <div {...rest} ref={ref} className={classes["wizard"]}>
-        {generatedSteps}
-      </div>
+      <button
+        key={step.label.toLowerCase().replace(/\s/, "-")}
+        disabled={
+          step.disabled ||
+          (stepState === "future" && !futureStepsClickable) ||
+          stepState === "current"
+        }
+        aria-current={stepState === "current" ? "step" : undefined}
+        onClick={() => onClick && onClick(index)}
+        className={`${classes["wizard-element"]} ${classes[stepState]} ${clickableClassName} ${disabledStyleClassName}`}
+      >
+        <div className={classes["number-wrapper"]}>
+          <span className={classes["number"]}>
+            {getStepContent(stepState, index, step.disabled)}
+          </span>
+        </div>
+        <div className={classes["two-line-text-overflow"]}>
+          <span className={classes["label"]}>{step.label}</span>
+        </div>
+      </button>
     );
-  }
-);
+  });
+
+  return (
+    <div {...rest} ref={ref} className={classes["wizard"]}>
+      {generatedSteps}
+    </div>
+  );
+};
+
+export const BaseWizardSteps = React.forwardRef(BaseWizardStepsComponent);

package/src/Wizard/WizardSteps/WizardSteps.tsx

@@ -14,7 +14,7 @@
  *    limitations under the License.
  */
 
-import React, { ComponentPropsWithRef, useContext } from "react";
+import React, { ForwardRefRenderFunction, ComponentPropsWithRef, useContext } from "react";
 import { WizardStateContext } from "../WizardStateProvider";
 import { BaseWizardSteps } from "../BaseWizardSteps/BaseWizardSteps";
 import { changeCurrentStepNo } from "../wizardStateReducer";
@@ -23,26 +23,29 @@ export interface Props extends ComponentPropsWithRef<"div"> {
   onStepClick: (currentStepNo: number, selectedStepNo: number) => boolean;
 }
 
-export const WizardSteps = React.forwardRef<HTMLDivElement, Props>(
-  ({ onStepClick, ...rest }: Props, ref) => {
-    const {
-      state: { currentStepNo, mode, steps },
-      dispatch
-    } = useContext(WizardStateContext);
+const WizardStepsComponent: ForwardRefRenderFunction<HTMLDivElement, Props> = (
+  { onStepClick, ...rest }: Props,
+  ref
+) => {
+  const {
+    state: { currentStepNo, mode, steps },
+    dispatch
+  } = useContext(WizardStateContext);
 
-    const onClick = (selectedStepNo: number) => {
-      onStepClick(currentStepNo, selectedStepNo) && dispatch(changeCurrentStepNo(selectedStepNo));
-    };
+  const onClick = (selectedStepNo: number) => {
+    onStepClick(currentStepNo, selectedStepNo) && dispatch(changeCurrentStepNo(selectedStepNo));
+  };
 
-    return (
-      <BaseWizardSteps
-        {...rest}
-        ref={ref}
-        onClick={onClick}
-        steps={steps}
-        currentStepNo={currentStepNo}
-        futureStepsClickable={mode === "edit"}
-      />
-    );
-  }
-);
+  return (
+    <BaseWizardSteps
+      {...rest}
+      ref={ref}
+      onClick={onClick}
+      steps={steps}
+      currentStepNo={currentStepNo}
+      futureStepsClickable={mode === "edit"}
+    />
+  );
+};
+
+export const WizardSteps = React.forwardRef(WizardStepsComponent);

package/src/mixins.module.scss

@@ -14,7 +14,7 @@
  *    limitations under the License.
  */
 
-@import "./readyclasses.module.scss";
+@use "./readyclasses.module.scss";
 
 @mixin button($variant: "text", $type: "default") {
   $disabledSelector: if($type == "link", ".disabled", ":disabled");
@@ -84,7 +84,7 @@
     color: $color;
   }
 
-  @include focusOutline(var(--color-focus));
+  @include readyclasses.focusOutline(var(--color-focus));
 
   &:hover:not(.disabled),
   &:focus:not(.disabled) {

package/src/util/helper.test.tsx

@@ -123,34 +123,6 @@ describe("debounce function", () => {
 });
 
 describe("throttling works", () => {
-  it("throttles the function", async () => {
-    const throttledFunction = jest.fn();
-
-    window.addEventListener("resize", throttle(throttledFunction, 1));
-
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-    await fireEvent.resize(window);
-
-    expect(throttledFunction).not.toHaveBeenCalledTimes(1);
-    expect(throttledFunction).not.toHaveBeenCalledTimes(10);
-  });
-
   it("Works in a react component as well, it should only fire the exampleFunction once.", async () => {
     const ExampleComponent = ({
       throttledFunction

package/dist/Tabs/TabPanel.d.ts

@@ -1,8 +0,0 @@
-import React, { ComponentPropsWithRef } from "react";
-export interface Props extends ComponentPropsWithRef<"div"> {
-    children: React.ReactNode;
-    tabId: string;
-    tabPanelId: string;
-    selected?: boolean;
-}
-export declare const TabPanel: React.ForwardRefExoticComponent<Pick<Props, "slot" | "style" | "title" | "key" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "nonce" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "tabId" | "tabPanelId" | "selected"> & React.RefAttributes<HTMLDivElement>>;