@kaizen/components 1.41.1 → 1.42.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaizen/components",
-  "version": "1.41.1",
+  "version": "1.42.1",
   "description": "Kaizen component library",
   "author": "Geoffrey Chong <geoff.chong@cultureamp.com>",
   "homepage": "https://cultureamp.design",
@@ -47,11 +47,11 @@
     "@react-stately/select": "^3.6.2",
     "@react-types/shared": "^3.22.1",
     "classnames": "^2.5.1",
-    "date-fns": "^3.5.0",
+    "date-fns": "^3.6.0",
     "lodash.debounce": "^4.0.8",
     "nanobus": "^4.5.0",
     "prosemirror-commands": "^1.5.2",
-    "prosemirror-history": "^1.3.2",
+    "prosemirror-history": "^1.4.0",
     "prosemirror-inputrules": "^1.4.0",
     "prosemirror-keymap": "^1.2.2",
     "prosemirror-model": "^1.19.4",
@@ -60,7 +60,7 @@
     "prosemirror-state": "^1.4.3",
     "prosemirror-transform": "^1.8.0",
     "prosemirror-utils": "^1.2.1-0",
-    "prosemirror-view": "^1.33.1",
+    "prosemirror-view": "^1.33.3",
     "react-animate-height": "^3.2.3",
     "react-day-picker": "^8.10.0",
     "react-focus-lock": "^2.11.2",
