@onewelcome/react-lib-components 0.0.0-experimental-8e3a0fd

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 | React.ReactNode;
+  content?: string | React.ReactNode;
+  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(),
+      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/alertVariables.scss

@@ -0,0 +1,17 @@
+/*!
+ * 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.
+ */
+
+$alert-item-width: 25rem;

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/Banner/Banner.module.scss

@@ -0,0 +1,76 @@
+/*!
+ * 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.
+ */
+
+.banner {
+  padding: 1rem 1.25rem;
+  background-color: var(--light);
+  display: flex;
+  border-width: 0 0 0 var(--banner-border-width);
+  border-style: solid;
+  flex-grow: 0;
+  border-radius: var(--banner-border-radius);
+
+  .container {
+    display: block;
+    margin-left: 1rem;
+    flex: 1;
+    color: var(--default);
+  }
+
+  .headline {
+    margin-bottom: 0.25rem;
+  }
+  .content {
+    margin-bottom: 0;
+  }
+
+  .icon {
+    margin-top: 0.1rem;
+    font-size: var(--font-size-big);
+    line-height: var(--default-line-height);
+  }
+
+  &.info {
+    border-color: var(--info);
+    .icon {
+      color: var(--info);
+    }
+    .headline {
+      color: var(--info);
+    }
+  }
+
+  &.warning {
+    border-color: var(--warning);
+    .icon {
+      color: var(--warning);
+    }
+
+    .headline {
+      color: var(--warning);
+    }
+  }
+  &.error {
+    border-color: var(--error);
+    .icon {
+      color: var(--error);
+    }
+
+    .headline {
+      color: var(--error);
+    }
+  }
+}

package/src/components/Notifications/Banner/Banner.tsx

@@ -0,0 +1,78 @@
+/*
+ * 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, {
+  AriaAttributes,
+  AriaRole,
+  ComponentPropsWithRef,
+  ForwardRefRenderFunction
+} from "react";
+import { Typography } from "../../Typography/Typography";
+import { Icon, Icons } from "../../Icon/Icon";
+import classes from "./Banner.module.scss";
+
+export type BannerType = "error" | "warning" | "info";
+export interface Props extends ComponentPropsWithRef<"section"> {
+  children: string;
+  ariaRole?: AriaRole;
+  ariaLive?: AriaAttributes["aria-live"];
+  ariaLabel?: AriaAttributes["aria-label"];
+  type: BannerType;
+  title: string;
+}
+
+const BannerComponent: ForwardRefRenderFunction<HTMLElement, Props> = (
+  { children, ariaLabel, ariaRole, ariaLive, type, title, ...rest }: Props,
+  ref
+) => {
+  const getIconVariant = (type: BannerType): Icons | null => {
+    switch (type) {
+      case "info":
+        return Icons.InfoCircle;
+      case "error":
+        return Icons.Error;
+      case "warning":
+        return Icons.Warning;
+      default:
+        return null;
+    }
+  };
+
+  const icon = getIconVariant(type);
+
+  return (
+    <section
+      {...rest}
+      ref={ref}
+      aria-live={ariaLive}
+      aria-label={ariaLabel}
+      role={ariaRole}
+      className={`${classes["banner"]} ${classes[type]}`}
+    >
+      {icon && <Icon icon={icon} className={classes["icon"]} />}
+      <div className={classes["container"]}>
+        <Typography variant={"h4"} className={classes["headline"]}>
+          {title}
+        </Typography>
+        <Typography variant={"body"} className={classes["content"]} tag={"p"}>
+          {children}
+        </Typography>
+      </div>
+    </section>
+  );
+};
+
+export const Banner = React.forwardRef(BannerComponent);