@onewelcome/react-lib-components 6.5.0 → 6.7.0

package/src/components/Notifications/Alert/AlertItem/AlertItem.tsx

@@ -0,0 +1,214 @@
+/*
+ * Copyright 2022 OneWelcome B.V.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+import React, { ButtonHTMLAttributes, useContext, useEffect, useRef } from "react";
+import { IconButton } from "../../../Button/IconButton";
+import { Icon, Icons } from "../../../Icon/Icon";
+import classes from "./AlertItem.module.scss";
+import readyclasses from "../../../../readyclasses.module.scss";
+import { useAnimation } from "../../../../hooks/useAnimation";
+import { Typography } from "../../../Typography/Typography";
+import AlertContext from "../AlertProvider/AlertContext";
+
+export const EMPHASES = ["low", "medium", "high"] as const;
+export type Emphasis = (typeof EMPHASES)[keyof typeof EMPHASES];
+
+export const VARIANTS = ["neutral", "informative", "success", "warning", "error"] as const;
+export type Variant = (typeof VARIANTS)[keyof typeof VARIANTS];
+
+export type Actions = (ButtonHTMLAttributes<HTMLButtonElement> & { label: string })[];
+
+export interface Props {
+  id: string;
+  title?: string;
+  content?: string;
+  duration?: number;
+  emphasis?: Emphasis;
+  variant?: Variant;
+  className?: string;
+  onClose?: () => void;
+  closeButtonTitle?: string;
+  actions?: Actions;
+  wasShown?: boolean;
+}
+
+const useRegisterAlertHeight = (
+  singleAlertRef: React.RefObject<HTMLDivElement>,
+  alertId: string
+) => {
+  const ctx = useContext(AlertContext);
+
+  useEffect(() => {
+    if (singleAlertRef.current) {
+      ctx.setAlertHeight(alertId, singleAlertRef.current.getBoundingClientRect().height);
+    }
+  }, [singleAlertRef.current]);
+};
+
+let actionButtonKeyCounter = 1;
+export const AlertItem = ({
+  id,
+  title,
+  duration,
+  variant = "neutral",
+  emphasis = "low",
+  content,
+  className,
+  actions = [],
+  onClose,
+  closeButtonTitle,
+  wasShown
+}: Props) => {
+  const timerHandler = useRef<ReturnType<typeof setTimeout>>();
+  const onAnimationEnd = () => {
+    onClose?.();
+  };
+  const { ref, animationStarted, startAnimation } = useAnimation<HTMLDivElement>(onAnimationEnd);
+
+  useRegisterAlertHeight(ref, id);
+
+  useEffect(() => {
+    if (duration && duration > 0) {
+      timerHandler.current = setTimeout(() => startAnimation(), duration);
+    }
+    if (ref) {
+      ref.current?.addEventListener("focus", onItemFocus);
+      ref.current?.addEventListener("blur", onItemBlur);
+      ref.current?.addEventListener("mouseenter", onItemFocus);
+      ref.current?.addEventListener("mouseleave", onItemBlur);
+    }
+    return () => {
+      timerHandler.current && clearTimeout(timerHandler.current);
+    };
+  }, []);
+
+  const onItemFocus = () => {
+    timerHandler.current && clearTimeout(timerHandler.current);
+  };
+
+  const onItemBlur = () => {
+    if (duration && duration > 0) {
+      timerHandler.current = setTimeout(() => startAnimation(), duration);
+    }
+  };
+
+  const getVariantIcon = () => {
+    if (variant === "error") {
+      return Icons.ErrorAlt;
+    }
+
+    if (variant === "warning") {
+      return Icons.Warning;
+    }
+
+    return variant === "success" ? Icons.CheckmarkCircleAlt : Icons.InfoCircle;
+  };
+
+  const actionButtons = actions.map(actionProp => (
+    <button
+      key={`alert-action-button-${(actionButtonKeyCounter++).toString()}`}
+      {...actionProp}
+      onClick={e => {
+        onClose?.();
+        actionProp.onClick?.(e);
+      }}
+      className={classes["action-button"]}
+    >
+      {actionProp.label}
+    </button>
+  ));
+
+  const getAlertClasses = (): string => {
+    const alertClasses = [classes["alert"], classes[`${variant}`], classes[`emph-${emphasis}`]];
+    if (animationStarted) {
+      alertClasses.push(readyclasses["slide-out"]);
+    }
+    if (!animationStarted && !wasShown) {
+      alertClasses.push(readyclasses["slide-in"]);
+    }
+    if (className) {
+      alertClasses.push(className);
+    }
+    return alertClasses.join(" ");
+  };
+
+  const getAria = () => {
+    if (variant === "error" && (emphasis === "medium" || emphasis === "high")) {
+      return "assertive";
+    }
+    return "polite";
+  };
+
+  const getContentOrTitle = () => {
+    if (content) {
+      return content;
+    }
+    return title;
+  };
+
+  return (
+    <div
+      {...{ ["data-testid"]: "alert-container" }}
+      ref={ref}
+      aria-live={getAria()}
+      className={getAlertClasses()}
+      role="alert"
+    >
+      <div className={classes["outer-content-wrapper"]}>
+        <Icon icon={getVariantIcon()} className={classes["icon"]} />
+        <div className={classes["content-wrapper"]} role="log">
+          {!!title && !!content && (
+            <Typography
+              {...{ ["data-testid"]: "alert-title" }}
+              className={classes["title"]}
+              variant="body-bold"
+              tag="span"
+            >
+              {title}
+            </Typography>
+          )}
+          {(!!content || !!title) && (
+            <Typography
+              {...{ ["data-testid"]: "alert-content" }}
+              className={classes["content"]}
+              variant="body"
+            >
+              {getContentOrTitle()}
+            </Typography>
+          )}
+        </div>
+      </div>
+      {actionButtons.length > 0 && (
+        <div {...{ ["data-testid"]: "alert-actions" }} className={classes["actions"]}>
+          {actionButtons}
+        </div>
+      )}
+      {onClose && (
+        <IconButton
+          className={classes["close-btn"]}
+          onClick={e => {
+            e.stopPropagation();
+            startAnimation();
+          }}
+          title={closeButtonTitle}
+          {...{ ["data-testid"]: "alert-close" }}
+        >
+          <Icon icon={Icons.Times} />
+        </IconButton>
+      )}
+    </div>
+  );
+};

package/src/components/Notifications/Alert/AlertProvider/AlertContext.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2022 OneWelcome B.V.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+import { AlertEntry } from "./AlertProvider";
+import { createContext } from "react";
+
+export type AlertQueue = Omit<AlertEntry, "id">;
+
+export interface AlertContextValue {
+  enqueueAlert: (entry: AlertQueue) => void;
+  enqueueInfoAlert: (entry: AlertQueue) => void;
+  enqueueSuccessAlert: (entry: AlertQueue) => void;
+  enqueueWarningAlert: (entry: AlertQueue) => void;
+  enqueueErrorAlert: (entry: AlertQueue) => void;
+  setAlertHeight: (id: string, height: number) => void;
+  alerts: AlertEntry[];
+}
+
+const AlertContext = createContext<AlertContextValue>({
+  enqueueAlert: entry => null,
+  enqueueInfoAlert: entry => null,
+  enqueueSuccessAlert: entry => null,
+  enqueueErrorAlert: entry => null,
+  enqueueWarningAlert: entry => null,
+  setAlertHeight: (id, height) => null,
+  alerts: []
+});
+
+export default AlertContext;

package/src/components/Notifications/Alert/AlertProvider/AlertProvider.tsx

@@ -0,0 +1,173 @@
+/*
+ * Copyright 2022 OneWelcome B.V.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+import React, { ReactNode, useRef, useState, useMemo } from "react";
+import { createPortal } from "react-dom";
+import { Placement, AlertContainer } from "../AlertContainer/AlertContainer";
+import { generateID } from "../../../../util/helper";
+import { AlertItem, Props as AlertComponentProps, Variant } from "../AlertItem/AlertItem";
+import { useGetDomRoot } from "../../../../hooks/useGetDomRoot";
+import AlertContext, { AlertContextValue } from "./AlertContext";
+
+/** Short msg is when only title is provided. Long one when content or/and actions are provided (or type is error). */
+interface Duration {
+  long: number;
+  short: number;
+}
+
+export interface Props {
+  closeButtonTitle: string;
+  children?: ReactNode;
+  placement?: Placement;
+  stackSize?: number;
+  domRoot?: HTMLElement;
+  autoHideDuration?: Duration;
+  className?: string;
+}
+
+export type AlertEntry = AlertComponentProps & { height?: number };
+
+export const AlertProvider = ({
+  closeButtonTitle,
+  placement = { vertical: "bottom", horizontal: "center" },
+  autoHideDuration = { long: 8000, short: 4000 },
+  stackSize = 3,
+  domRoot,
+  children,
+  className
+}: Props) => {
+  const [alertEntries, setAlertEntries] = useState<AlertEntry[]>([]);
+  const wrappingDivRef = useRef(null);
+  const { root } = useGetDomRoot(domRoot, wrappingDivRef);
+
+  const getDuration = (entry: Omit<AlertEntry, "id">) => {
+    if (entry.variant === "error") {
+      return autoHideDuration.long;
+    }
+    if (entry.actions?.length) {
+      return autoHideDuration.long;
+    }
+    return autoHideDuration.short;
+  };
+
+  const buildEntryWithVariant = (arg: Omit<AlertEntry, "id">, variant?: Variant): AlertEntry => {
+    let closeTitle = closeButtonTitle;
+    if (arg.closeButtonTitle) {
+      closeTitle = arg.closeButtonTitle;
+    }
+    return {
+      ...arg,
+      variant: variant ?? arg.variant,
+      id: generateID(15, arg.content ?? arg.title),
+      duration: arg.duration ?? getDuration(arg),
+      closeButtonTitle: closeTitle
+    };
+  };
+
+  const enqueueAlert = (arg: Omit<AlertEntry, "id">) => {
+    const newEntry = buildEntryWithVariant(arg);
+    setAlertEntries(entries => [...entries, newEntry]);
+  };
+
+  const enqueueInfoAlert: AlertContextValue["enqueueInfoAlert"] = arg => {
+    const newEntry: AlertEntry = buildEntryWithVariant(arg, "informative");
+    setAlertEntries(entries => [...entries, newEntry]);
+  };
+
+  const enqueueSuccessAlert: AlertContextValue["enqueueSuccessAlert"] = arg => {
+    const newEntry: AlertEntry = buildEntryWithVariant(arg, "success");
+    setAlertEntries(entries => [...entries, newEntry]);
+  };
+
+  const enqueueWarningAlert: AlertContextValue["enqueueWarningAlert"] = arg => {
+    const newEntry: AlertEntry = buildEntryWithVariant(arg, "warning");
+    setAlertEntries(entries => [...entries, newEntry]);
+  };
+
+  const enqueueErrorAlert: AlertContextValue["enqueueErrorAlert"] = arg => {
+    const newEntry: AlertEntry = buildEntryWithVariant(arg, "error");
+    setAlertEntries(entries => [...entries, newEntry]);
+  };
+
+  const setAlertHeight = (id: string, height: number) => {
+    const newAlertsState = alertEntries.map(alertEntry => {
+      if (alertEntry.id !== id) {
+        return alertEntry;
+      }
+      return { ...alertEntry, height };
+    });
+    setAlertEntries(newAlertsState);
+  };
+
+  const removeEntry = (entryId: string) => {
+    setAlertEntries(entries => {
+      return entries.filter((entry, idx) => {
+        if (idx < stackSize) {
+          entries[idx] = { ...entries[idx], wasShown: true };
+        }
+        return entry.id !== entryId;
+      });
+    });
+  };
+
+  const renderAlertList = (): ReactNode => {
+    return alertEntries.slice(0, stackSize).map(entry => (
+      <AlertItem
+        {...entry}
+        key={`${entry.id}`}
+        onClose={() => {
+          removeEntry(entry.id);
+          entry.onClose?.();
+        }}
+      />
+    ));
+  };
+
+  const contextValue = useMemo(
+    () => ({
+      enqueueAlert,
+      enqueueInfoAlert,
+      enqueueSuccessAlert,
+      enqueueErrorAlert,
+      enqueueWarningAlert,
+      setAlertHeight,
+      alerts: alertEntries
+    }),
+    [
+      enqueueAlert,
+      enqueueInfoAlert,
+      enqueueSuccessAlert,
+      enqueueErrorAlert,
+      enqueueWarningAlert,
+      setAlertHeight,
+      alertEntries
+    ]
+  );
+
+  return (
+    <AlertContext.Provider value={contextValue}>
+      {children}
+      <div ref={wrappingDivRef}>
+        {createPortal(
+          <AlertContainer placement={placement} className={className}>
+            {renderAlertList()}
+          </AlertContainer>,
+          root
+        )}
+      </div>
+    </AlertContext.Provider>
+  );
+};

