@kaizen/components 1.64.2 → 1.64.4

package/dist/cjs/Notification/InlineNotification/InlineNotification.cjs

@@ -17,7 +17,7 @@ var classnames__default = /*#__PURE__*/_interopDefault(classnames);
  * {@link https://cultureamp.atlassian.net/wiki/spaces/DesignSystem/pages/3082093392/Inline+Notification Guidance} |
  * {@link https://cultureamp.design/storybook/?path=/docs/components-notifications-inline-notification--docs Storybook}
  */
-var InlineNotification = function (_a) {
+var InlineNotification = React.forwardRef(function (_a, ref) {
   var isSubtle = _a.isSubtle,
     _b = _a.hideCloseIcon,
     hideCloseIcon = _b === void 0 ? false : _b,
@@ -28,8 +28,9 @@ var InlineNotification = function (_a) {
   return React__default.default.createElement(GenericNotification.GenericNotification, tslib.__assign({
     style: "inline",
     persistent: persistent || hideCloseIcon,
-    classNameOverride: classnames__default.default(classNameOverride, [isSubtle && GenericNotification_module.subtle])
+    classNameOverride: classnames__default.default(classNameOverride, [isSubtle && GenericNotification_module.subtle]),
+    ref: ref
   }, otherProps));
-};
+});
 InlineNotification.displayName = "InlineNotification";
 exports.InlineNotification = InlineNotification;

package/dist/cjs/Notification/subcomponents/GenericNotification/GenericNotification.cjs

@@ -3,6 +3,7 @@
 var tslib = require('tslib');
 var React = require('react');
 var classnames = require('classnames');
+var isRefObject = require('../../../utils/isRefObject.cjs');
 var CancelButton = require('../CancelButton/CancelButton.cjs');
 var NotificationHeading = require('../NotificationHeading/NotificationHeading.cjs');
 var NotificationIcon = require('../NotificationIcon/NotificationIcon.cjs');
@@ -14,7 +15,7 @@ function _interopDefault(e) {
 }
 var React__default = /*#__PURE__*/_interopDefault(React);
 var classnames__default = /*#__PURE__*/_interopDefault(classnames);
-var GenericNotification = function (_a) {
+var GenericNotification = React.forwardRef(function (_a, ref) {
   var type = _a.type,
     variant = _a.variant,
     style = _a.style,
@@ -34,7 +35,8 @@ var GenericNotification = function (_a) {
   var _d = React.useState(false),
     isRemoved = _d[0],
     setIsRemoved = _d[1];
-  var containerRef = React.useRef(null);
+  var fallbackRef = React.useRef(null);
+  var containerRef = isRefObject.isRefObject(ref) ? ref : fallbackRef;
   React.useEffect(function () {
     requestAnimationFrame(function () {
       if (containerRef.current) {
@@ -83,6 +85,6 @@ var GenericNotification = function (_a) {
       return setIsHidden(true);
     }
   }));
-};
+});
 GenericNotification.displayName = "GenericNotification";
 exports.GenericNotification = GenericNotification;

package/dist/esm/Notification/InlineNotification/InlineNotification.mjs

@@ -1,5 +1,5 @@
 import { __rest, __assign } from 'tslib';
-import React from 'react';
+import React, { forwardRef } from 'react';
 import classnames from 'classnames';
 import { GenericNotification } from '../subcomponents/GenericNotification/GenericNotification.mjs';
 import styles from '../subcomponents/GenericNotification/GenericNotification.module.scss.mjs';
@@ -9,7 +9,7 @@ import styles from '../subcomponents/GenericNotification/GenericNotification.mod
  * {@link https://cultureamp.design/storybook/?path=/docs/components-notifications-inline-notification--docs Storybook}
  */
 const InlineNotification = /*#__PURE__*/function () {
-  const InlineNotification = function (_a) {
+  const InlineNotification = /*#__PURE__*/forwardRef(function (_a, ref) {
     var isSubtle = _a.isSubtle,
       _b = _a.hideCloseIcon,
       hideCloseIcon = _b === void 0 ? false : _b,
@@ -20,9 +20,10 @@ const InlineNotification = /*#__PURE__*/function () {
     return /*#__PURE__*/React.createElement(GenericNotification, __assign({
       style: "inline",
       persistent: persistent || hideCloseIcon,
-      classNameOverride: classnames(classNameOverride, [isSubtle && styles.subtle])
+      classNameOverride: classnames(classNameOverride, [isSubtle && styles.subtle]),
+      ref: ref
     }, otherProps));
-  };
+  });
   InlineNotification.displayName = "InlineNotification";
   return InlineNotification;
 }();

package/dist/esm/Notification/subcomponents/GenericNotification/GenericNotification.mjs

@@ -1,12 +1,13 @@
 import { __rest, __assign } from 'tslib';
-import React, { useState, useRef, useEffect } from 'react';
+import React, { forwardRef, useState, useRef, useEffect } from 'react';
 import classnames from 'classnames';
+import { isRefObject } from '../../../utils/isRefObject.mjs';
 import { CancelButton } from '../CancelButton/CancelButton.mjs';
 import { NotificationHeading } from '../NotificationHeading/NotificationHeading.mjs';
 import { NotificationIconType, NotificationIconVariant } from '../NotificationIcon/NotificationIcon.mjs';
 import styles from './GenericNotification.module.scss.mjs';
 const GenericNotification = /*#__PURE__*/function () {
-  const GenericNotification = function (_a) {
+  const GenericNotification = /*#__PURE__*/forwardRef(function (_a, ref) {
     var type = _a.type,
       variant = _a.variant,
       style = _a.style,
@@ -26,7 +27,8 @@ const GenericNotification = /*#__PURE__*/function () {
     var _d = useState(false),
       isRemoved = _d[0],
       setIsRemoved = _d[1];
-    var containerRef = useRef(null);
+    var fallbackRef = useRef(null);
+    var containerRef = isRefObject(ref) ? ref : fallbackRef;
     useEffect(function () {
       requestAnimationFrame(function () {
         if (containerRef.current) {
@@ -75,7 +77,7 @@ const GenericNotification = /*#__PURE__*/function () {
         return setIsHidden(true);
       }
     }));
-  };
+  });
   GenericNotification.displayName = "GenericNotification";
   return GenericNotification;
 }();

package/dist/styles.css

@@ -89,36 +89,6 @@
 .MenuItem-module_item__DPerF[data-disabled] {
   opacity: 0.3;
 }
-.Menu-module_menu__iHYqh {
-  background-color: var(--color-white);
-  color: var(--color-purple-800);
-  width: 248px;
-  max-height: 22rem;
-  overflow: auto;
-  padding-block: var(--spacing-6);
-  outline: none;
-  border-radius: var(--border-solid-border-radius);
-  box-shadow: var(--shadow-large-box-shadow);
-}
-
-.Menu-module_menu__iHYqh .react-aria-Header {
-  font-family: var(--typography-heading-6-font-family);
-  font-size: var(--typography-heading-6-font-size);
-  letter-spacing: var(--typography-heading-6-letter-spacing);
-  font-weight: var(--typography-heading-6-font-weight);
-  line-height: var(--typography-heading-6-line-height);
-  padding: var(--spacing-6) 10px;
-  margin-inline: var(--spacing-6);
-}
-
-.Menu-module_menu__iHYqh section:not(:last-of-type)::after {
-  width: 100%;
-  height: 1px;
-  background-color: var(--border-solid-border-color);
-  content: "";
-  display: block;
-  margin-block: var(--spacing-6);
-}
 .Button-module_button__QOSYH {
   --button-min-height-width: var(--spacing-48);
   --button-padding-x: calc(
@@ -210,6 +180,36 @@
 .Focusable-module_focusableWrapper__NfuIi {
   display: inline-flex;
 }
+.Menu-module_menu__iHYqh {
+  background-color: var(--color-white);
+  color: var(--color-purple-800);
+  width: 248px;
+  max-height: 22rem;
+  overflow: auto;
+  padding-block: var(--spacing-6);
+  outline: none;
+  border-radius: var(--border-solid-border-radius);
+  box-shadow: var(--shadow-large-box-shadow);
+}
+
+.Menu-module_menu__iHYqh .react-aria-Header {
+  font-family: var(--typography-heading-6-font-family);
+  font-size: var(--typography-heading-6-font-size);
+  letter-spacing: var(--typography-heading-6-letter-spacing);
+  font-weight: var(--typography-heading-6-font-weight);
+  line-height: var(--typography-heading-6-line-height);
+  padding: var(--spacing-6) 10px;
+  margin-inline: var(--spacing-6);
+}
+
+.Menu-module_menu__iHYqh section:not(:last-of-type)::after {
+  width: 100%;
+  height: 1px;
+  background-color: var(--border-solid-border-color);
+  content: "";
+  display: block;
+  margin-block: var(--spacing-6);
+}
 /** THIS IS AN AUTOGENERATED FILE **/
 /** THIS IS AN AUTOGENERATED FILE **/
 .OverlayArrow-module_overlayArrow__hoDyK {
@@ -5408,6 +5408,10 @@ input[type=range].InputRange-module_ratingScaleRange__gI-rs::-ms-thumb:not(:disa
   box-sizing: border-box;
   pointer-events: all;
 }
+.GenericNotification-module_notification__-JP1M:focus {
+  outline-offset: 1px;
+  outline: 2px solid var(--color-blue-500);
+}
 .GenericNotification-module_notification__-JP1M.GenericNotification-module_inline__OciO5, .GenericNotification-module_notification__-JP1M.GenericNotification-module_toast__GOVfC {
   margin-bottom: var(--spacing-24, 1.5rem);
   border-width: var(--border-width-1);

package/dist/types/Notification/InlineNotification/InlineNotification.d.ts

@@ -19,7 +19,4 @@ export type InlineNotificationProps = InlineNotificationBase & (GenericNotificat
  * {@link https://cultureamp.atlassian.net/wiki/spaces/DesignSystem/pages/3082093392/Inline+Notification Guidance} |
  * {@link https://cultureamp.design/storybook/?path=/docs/components-notifications-inline-notification--docs Storybook}
  */
-export declare const InlineNotification: {
-    ({ isSubtle, hideCloseIcon, persistent, classNameOverride, ...otherProps }: InlineNotificationProps): JSX.Element;
-    displayName: string;
-};
+export declare const InlineNotification: React.ForwardRefExoticComponent<InlineNotificationProps & React.RefAttributes<HTMLDivElement>>;

package/dist/types/Notification/subcomponents/GenericNotification/GenericNotification.d.ts

@@ -32,8 +32,5 @@ export type GenericNotificationVariant = {
     variant: NotificationVariant;
 };
 export type GenericNotificationProps = GenericNotificationBase & (GenericNotificationType | GenericNotificationVariant);
-export declare const GenericNotification: {
-    ({ type, variant, style, children, title, persistent, onHide, noBottomMargin, forceMultiline, headingProps, classNameOverride, ...restProps }: GenericNotificationProps): JSX.Element | null;
-    displayName: string;
-};
+export declare const GenericNotification: React.ForwardRefExoticComponent<GenericNotificationProps & React.RefAttributes<HTMLDivElement>>;
 export {};

package/dist/types/ToggleSwitch/ToggleSwitch/ToggleSwitch.d.ts

@@ -8,7 +8,7 @@ export type ToggleSwitchProps = {
      */
     onToggle?: React.ChangeEventHandler<HTMLInputElement>;
     reversed?: boolean;
-} & OverrideClassName<Omit<InputHTMLAttributes<HTMLInputElement>, "onChange">>;
+} & OverrideClassName<Omit<InputHTMLAttributes<HTMLInputElement>, "onChange" | "onToggle">>;
 export declare const ToggleSwitch: {
     ({ toggledStatus, onToggle, reversed, ...restProps }: ToggleSwitchProps): JSX.Element;
     displayName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaizen/components",
-  "version": "1.64.2",
+  "version": "1.64.4",
   "description": "Kaizen component library",
   "author": "Geoffrey Chong <geoff.chong@cultureamp.com>",
   "homepage": "https://cultureamp.design",
@@ -120,8 +120,8 @@
     "svgo": "^3.3.2",
     "tslib": "^2.6.3",
     "tsx": "^4.17.0",
-    "@kaizen/design-tokens": "10.6.1",
-    "@kaizen/package-bundler": "1.1.5"
+    "@kaizen/package-bundler": "1.1.5",
+    "@kaizen/design-tokens": "10.6.1"
   },
   "peerDependencies": {
     "@cultureamp/i18n-react-intl": "^2.5.9",

package/src/Notification/InlineNotification/InlineNotification.tsx

@@ -1,4 +1,4 @@
-import React, { HTMLAttributes } from "react"
+import React, { forwardRef, HTMLAttributes } from "react"
 import classnames from "classnames"
 import { HeadingProps } from "~components/Heading"
 import { OverrideClassName } from "~components/types/OverrideClassName"
@@ -30,21 +30,30 @@ export type InlineNotificationProps = InlineNotificationBase &
  * {@link https://cultureamp.atlassian.net/wiki/spaces/DesignSystem/pages/3082093392/Inline+Notification Guidance} |
  * {@link https://cultureamp.design/storybook/?path=/docs/components-notifications-inline-notification--docs Storybook}
  */
-export const InlineNotification = ({
-  isSubtle,
-  hideCloseIcon = false,
-  persistent = false,
-  classNameOverride,
-  ...otherProps
-}: InlineNotificationProps): JSX.Element => (
-  <GenericNotification
-    style="inline"
-    persistent={persistent || hideCloseIcon}
-    classNameOverride={classnames(classNameOverride, [
-      isSubtle && styles.subtle,
-    ])}
-    {...otherProps}
-  />
+export const InlineNotification = forwardRef<
+  HTMLDivElement,
+  InlineNotificationProps
+>(
+  (
+    {
+      isSubtle,
+      hideCloseIcon = false,
+      persistent = false,
+      classNameOverride,
+      ...otherProps
+    },
+    ref
+  ): JSX.Element => (
+    <GenericNotification
+      style="inline"
+      persistent={persistent || hideCloseIcon}
+      classNameOverride={classnames(classNameOverride, [
+        isSubtle && styles.subtle,
+      ])}
+      ref={ref}
+      {...otherProps}
+    />
+  )
 )
 
 InlineNotification.displayName = "InlineNotification"

package/src/Notification/InlineNotification/_docs/InlineNotification.stickersheet.stories.tsx

@@ -131,6 +131,19 @@ const VARIANTS_PROPS: Array<{
       forceMultiline: true,
     },
   },
+  {
+    title: "Focus",
+    props: {
+      // @ts-ignore
+      "data-sb-pseudo-styles": "focus",
+      variant: "informative",
+      headingProps: {
+        variant: "heading-6",
+        tag: "span",
+        children: "Focused title",
+      },
+    },
+  },
 ]
 
 const TYPE_PROPS: Array<{
@@ -206,6 +219,11 @@ const StickerSheetTemplate: StickerSheetStory = {
       </StickerSheet>
     </>
   ),
+  parameters: {
+    pseudo: {
+      focus: '[data-sb-pseudo-styles="focus"]',
+    },
+  },
 }
 
 export const StickerSheetDefault: StickerSheetStory = {

package/src/Notification/subcomponents/GenericNotification/GenericNotification.stories.tsx

@@ -1,4 +1,4 @@
-import React, { useState } from "react"
+import React, { useRef, useState } from "react"
 import { Meta, StoryObj } from "@storybook/react"
 import { userEvent, within, expect, waitFor } from "@storybook/test"
 import { GenericNotification } from "./index"
@@ -58,3 +58,46 @@ export const GenericNotificationTest: Story = {
     })
   },
 }
+
+export const RefTest: Story = {
+  render: () => {
+    const customRef = useRef<HTMLDivElement>(null)
+    const [isHidden, setIsHidden] = useState<boolean>(false)
+
+    return (
+      <div>
+        <span data-testid="hidden-state">{isHidden ? "Hidden" : "Shown"}</span>
+        <GenericNotification
+          ref={customRef}
+          variant="success"
+          style="inline"
+          title="Success"
+          data-testid="generic-notification"
+          onHide={() => setIsHidden(true)}
+        >
+          This is my positive notification
+        </GenericNotification>
+      </div>
+    )
+  },
+  name: "Test: still renders and closes properly when custom ref passed in",
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement)
+    const element = canvas.getByTestId("generic-notification")
+    const hiddenState = canvas.getByTestId("hidden-state")
+
+    await waitFor(() => {
+      expect(element).toBeInTheDocument()
+      expect(hiddenState).toHaveTextContent("Shown")
+    })
+
+    await userEvent.click(canvas.getByTestId("close-button"))
+
+    await waitFor(() => {
+      setTimeout(() => {
+        expect(hiddenState).toHaveTextContent("Hidden")
+        expect(element).not.toBeInTheDocument()
+      }, 1000)
+    })
+  },
+}

package/src/Notification/subcomponents/GenericNotification/GenericNotification.tsx

@@ -1,4 +1,10 @@
-import React, { HTMLAttributes, useEffect, useRef, useState } from "react"
+import React, {
+  forwardRef,
+  HTMLAttributes,
+  useEffect,
+  useRef,
+  useState,
+} from "react"
 import classnames from "classnames"
 import { HeadingProps } from "~components/Heading"
 import {
@@ -6,6 +12,7 @@ import {
   NotificationVariant,
 } from "~components/Notification/types"
 import { OverrideClassName } from "~components/types/OverrideClassName"
+import { isRefObject } from "~components/utils/isRefObject"
 import { CancelButton } from "../CancelButton"
 import { NotificationHeading } from "../NotificationHeading"
 import {
@@ -49,89 +56,103 @@ export type GenericNotificationVariant = {
 export type GenericNotificationProps = GenericNotificationBase &
   (GenericNotificationType | GenericNotificationVariant)
 
-export const GenericNotification = ({
-  type,
-  variant,
-  style,
-  children,
-  title,
-  persistent = false,
-  onHide,
-  noBottomMargin,
-  forceMultiline,
-  headingProps,
-  classNameOverride,
-  ...restProps
-}: GenericNotificationProps): JSX.Element | null => {
-  const [isHidden, setIsHidden] = useState<boolean>(true)
-  const [isRemoved, setIsRemoved] = useState<boolean>(false)
+export const GenericNotification = forwardRef<
+  HTMLDivElement,
+  GenericNotificationProps
+>(
+  (
+    {
+      type,
+      variant,
+      style,
+      children,
+      title,
+      persistent = false,
+      onHide,
+      noBottomMargin,
+      forceMultiline,
+      headingProps,
+      classNameOverride,
+      ...restProps
+    },
+    ref
+  ): JSX.Element | null => {
+    const [isHidden, setIsHidden] = useState<boolean>(true)
+    const [isRemoved, setIsRemoved] = useState<boolean>(false)
 
-  const containerRef = useRef<HTMLDivElement>(null)
+    const fallbackRef = useRef<HTMLDivElement>(null)
+    const containerRef = isRefObject(ref) ? ref : fallbackRef
 
-  useEffect(() => {
-    requestAnimationFrame(() => {
-      if (containerRef.current) {
-        setIsHidden(false)
-      }
-    })
-  }, [])
+    useEffect(() => {
+      requestAnimationFrame(() => {
+        if (containerRef.current) {
+          setIsHidden(false)
+        }
+      })
+    }, [])
 
-  const getMarginTop = (): string => {
-    if (isHidden && containerRef.current) {
-      return -containerRef.current.clientHeight + "px"
+    const getMarginTop = (): string => {
+      if (isHidden && containerRef.current) {
+        return -containerRef.current.clientHeight + "px"
+      }
+      return "0"
     }
-    return "0"
-  }
 
-  const onTransitionEnd = (e: React.TransitionEvent<HTMLDivElement>): void => {
-    // Be careful: this assumes the final CSS property to be animated is "margin-top".
-    if (isHidden && e.propertyName === "margin-top") {
-      setIsRemoved(true)
-      onHide?.()
+    const onTransitionEnd = (
+      e: React.TransitionEvent<HTMLDivElement>
+    ): void => {
+      // Be careful: this assumes the final CSS property to be animated is "margin-top".
+      if (isHidden && e.propertyName === "margin-top") {
+        setIsRemoved(true)
+        onHide?.()
+      }
     }
-  }
 
-  if (isRemoved) {
-    return null
-  }
+    if (isRemoved) {
+      return null
+    }
 
-  return (
-    <div
-      ref={containerRef}
-      className={classnames(
-        styles.notification,
-        variant ? styles[variant] : styles[type],
-        styles[style],
-        isHidden && styles.hidden,
-        noBottomMargin && styles.noBottomMargin,
-        classNameOverride,
-        persistent && styles.persistent
-      )}
-      style={{ marginTop: getMarginTop() }}
-      onTransitionEnd={onTransitionEnd}
-      {...restProps}
-    >
-      <div className={styles.icon}>
-        {type ? (
-          <NotificationIconType type={type} />
-        ) : (
-          <NotificationIconVariant variant={variant} />
-        )}
-      </div>
+    return (
       <div
+        ref={containerRef}
         className={classnames(
-          styles.textContainer,
-          forceMultiline && styles.forceMultiline
+          styles.notification,
+          variant ? styles[variant] : styles[type],
+          styles[style],
+          isHidden && styles.hidden,
+          noBottomMargin && styles.noBottomMargin,
+          classNameOverride,
+          persistent && styles.persistent
         )}
+        style={{ marginTop: getMarginTop() }}
+        onTransitionEnd={onTransitionEnd}
+        {...restProps}
       >
-        {style !== "global" && (
-          <NotificationHeading titleProp={title} headingProps={headingProps} />
-        )}
-        {children && <div className={styles.text}>{children}</div>}
+        <div className={styles.icon}>
+          {type ? (
+            <NotificationIconType type={type} />
+          ) : (
+            <NotificationIconVariant variant={variant} />
+          )}
+        </div>
+        <div
+          className={classnames(
+            styles.textContainer,
+            forceMultiline && styles.forceMultiline
+          )}
+        >
+          {style !== "global" && (
+            <NotificationHeading
+              titleProp={title}
+              headingProps={headingProps}
+            />
+          )}
+          {children && <div className={styles.text}>{children}</div>}
+        </div>
+        {!persistent && <CancelButton onClick={() => setIsHidden(true)} />}
       </div>
-      {!persistent && <CancelButton onClick={() => setIsHidden(true)} />}
-    </div>
-  )
-}
+    )
+  }
+)
 
 GenericNotification.displayName = "GenericNotification"

package/src/Notification/subcomponents/GenericNotification/_mixins.scss

@@ -22,6 +22,11 @@ $notification-slide-right: transform 300ms ease-out;
   box-sizing: border-box;
   pointer-events: all;
 
+  &:focus {
+    outline-offset: 1px;
+    outline: 2px solid var(--color-blue-500);
+  }
+
   // Variants
   &%ca-notification---inline,
   &%ca-notification---toast {

package/src/ToggleSwitch/ToggleSwitch/ToggleSwitch.tsx

@@ -13,7 +13,9 @@ export type ToggleSwitchProps = {
    */
   onToggle?: React.ChangeEventHandler<HTMLInputElement>
   reversed?: boolean
-} & OverrideClassName<Omit<InputHTMLAttributes<HTMLInputElement>, "onChange">>
+} & OverrideClassName<
+  Omit<InputHTMLAttributes<HTMLInputElement>, "onChange" | "onToggle">
+>
 
 export const ToggleSwitch = ({
   toggledStatus,