@@ -79,9 +79,9 @@
     "react-day-picker": "Version locked until a11y gets fixed (https://github.com/gpbl/react-day-picker/pull/1708)"
   },
   "devDependencies": {
-    "@babel/plugin-transform-react-pure-annotations": "^7.23.3",
-    "@cultureamp/frontend-apis": "^9.4.2",
-    "@cultureamp/i18n-react-intl": "^2.5.3",
+    "@babel/plugin-transform-react-pure-annotations": "^7.24.1",
+    "@cultureamp/frontend-apis": "^9.4.3",
+    "@cultureamp/i18n-react-intl": "^2.5.5",
     "@rollup/plugin-alias": "^5.1.0",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
@@ -90,19 +90,19 @@
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/lodash.debounce": "^4.0.9",
-    "@types/react-dom": "^18.2.22",
+    "@types/react-dom": "^18.2.23",
     "@types/react-textfit": "^1.1.4",
     "@types/uuid": "^9.0.8",
     "agadoo": "^3.0.0",
-    "autoprefixer": "^10.4.18",
+    "autoprefixer": "^10.4.19",
     "babel-plugin-pure-static-props": "^0.2.0",
     "concat-cli": "^4.0.0",
     "query-string": "^9.0.0",
-    "react-intl": "^6.6.2",
-    "rollup": "^4.12.1",
+    "react-intl": "^6.6.4",
+    "rollup": "^4.13.2",
     "rollup-plugin-dts": "^6.1.0",
     "rollup-plugin-ignore": "^1.0.10",
-    "rollup-plugin-node-externals": "^7.0.1",
+    "rollup-plugin-node-externals": "^7.1.1",
     "rollup-plugin-postcss": "^4.0.2",
     "sass": "^1.72.0",
     "serialize-query-params": "^2.0.2",
@@ -111,13 +111,13 @@
     "ts-node": "^10.9.2",
     "ts-patch": "^3.1.2",
     "typescript-transform-paths": "^3.4.7",
-    "@kaizen/tailwind": "1.2.5",
-    "@kaizen/design-tokens": "10.3.19"
+    "@kaizen/tailwind": "1.2.6",
+    "@kaizen/design-tokens": "10.3.20"
   },
   "peerDependencies": {
-    "@cultureamp/i18n-react-intl": "^2.5.3",
+    "@cultureamp/i18n-react-intl": "^2.5.5",
     "react": "^18.2.0",
-    "react-intl": "^6.6.2"
+    "react-intl": "^6.6.4"
   },
   "scripts": {
     "build": "pnpm clean && pnpm prepublishOnly",

package/src/ButtonGroup/_docs/ButtonGroup.mdx

@@ -0,0 +1,23 @@
+import { Canvas, Controls, Meta } from "@storybook/blocks"
+import { ResourceLinks, KAIOInstallation } from "~storybook/components"
+import * as ButtonGroupStories from "./ButtonGroup.stories"
+
+<Meta of={ButtonGroupStories} />
+
+# Button Group
+
+<ResourceLinks
+  sourceCode="https://github.com/cultureamp/kaizen-design-system/tree/main/packages/components/src/ButtonGroup"
+  figma="https://www.figma.com/file/ZRfnoNUXbGZv4eVWLbF4Az/%F0%9F%96%BC%EF%B8%8F-Component-Gallery?type=design&node-id=6-28579&t=bowQ0LWOQKOd0UYS-0"
+  designGuidelines="https://cultureamp.atlassian.net/wiki/spaces/DesignSystem/pages/3082093959/Filters"
+  className="!mb-8"
+/>
+
+<KAIOInstallation exportNames="ButtonGroup" />
+
+## Overview
+
+Used to group buttons. Compatible with buttons wrapped by Tooltip. Currently only compatible with Filter Buttons.
+
+<Canvas of={ButtonGroupStories.Playground} />
+<Controls of={ButtonGroupStories.Playground} />

package/src/ButtonGroup/_docs/ButtonGroup.stories.tsx

@@ -1,43 +1,20 @@
 import React from "react"
 import { Meta, StoryObj } from "@storybook/react"
 import { FilterButtonBase } from "~components/Filter/FilterButton/subcomponents/FilterButtonBase"
-import { ComponentDocsTemplate } from "~storybook/components/DocsContainer"
 import { ButtonGroup } from ".."
 
 const meta = {
-  tags: ["autodocs"],
   // Not to be nested until full KAIO migration
   // title: "Components/Button/Button Group",
   title: "Components/Button Group",
   component: ButtonGroup,
   args: { children: undefined },
-  parameters: {
-    docs: {
-      container: ComponentDocsTemplate,
-    },
-    isInKaio: true,
-    installation: [
-      "pnpm add @kaizen/components",
-      "import { ButtonGroup } from `@kaizen/components`",
-    ],
-    resourceLinks: {
-      sourceCode:
-        "https://github.com/cultureamp/kaizen-design-system/tree/main/packages/components/src/ButtonGroup",
-      figma:
-        "https://www.figma.com/file/ZRfnoNUXbGZv4eVWLbF4Az/%F0%9F%96%BC%EF%B8%8F-Component-Gallery?type=design&node-id=6-28579&t=bowQ0LWOQKOd0UYS-0",
-      designGuidelines:
-        "https://cultureamp.atlassian.net/wiki/spaces/DesignSystem/pages/3082093959/Filters",
-    },
-  },
 } satisfies Meta<typeof ButtonGroup>
 
 export default meta
 
 type Story = StoryObj<typeof meta>
 
-/**
- * Used to group buttons. Compatible with buttons wrapped by Tooltip. Currently only compatible with Filter Buttons.
- */
 export const Playground: Story = {
   render: args => (
     <ButtonGroup {...args}>

package/src/DateRangePicker/_docs/DateRangePicker.stories.tsx

@@ -1,5 +1,6 @@
 import React, { useEffect, useState } from "react"
 import { Meta, StoryObj } from "@storybook/react"
+import { fn } from "@storybook/test"
 import { DateRange } from "react-day-picker"
 import { DateRangePicker, formatDateRangeValue } from "../index"
 
@@ -8,6 +9,7 @@ const meta = {
   component: DateRangePicker,
   args: {
     labelText: "Label",
+    onChange: fn(),
   },
 } satisfies Meta<typeof DateRangePicker>
 

package/src/ErrorPage/_docs/ErrorPage.mdx

@@ -0,0 +1,21 @@
+import { Canvas, Controls, Meta } from "@storybook/blocks"
+import { ResourceLinks, KAIOInstallation } from "~storybook/components"
+import * as ErrorPageStories from "./ErrorPage.stories"
+
+<Meta of={ErrorPageStories} />
+
+# Error Page
+
+<ResourceLinks
+  sourceCode="https://github.com/cultureamp/kaizen-design-system/tree/master/packages/components/src/ErrorPage"
+  className="!mb-8"
+/>
+
+<KAIOInstallation exportNames="ErrorPage" />
+
+## Overview
+
+Error pages for when things go wrong.
+
+<Canvas of={ErrorPageStories.Playground} />
+<Controls of={ErrorPageStories.Playground} />

package/src/ErrorPage/_docs/ErrorPage.stories.tsx

@@ -1,26 +1,10 @@
 import { Meta, StoryObj } from "@storybook/react"
-import { ComponentDocsTemplate } from "~storybook/components/DocsContainer"
 import { statusCodes } from "../hooks"
 import { ErrorPage } from "../index"
 
 const meta = {
-  tags: ["autodocs"],
   title: "Pages/Error Page",
   component: ErrorPage,
-  parameters: {
-    docs: {
-      container: ComponentDocsTemplate,
-    },
-    installation: [
-      "npm install @kaizen/components",
-      "import { ErrorPage } from `@kaizen/components`",
-    ],
-    resourceLinks: {
-      /** @todo: Add Github link (adjust as needed) */
-      sourceCode:
-        "https://github.com/cultureamp/kaizen-design-system/tree/master/packages/components/src/ErrorPage",
-    },
-  },
 } satisfies Meta<typeof ErrorPage>
 
 export default meta

package/src/Filter/Filter/_docs/Filter.stories.tsx

@@ -1,6 +1,7 @@
 import React, { useState } from "react"
 import { action } from "@storybook/addon-actions"
 import { Meta, StoryObj } from "@storybook/react"
+import { fn } from "@storybook/test"
 import { FilterButton, FilterButtonRemovable } from "~components/Filter"
 import { Filter, FilterContents } from "../index"
 
@@ -20,6 +21,7 @@ const meta = {
       <FilterButton label="Label" {...triggerProps} />
     ),
     isOpen: false,
+    setIsOpen: fn(),
   },
 } satisfies Meta<typeof Filter>
 

package/src/Filter/FilterBar/_docs/FilterBar.stories.tsx

@@ -1,5 +1,6 @@
 import React, { useEffect, useState } from "react"
 import { Meta, StoryObj } from "@storybook/react"
+import { fn } from "@storybook/test"
 import queryString from "query-string"
 import Highlight from "react-highlight"
 import {
@@ -30,6 +31,7 @@ const meta = {
   args: {
     filters: [], // Defined in stories
     values: {}, // Defined in stories
+    onValuesChange: fn(),
   },
 } satisfies Meta<typeof FilterBar>
 

package/src/Filter/FilterDatePicker/_docs/FilterDatePicker.stories.tsx

@@ -1,5 +1,6 @@
 import React, { useEffect, useState } from "react"
 import { Meta, StoryObj } from "@storybook/react"
+import { fn } from "@storybook/test"
 import Highlight from "react-highlight"
 import { defaultMonthControls } from "~components/Calendar/_docs/controls/defaultMonthControls"
 import {
@@ -56,6 +57,8 @@ const meta = {
     ),
     isOpen: false,
     selectedDate: undefined,
+    setIsOpen: fn(),
+    onDateChange: fn(),
   },
 } satisfies Meta<typeof FilterDatePicker>
 

package/src/Filter/FilterDateRangePicker/_docs/FilterDateRangePicker.stories.tsx

@@ -1,5 +1,6 @@
 import React, { useEffect, useState } from "react"
 import { Meta, StoryObj } from "@storybook/react"
+import { fn } from "@storybook/test"
 import Highlight from "react-highlight"
 import { DateRange } from "~components/Calendar"
 import { defaultMonthControls } from "~components/Calendar/_docs/controls/defaultMonthControls"
@@ -75,6 +76,8 @@ const meta = {
     renderTrigger: (triggerButtonProps: FilterButtonProps): JSX.Element => (
       <FilterButton {...triggerButtonProps} />
     ),
+    setIsOpen: fn(),
+    onRangeChange: fn(),
   },
 } satisfies Meta<typeof FilterDateRangePicker>
 