package/src/components/Notifications/Alert/useAlert.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2022 OneWelcome B.V.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+import { useContext } from "react";
+import AlertContext from "./AlertProvider/AlertContext";
+
+export const useAlert = () => {
+  const ctx = useContext(AlertContext);
+
+  return {
+    enqueueAlert: ctx.enqueueAlert,
+    enqueueInfoAlert: ctx.enqueueInfoAlert,
+    enqueueSuccessAlert: ctx.enqueueSuccessAlert,
+    enqueueWarningAlert: ctx.enqueueWarningAlert,
+    enqueueErrorAlert: ctx.enqueueErrorAlert
+  };
+};

package/src/components/Notifications/Snackbar/SnackbarContainer/SnackbarContainer.tsx

@@ -18,11 +18,17 @@ import React, { useContext, useEffect, useState } from "react";
 import classes from "./SnackbarContainer.module.scss";
 import { SnackbarContext } from "../SnackbarProvider/SnackbarStateProvider";
 
+/**
+ * @deprecated
+ */
 export interface Placement {
   vertical: "top" | "bottom";
   horizontal: "start" | "center" | "end";
 }
 
+/**
+ * @deprecated
+ */
 export interface Props {
   placement: Placement;
   children?: React.ReactNode;
@@ -66,6 +72,9 @@ const useSnackbarContainerHeightAnimation = () => {
   return { height, justifyContent };
 };
 
+/**
+ * @deprecated
+ */
 export const SnackbarContainer = ({ placement, children, zIndex, className, ...rest }: Props) => {
   const { height, justifyContent } = useSnackbarContainerHeightAnimation();
 

package/src/components/Notifications/Snackbar/SnackbarItem/SnackbarItem.tsx

@@ -26,6 +26,9 @@ import { SnackbarContext } from "../SnackbarProvider/SnackbarStateProvider";
 
 const textColor = "var(--snackbar-text-color)";
 
+/**
+ * @deprecated
+ */
 export interface Props {
   id: string;
   title?: string;
@@ -51,6 +54,9 @@ const useRegisterSnackbarHeight = (
   }, [singleSnackbarRef.current]);
 };
 
+/**
+ * @deprecated
+ */
 export const SnackbarItem = ({
   id,
   title,

package/src/components/Notifications/Snackbar/SnackbarProvider/SnackbarProvider.tsx

@@ -35,6 +35,9 @@ interface Duration {
   short: number;
 }
 
+/**
+ * @deprecated
+ */
 export interface Props {
   closeButtonTitle: string;
   children?: ReactNode;
@@ -45,6 +48,9 @@ export interface Props {
   className?: string;
 }
 
+/**
+ * @deprecated
+ */
 export interface Item {
   id: string;
   title?: string;
@@ -57,6 +63,9 @@ export interface Item {
   onClose?: () => void;
 }
 
+/**
+ * @deprecated
+ */
 export const SnackbarProvider = (
   {
     closeButtonTitle,

package/src/components/Notifications/Snackbar/SnackbarProvider/SnackbarStateProvider.tsx

@@ -18,6 +18,9 @@ import React, { createContext } from "react";
 import { DeprecatedEnqueueSnackbarType } from "../interfaces";
 import { Item } from "./SnackbarProvider";
 
+/**
+ * @deprecated
+ */
 interface SnackbarContextProps {
   enqueueSnackbar: DeprecatedEnqueueSnackbarType;
   enqueueSuccessSnackbar: DeprecatedEnqueueSnackbarType;
@@ -27,6 +30,9 @@ interface SnackbarContextProps {
   snackbars: Item[];
 }
 
+/**
+ * @deprecated
+ */
 const SnackbarContext = createContext<SnackbarContextProps>({
   enqueueSnackbar: () => null,
   enqueueSuccessSnackbar: () => null,
@@ -41,6 +47,9 @@ interface Props {
   children?: React.ReactNode;
 }
 
+/**
+ * @deprecated
+ */
 const SnackbarContextProvider = ({ children, initialState }: Props) => {
   return <SnackbarContext.Provider value={initialState}>{children}</SnackbarContext.Provider>;
 };

package/src/components/Notifications/Snackbar/interfaces.ts

@@ -16,10 +16,19 @@
 
 import { ButtonHTMLAttributes } from "react";
 
+/**
+ * @deprecated
+ */
 export type Variant = "info" | "success" | "error" | "warning";
 
+/**
+ * @deprecated
+ */
 export type Actions = (ButtonHTMLAttributes<HTMLButtonElement> & { label: string })[];
 
+/**
+ * @deprecated
+ */
 export interface SnackbarOptionsProps {
   actions?: Actions;
   className?: string;
@@ -28,17 +37,26 @@ export interface SnackbarOptionsProps {
   onClose?: () => void;
 }
 
+/**
+ * @deprecated
+ */
 export interface EnqueueSnackbarProps extends SnackbarOptionsProps {
   title?: string;
   content?: string;
 }
 
+/**
+ * @deprecated
+ */
 export type DeprecatedEnqueueSnackbarType = (
   propsOrTitle: EnqueueSnackbarProps | string | undefined,
   content?: string,
   options?: SnackbarOptionsProps
 ) => void;
 
+/**
+ * @deprecated
+ */
 export function isNewEnqueueSnackbarInterface(args: unknown): args is EnqueueSnackbarProps {
   return args !== null && typeof args === "object" && ("title" in args || "content" in args);
 }

package/src/components/Notifications/Snackbar/useSnackbar.ts

@@ -17,6 +17,9 @@
 import { useContext } from "react";
 import { SnackbarContext } from "./SnackbarProvider/SnackbarStateProvider";
 
+/**
+ * @deprecated
+ */
 export const useSnackbar = () => {
   const ctx = useContext(SnackbarContext);
 

package/src/components/Pagination/Pagination.module.scss

@@ -16,8 +16,8 @@
 
 .pagination-wrapper {
   font-family: var(--font-family);
-  font-size: var(--font-size);
-  line-height: var(--default-line-height);
+  font-size: var(--font-size-data-grid);
+  line-height: var(--data-grid-line-height);
   color: var(--greyed-out);
   display: flex;
   flex-direction: column;
@@ -27,10 +27,6 @@
     display: flex;
   }
 
-  label {
-    margin-bottom: 0;
-  }
-
   .form-element {
     height: 2.5rem;
 
@@ -77,6 +73,8 @@
     align-items: center;
 
     label {
+      font-size: var(--font-size-data-grid);
+      line-height: var(--data-grid-line-height);
       font-weight: 500;
       color: var(--color-blue-grey900);
     }

package/src/components/Pagination/Pagination.tsx

@@ -102,7 +102,9 @@ const PaginationComponent: ForwardRefRenderFunction<HTMLDivElement, Props> = (
       <div className={classes["left"]}>
         {pageSize && (
           <div className={classes["per-page"]}>
-            <Label id="page-size-select-label">{translate.itemsPerPage}</Label>
+            <Label id="page-size-select-label" className={classes["label"]}>
+              {translate.itemsPerPage}
+            </Label>
             <Select
               labeledBy="page-size-select-label"
               className={`${classes["form-element"]} ${classes["page-size-select"]}`}