package/src/Filter/FilterSelect/_docs/FilterSelect.stories.tsx

@@ -1,5 +1,6 @@
 import React, { useState } from "react"
 import { Meta, StoryObj } from "@storybook/react"
+import { fn } from "@storybook/test"
 import { renderTriggerControls } from "~components/Filter/_docs/controls/renderTriggerControls"
 import { FilterButton } from "../../FilterButton"
 import { FilterSelect } from "../FilterSelect"
@@ -29,6 +30,7 @@ const meta = {
     renderTrigger: (triggerProps): JSX.Element => (
       <FilterButton {...triggerProps} />
     ),
+    setIsOpen: fn(),
   },
   parameters: {
     actions: {

package/src/Heading/Heading.module.scss

@@ -15,6 +15,14 @@
   letter-spacing: $typography-display-0-letter-spacing;
 }
 
+.composable-header-title {
+  font-family: $typography-display-0-font-family; // Tiempos
+  font-weight: 500; // Medium
+  font-size: $typography-heading-1-font-size;
+  line-height: $typography-heading-1-line-height;
+  letter-spacing: $typography-heading-1-letter-spacing;
+}
+
 .heading-1 {
   font-family: $typography-heading-1-font-family;
   font-weight: $typography-heading-1-font-weight;

package/src/Heading/Heading.tsx

@@ -7,6 +7,7 @@ const VARIANTS_24PX_OR_GREATER = ["display-0", "heading-1", "heading-2"]
 
 export type HeadingVariants =
   | "display-0"
+  | "composable-header-title"
   | "heading-1"
   | "heading-2"
   | "heading-3"
@@ -84,6 +85,7 @@ Heading.displayName = "Heading"
 const translateHeadingLevelToTag = (headingLevel: HeadingVariants): string => {
   switch (headingLevel) {
     case "display-0":
+    case "composable-header-title":
     case "heading-1":
       return "h1"
     case "heading-2":

package/src/Heading/_docs/Heading.mdx

@@ -30,3 +30,12 @@ People using a screen reader rely on heading elements to get an understanding of
 In most cases, you will need to use the `tag` prop to adjust the heading level to suit your page.
 
 There will the odd case where you want heading styling, but the text isn't actually acting as a heading. In those cases, use `tag="div"` or `tag="span"`.
+
+## Variant - Composable Header Title
+
+Use this variant only for the title within the composable header. [See documentation](https://cultureamp.atlassian.net/wiki/spaces/DesignSystem/pages/3456565336/Composable+Header+-+IN+DRAFT)
+
+Defaults to `h1` element.
+
+<Canvas of={HeadingStories.ComposableHeaderTitle} />
+

package/src/Heading/_docs/Heading.stickersheet.stories.tsx

@@ -26,6 +26,11 @@ const StickerSheetTemplate: StickerSheetStory = {
                 Let's create a better world of work
               </Heading>
             </StickerSheet.Row>
+            <StickerSheet.Row rowTitle="Composable header title">
+              <Heading variant="composable-header-title" color={fontColour}>
+                Use me in the composable header!
+              </Heading>
+            </StickerSheet.Row>
             <StickerSheet.Row rowTitle="Heading 1">
               <div>
                 <Heading variant="heading-1" color={fontColour}>

package/src/Heading/_docs/Heading.stories.tsx

@@ -28,6 +28,13 @@ export const Playground: Story = {
   },
 }
 
+export const ComposableHeaderTitle: Story = {
+  args: {
+    variant: "composable-header-title",
+    children: "Page title within composable header",
+  },
+}
+
 export const Reversed: Story = {
   args: { color: "white" },
   parameters: {

package/src/Illustration/subcomponents/VideoPlayer/VideoPlayer.spec.tsx

@@ -1,4 +1,4 @@
-import * as React from "react"
+import React from "react"
 import { render, screen } from "@testing-library/react"
 import userEvent from "@testing-library/user-event"
 import { VideoPlayer } from "./VideoPlayer"
@@ -25,7 +25,6 @@ const mockPause = jest.fn()
 
 describe("<VideoPlayer />", () => {
   beforeEach(() => {
-    jest.clearAllMocks()
     window.HTMLMediaElement.prototype.load = mockLoad
     window.HTMLMediaElement.prototype.play = mockPlay
     window.HTMLMediaElement.prototype.pause = mockPause
@@ -39,6 +38,10 @@ describe("<VideoPlayer />", () => {
     })
   })
 
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
   it("renders a video player in the document and autoplay", async () => {
     render(
       <VideoPlayer
@@ -49,7 +52,7 @@ describe("<VideoPlayer />", () => {
     )
     const videoPlayer = screen.getByTestId("kz-video-player")
     expect(videoPlayer).toBeInTheDocument()
-    expect(mockPlay).toBeCalled()
+    expect(mockPlay).toHaveBeenCalled()
   })
 
   describe("use-reduced-motion", () => {
@@ -65,8 +68,8 @@ describe("<VideoPlayer />", () => {
         />
       )
       const videoPlayer = screen.getByTestId("kz-video-player")
-      expect(videoPlayer).toMatchSnapshot()
-      expect(mockPause).toBeCalled()
+      expect(videoPlayer).not.toHaveAttribute("autoplay")
+      expect(mockPause).toHaveBeenCalled()
     })
 
     it("defaults to autoplay when user does not set use-reduced-motion preferences", () => {
@@ -81,8 +84,8 @@ describe("<VideoPlayer />", () => {
         />
       )
       const videoPlayer = screen.getByTestId("kz-video-player")
-      expect(videoPlayer).toMatchSnapshot()
-      expect(mockPlay).toBeCalled()
+      expect(videoPlayer).toHaveAttribute("autoplay")
+      expect(mockPlay).toHaveBeenCalled()
     })
   })
 

package/src/Illustration/subcomponents/VideoPlayer/VideoPlayer.tsx

@@ -51,7 +51,6 @@ export const VideoPlayer = ({
   const videoRef = useRef<HTMLVideoElement>(null)
   const [prefersReducedMotion, setPrefersReducedMotion] =
     React.useState<boolean>(true)
-  const [sourceEl, setSourceEl] = React.useState<React.ReactNode>()
 
   useEffect(() => {
     /**
@@ -150,32 +149,15 @@ export const VideoPlayer = ({
     }
   }, [videoRef])
 
-  useEffect(() => {
-    /**
-     * This seems counter-intuitive, but webm support is codec specific.
-     * Only offer webm if we are positive the browser supports it.
-     * Reference: https://bugs.webkit.org/show_bug.cgi?id=216652#c1
-     */
-    canPlayWebm() ? (
-      setSourceEl(
-        <>
-          <source src={assetUrl(`${source}.webm`)} type="video/webm" />
-          <source src={assetUrl(`${source}.mp4`)} type="video/mp4" />
-        </>
-      )
-    ) : (
-      <source src={assetUrl(`${source}.mp4`)} type="video/mp4" />
-    )
-  }, [setSourceEl])
-
   const pausePlay = usePausePlay(videoRef)
 
   return (
     <figure
-      className={classnames(styles.figure, {
-        [`${styles[aspectRatio!]} ${styles.aspectRatioWrapper}`]:
-          Boolean(aspectRatio),
-      })}
+      className={classnames(
+        styles.figure,
+        aspectRatio && styles[aspectRatio],
+        aspectRatio && styles.aspectRatioWrapper
+      )}
     >
       <video
         muted={true}
@@ -191,7 +173,10 @@ export const VideoPlayer = ({
         playsInline={true}
         tabIndex={-1}
       >
-        {sourceEl}
+        {canPlayWebm() && (
+          <source src={assetUrl(`${source}.webm`)} type="video/webm" />
+        )}
+        <source src={assetUrl(`${source}.mp4`)} type="video/mp4" />
       </video>
       <IconButton
         onClick={(): void => pausePlay.toggle()}

package/src/LabelledMessage/_docs/LabelledMessage.mdx

@@ -0,0 +1,21 @@
+import { Canvas, Controls, Meta } from "@storybook/blocks"
+import { ResourceLinks, KAIOInstallation } from "~storybook/components"
+import * as LabelledMessageStories from "./LabelledMessage.stories"
+
+<Meta of={LabelledMessageStories} />
+
+# Labelled Message
+
+<ResourceLinks
+  sourceCode="https://github.com/cultureamp/kaizen-design-system/tree/main/packages/components/src/LabelledMessage"
+  className="!mb-8"
+/>
+
+<KAIOInstallation exportNames="LabelledMessage" />
+
+## Overview
+
+A label and message with a separator in between. This component supports `dir="ltr"`.
+
+<Canvas of={LabelledMessageStories.Playground} />
+<Controls of={LabelledMessageStories.Playground} />

package/src/LabelledMessage/_docs/LabelledMessage.stories.tsx

@@ -1,36 +1,17 @@
 import { Meta, StoryObj } from "@storybook/react"
-import { ComponentDocsTemplate } from "~storybook/components/DocsContainer"
 import { LabelledMessage } from "../LabelledMessage"
 
 const meta = {
-  tags: ["autodocs"],
   title: "Components/Utilities/Labelled Message",
   component: LabelledMessage,
   args: {
     label: "Label",
     message: "Custom message here",
   },
-  parameters: {
-    docs: {
-      container: ComponentDocsTemplate,
-    },
-    isInKaio: true,
-    installation: [
-      "npm install @kaizen/components",
-      'import { LabelledMessage } from "@kaizen/components"',
-    ],
-    resourceLinks: {
-      sourceCode:
-        "https://github.com/cultureamp/kaizen-design-system/tree/main/packages/components/src/LabelledMessage",
-    },
-  },
 } satisfies Meta<typeof LabelledMessage>
 
 export default meta
 
-/**
- * A label and message with a separator in between. This component supports `dir="ltr"`.
- */
 export const Playground: StoryObj<typeof meta> = {
   parameters: {
     docs: {

package/src/Modal/ConfirmationModal/_docs/ConfirmationModal.stories.tsx

@@ -1,5 +1,6 @@
 import React, { useState } from "react"
 import { Meta, StoryObj } from "@storybook/react"
+import { fn } from "@storybook/test"
 import isChromatic from "chromatic"
 import { Text } from "~components/Text"
 import { chromaticModalSettings } from "../../_docs/controls"
@@ -7,6 +8,33 @@ import { ConfirmationModal } from "../index"
 
 const IS_CHROMATIC = isChromatic()
 
+const meta = {
+  title: "Components/Modals/Confirmation Modal",
+  component: ConfirmationModal,
+  args: {
+    isOpen: false,
+    title: "Confirmation modal title",
+    mood: "cautionary",
+    children: (
+      <Text variant="body">
+        Confirmation modals contain smaller pieces of content and can provide
+        additional information to aide the user.
+      </Text>
+    ),
+    onConfirm: fn(),
+    onDismiss: fn(),
+  },
+  argTypes: {
+    children: {
+      control: false,
+    },
+  },
+} satisfies Meta<typeof ConfirmationModal>
+
+export default meta
+
+type Story = StoryObj<typeof meta>
+
 const ConfirmationModalTemplate: Story = {
   render: args => {
     const [isOpen, setIsOpen] = useState(IS_CHROMATIC)
@@ -35,31 +63,6 @@ const ConfirmationModalTemplate: Story = {
   ...chromaticModalSettings,
 }
 
-const meta = {
-  title: "Components/Modals/Confirmation Modal",
-  component: ConfirmationModal,
-  args: {
-    isOpen: false,
-    title: "Confirmation modal title",
-    mood: "cautionary",
-    children: (
-      <Text variant="body">
-        Confirmation modals contain smaller pieces of content and can provide
-        additional information to aide the user.
-      </Text>
-    ),
-  },
-  argTypes: {
-    children: {
-      control: false,
-    },
-  },
-} satisfies Meta<typeof ConfirmationModal>
-
-export default meta
-
-type Story = StoryObj<typeof meta>
-
 export const Playground: Story = {
   ...ConfirmationModalTemplate,
   parameters: {