@kaizen/components 1.61.3 → 1.63.0

package/src/__layout__/Workflow/v1/subcomponents/Footer/components/ProgressStepper/ProgressStepper.tsx

@@ -1,137 +0,0 @@
-import React from "react"
-import classnames from "classnames"
-import {
-  IndicatorActiveIcon,
-  IndicatorInactiveIcon,
-  SuccessIcon,
-} from "~components/Icon"
-import { Text } from "~components/Text"
-import { VisuallyHidden } from "~components/VisuallyHidden"
-import styles from "./ProgressStepper.module.scss"
-
-export type ProgressStepperProps = {
-  stepName: string
-  steps: [string, ...string[]]
-  isComplete?: boolean
-}
-
-const getStepStatus = (
-  isComplete: boolean,
-  isCurrentStep: boolean,
-  step: string,
-  index: number
-): {
-  icon: JSX.Element
-  accessibleName: string
-} => {
-  if (isComplete) {
-    return {
-      icon: (
-        <SuccessIcon
-          key={index}
-          inheritSize
-          role="presentation"
-          classNameOverride="success"
-        />
-      ),
-      accessibleName: `Completed: ${step}`,
-    }
-  }
-  if (isCurrentStep) {
-    return {
-      icon: (
-        <IndicatorActiveIcon
-          key={index}
-          inheritSize
-          role="presentation"
-          classNameOverride="active"
-        />
-      ),
-      accessibleName: `Current: ${step}`,
-    }
-  }
-  return {
-    icon: (
-      <IndicatorInactiveIcon
-        key={index}
-        inheritSize
-        classNameOverride="incomplete"
-        role="presentation"
-      />
-    ),
-    accessibleName: `Not started: ${step}`,
-  }
-}
-
-export const ProgressStepper = ({
-  stepName,
-  steps,
-  isComplete = false,
-  ...restprops
-}: ProgressStepperProps): JSX.Element => {
-  const currentStepIndex = steps.indexOf(stepName)
-
-  return (
-    <div className={styles.stepsContainer}>
-      <ol
-        className={styles.stepList}
-        {...restprops}
-        aria-labelledby="stepper-description"
-      >
-        {steps.map((step: string, index: number) => {
-          const isCurrentStep = currentStepIndex === index
-          const isCompletedStep = index < currentStepIndex || isComplete
-          const { accessibleName, icon: Icon } = getStepStatus(
-            isCompletedStep,
-            isCurrentStep,
-            step,
-            index
-          )
-          return (
-            <li
-              className={styles.step}
-              key={`${index}-${step}`}
-              aria-current={isCurrentStep}
-            >
-              <div className={styles.stepContent}>
-                <VisuallyHidden>
-                  {/* will need to be translated */}
-                  {accessibleName}
-                </VisuallyHidden>
-                <Text
-                  classNameOverride={styles.stepName}
-                  variant="small"
-                  color="white"
-                  aria-hidden
-                >
-                  {step}
-                </Text>
-                <div className={styles.stepIndicator}>
-                  <span className={styles.stepIcon}>{Icon}</span>
-                </div>
-                {index < steps.length - 1 && (
-                  <div
-                    className={classnames([
-                      styles.stepDivider,
-                      isCompletedStep && styles.completedStep,
-                    ])}
-                  />
-                )}
-              </div>
-            </li>
-          )
-        })}
-      </ol>
-      <Text
-        classNameOverride={styles.stepperDescription}
-        variant="small"
-        color="white"
-        id="stepper-description"
-      >
-        Step {currentStepIndex + 1} of {steps.length}
-      </Text>
-    </div>
-  )
-}
-
-ProgressStepper.displayName = "Workflow.ProgressStepper"

package/src/__layout__/Workflow/v1/subcomponents/Footer/components/Root/FooterRoot.module.scss

@@ -1,22 +0,0 @@
-@import "~@kaizen/design-tokens/sass/spacing";
-@import "~@kaizen/design-tokens/sass/color";
-
-.footerRoot {
-  display: grid;
-  grid-template-areas: "prev stepper next";
-  grid-template-columns: 1fr 2fr 1fr;
-  flex-grow: 1;
-  justify-content: center;
-  align-items: center;
-  padding: $spacing-24 $spacing-12;
-  background: $color-blue-500;
-  gap: $spacing-16;
-
-  @media (min-width: 768px) {
-    grid-template-columns: 1fr 5fr 1fr;
-    padding: $spacing-24 $spacing-32;
-    position: sticky;
-    bottom: 0;
-    z-index: 1;
-  }
-}

package/src/__layout__/Workflow/v1/subcomponents/Footer/components/Root/Root.tsx

@@ -1,23 +0,0 @@
-import React, { HTMLAttributes } from "react"
-import classnames from "classnames"
-import { OverrideClassName } from "~components/types/OverrideClassName"
-import styles from "./FooterRoot.module.scss"
-
-export type FooterRootProps = OverrideClassName<
-  HTMLAttributes<HTMLHeadingElement>
->
-
-export const FooterRoot = ({
-  children,
-  classNameOverride,
-  ...restProps
-}: FooterRootProps): JSX.Element => (
-  <footer
-    className={classnames(styles.footerRoot, classNameOverride)}
-    {...restProps}
-  >
-    {children}
-  </footer>
-)
-
-FooterRoot.displayName = "Workflow.FooterRoot"

package/src/__layout__/Workflow/v1/subcomponents/Header/Header.tsx

@@ -1,27 +0,0 @@
-import React from "react"
-import {
-  HeaderRoot,
-  Branding,
-  Titles,
-  Actions,
-  WorkflowTitlesProps,
-  WorkflowActionsProps,
-} from "./components"
-
-export type HeaderProps = WorkflowTitlesProps & WorkflowActionsProps
-
-export const Header = ({
-  workflowName,
-  stepName,
-  status,
-  headerActions,
-  ...restProps
-}: HeaderProps): JSX.Element => (
-  <HeaderRoot {...restProps}>
-    <Branding alt="Culture Amp" />
-    <Titles workflowName={workflowName} stepName={stepName} status={status} />
-    <Actions headerActions={headerActions} />
-  </HeaderRoot>
-)
-
-Header.displayName = "Workflow.Header"

package/src/__layout__/Workflow/v1/subcomponents/Header/components/Actions/Actions.module.scss

@@ -1,17 +0,0 @@
-@import "~@kaizen/design-tokens/sass/spacing";
-
-.actions {
-  grid-area: actions;
-  display: flex;
-  flex-direction: column;
-  flex-grow: 1;
-  justify-content: center;
-  align-items: center;
-
-  @media (min-width: 768px) {
-    flex-direction: row;
-    align-items: flex-start;
-    justify-content: flex-end;
-    margin-top: calc(-1 * #{$spacing-12});
-  }
-}

package/src/__layout__/Workflow/v1/subcomponents/Header/components/Actions/Actions.tsx

@@ -1,24 +0,0 @@
-import React, { HTMLAttributes } from "react"
-import { OverrideClassName } from "~components/types/OverrideClassName"
-import styles from "./Actions.module.scss"
-
-export type WorkflowActionsProps = {
-  /**
-   * Header actions will render in order of the array.
-   */
-  headerActions?: JSX.Element[]
-} & OverrideClassName<Omit<HTMLAttributes<HTMLDivElement>, "children">>
-
-/** A wrapper for an exit trigger (and other) actions of the Header Workflow  */
-export const Actions = ({
-  headerActions,
-  ...restProps
-}: WorkflowActionsProps): JSX.Element => (
-  <div className={styles.actions} {...restProps}>
-    {headerActions?.map((action, index) => (
-      <action.type key={`header-actions ${index}`} {...action.props} />
-    ))}
-  </div>
-)
-
-Actions.displayName = "Workflow.Actions"

package/src/__layout__/Workflow/v1/subcomponents/Header/components/Branding/Branding.module.scss

@@ -1,17 +0,0 @@
-@import "~@kaizen/design-tokens/sass/spacing";
-
-.branding {
-  justify-content: center;
-  grid-area: branding;
-  display: flex;
-  flex-grow: 1;
-  padding-top: $spacing-4;
-
-  @media (min-width: 768px) {
-    justify-content: unset;
-  }
-}
-
-.logo {
-  flex-basis: 7.5rem;
-}

package/src/__layout__/Workflow/v1/subcomponents/Header/components/Branding/Branding.tsx

@@ -1,20 +0,0 @@
-import React, { HTMLAttributes } from "react"
-import { Brand, BrandProps } from "~components/Brand"
-import { OverrideClassName } from "~components/types/OverrideClassName"
-import styles from "./Branding.module.scss"
-
-export type WorflowBrandingProps = {
-  variant?: BrandProps["variant"]
-  alt: string
-} & OverrideClassName<HTMLAttributes<HTMLDivElement>>
-
-export const Branding = ({
-  variant = "logo-horizontal",
-  alt,
-}: WorflowBrandingProps): JSX.Element => (
-  <div className={styles.branding}>
-    <Brand classNameOverride={styles.logo} variant={variant} alt={alt} />
-  </div>
-)
-
-Branding.displayName = "Workflow.Branding"

package/src/__layout__/Workflow/v1/subcomponents/Header/components/Root/Root.module.scss

@@ -1,24 +0,0 @@
-@import "~@kaizen/design-tokens/sass/shadow";
-@import "~@kaizen/design-tokens/sass/spacing";
-@import "~@kaizen/design-tokens/sass/color";
-
-.root {
-  display: grid;
-  background-color: $color-white;
-  grid-template: "branding" min-content "titles" max-content "actions" min-content / 1fr;
-  flex-grow: 1;
-  justify-content: center;
-  align-items: center;
-  text-align: center;
-  box-shadow: $shadow-small-box-shadow;
-  padding: $spacing-24;
-  gap: $spacing-16;
-
-  @media (min-width: 768px) {
-    align-items: start;
-    grid-template: "branding titles actions" min-content / 1fr max-content 1fr;
-    position: sticky;
-    top: 0;
-    z-index: 1;
-  }
-}

package/src/__layout__/Workflow/v1/subcomponents/Header/components/Root/Root.tsx

@@ -1,20 +0,0 @@
-import React, { HTMLAttributes } from "react"
-import classnames from "classnames"
-import { OverrideClassName } from "~components/types/OverrideClassName"
-import styles from "./Root.module.scss"
-
-export type HeaderRootProps = OverrideClassName<
-  HTMLAttributes<HTMLHeadingElement>
->
-
-export const HeaderRoot = ({
-  children,
-  classNameOverride,
-  ...restProps
-}: HeaderRootProps): JSX.Element => (
-  <header className={classnames(styles.root, classNameOverride)} {...restProps}>
-    {children}
-  </header>
-)
-
-HeaderRoot.displayName = "Workflow.HeaderRoot"

package/src/__layout__/Workflow/v1/subcomponents/Header/components/Titles/Titles.module.scss

@@ -1,23 +0,0 @@
-@import "~@kaizen/design-tokens/sass/spacing";
-
-.titles {
-  grid-area: titles;
-  display: flex;
-  flex-direction: column;
-  align-items: center;
-  justify-content: center;
-  flex-grow: 1;
-}
-
-.pageTitle {
-  display: flex;
-  flex-direction: column;
-}
-
-.prefix {
-  margin-bottom: $spacing-4;
-}
-
-.status {
-  margin-top: $spacing-8;
-}

package/src/__layout__/Workflow/v1/subcomponents/Header/components/Titles/Titles.tsx

@@ -1,55 +0,0 @@
-import React, { HTMLAttributes } from "react"
-import { Heading } from "~components/Heading"
-import { Tag, DefaultTagProps } from "~components/Tag"
-import { VisuallyHidden } from "~components/VisuallyHidden"
-import { OverrideClassName } from "~components/types/OverrideClassName"
-import styles from "./Titles.module.scss"
-
-export type WorkflowStatus = {
-  /** @default: "statusDraft" */
-  variant?: DefaultTagProps["variant"]
-  content?: string
-}
-
-export type WorkflowTitlesProps = {
-  workflowName: string
-  stepName: string
-  status?: WorkflowStatus
-} & OverrideClassName<HTMLAttributes<HTMLDivElement>>
-
-export const Titles = ({
-  workflowName,
-  stepName,
-  status,
-  ...restProps
-}: WorkflowTitlesProps): JSX.Element => (
-  <div className={styles.titles} {...restProps}>
-    <Heading
-      variant="heading-1"
-      tag="h1"
-      color="dark"
-      classNameOverride={styles.pageTitle}
-    >
-      <Heading
-        classNameOverride={styles.prefix}
-        variant="heading-6"
-        tag="span"
-        color="dark-reduced-opacity"
-      >
-        {workflowName}
-        <VisuallyHidden>:</VisuallyHidden>
-      </Heading>
-      <span>{stepName}</span>
-    </Heading>
-    {status && (
-      // status may need to be update by a fetch
-      <div className={styles.status}>
-        <Tag inline variant={status?.variant || "statusDraft"}>
-          {status?.content}
-        </Tag>
-      </div>
-    )}
-  </div>
-)
-
-Titles.displayName = "Workflow.Titles"

package/src/__layout__/Workflow/v1/subcomponents/Main/Main.module.scss

@@ -1,4 +0,0 @@
-.main {
-  // This is set so children will sit beneath the header and footer when sticky
-  z-index: 0;
-}

package/src/__layout__/Workflow/v1/subcomponents/Main/Main.tsx

@@ -1,22 +0,0 @@
-import React, { HTMLAttributes, ReactNode } from "react"
-import classnames from "classnames"
-import { OverrideClassName } from "~components/types/OverrideClassName"
-import styles from "./Main.module.scss"
-
-export type WorkflowMainProps = OverrideClassName<
-  HTMLAttributes<HTMLDivElement>
-> & {
-  children: ReactNode
-}
-
-export const Main = ({
-  children,
-  classNameOverride,
-  ...restProps
-}: WorkflowMainProps): JSX.Element => (
-  <main className={classnames([styles.main, classNameOverride])} {...restProps}>
-    {children}
-  </main>
-)
-
-Main.displayName = "Workflow.Main"

package/src/__layout__/Workflow/v1/subcomponents/Wrapper/Wrapper.module.scss

@@ -1,9 +0,0 @@
-@import "~@kaizen/design-tokens/sass/color";
-
-.wrapper {
-  display: grid;
-  grid-template-rows: min-content 1fr min-content;
-  position: relative;
-  min-height: 100vh;
-  background: $color-gray-100;
-}

package/src/__layout__/Workflow/v1/subcomponents/Wrapper/Wrapper.tsx

@@ -1,22 +0,0 @@
-import React, { HTMLAttributes, ReactNode } from "react"
-import classnames from "classnames"
-import { OverrideClassName } from "~components/types/OverrideClassName"
-import styles from "./Wrapper.module.scss"
-
-export type WorkflowWrapperProps = OverrideClassName<
-  HTMLAttributes<HTMLDivElement>
-> & {
-  children: ReactNode
-}
-
-export const Wrapper = ({
-  children,
-  classNameOverride,
-  ...restProps
-}: WorkflowWrapperProps): JSX.Element => (
-  <div className={classnames(styles.wrapper, classNameOverride)} {...restProps}>
-    {children}
-  </div>
-)
-
-Wrapper.displayName = "Workflow.Wrapper"

package/src/__layout__/Workflow/v2/Workflow.tsx

@@ -1,55 +0,0 @@
-import React, { HTMLAttributes } from "react"
-import { OverrideClassName } from "~components/types/OverrideClassName"
-import {
-  Footer,
-  FooterProps,
-  Header,
-  Main,
-  HeaderProps,
-  ProgressStepper,
-  Wrapper,
-} from "./subcomponents"
-
-export type WorkflowProps = OverrideClassName<HTMLAttributes<HTMLDivElement>> &
-  FooterProps &
-  Pick<HeaderProps, "workflowName" | "status" | "headerActions">
-
-export const Workflow = ({
-  steps,
-  currentStepId,
-  isComplete,
-  workflowName,
-  status,
-  headerActions,
-  children,
-  nextAction,
-  previousAction,
-  classNameOverride,
-  ...restProps
-}: WorkflowProps): JSX.Element => {
-  const currentStep = steps.find(step => step.id === currentStepId)
-  return (
-    <Workflow.Wrapper classNameOverride={classNameOverride} {...restProps}>
-      <Workflow.Header
-        workflowName={workflowName}
-        stepName={currentStep!.label}
-        status={status}
-        headerActions={headerActions}
-      />
-      <Workflow.Main>{children}</Workflow.Main>
-      <Workflow.Footer
-        currentStepId={currentStepId}
-        steps={steps}
-        isComplete={isComplete}
-        nextAction={nextAction}
-        previousAction={previousAction}
-      />
-    </Workflow.Wrapper>
-  )
-}
-
-Workflow.Header = Header
-Workflow.Footer = Footer
-Workflow.Main = Main
-Workflow.ProgressStepper = ProgressStepper
-Workflow.Wrapper = Wrapper

package/src/__layout__/Workflow/v2/_docs/ProgressStepper.mdx

@@ -1,38 +0,0 @@
-import { Canvas, Controls, DocsStory, Meta } from "@storybook/blocks"
-import { Installation, ResourceLinks } from "~storybook/components"
-import * as ProgressStepperStories from "./ProgressStepper.stories"
-
-<Meta of={ProgressStepperStories} />
-
-# Progress Stepper
-
-<ResourceLinks
-  sourceCode="https://github.com/cultureamp/kaizen-design-system/tree/main/packages/components/src/Workflow"
-  figma="https://www.figma.com/file/IJTy1JpS4Xyop5cQwroRje/%F0%9F%9B%A0%EF%B8%8F-Self-reflection%3A-Build-Handoff?node-id=188%3A62005&t=x4zyx07E2G3BmKGw-1"
-  designGuidelines="https://cultureamp.atlassian.net/wiki/spaces/DesignSystem/pages/3064989884/Documentation"
-
-/>
-
-<Installation
-  installCommand="pnpm add @kaizen/components"
-  importStatement='import { Workflow } from "@kaizen/components/v2/layout"'
-/>
-
-## Overview
-
-This component is used in the `Footer` to track progress of the Workflows steps.
-
-It has no reverse variant and should only be used in the Worflow's `Footer` component.
-
-<Canvas of={ProgressStepperStories.Playground} />
-<Controls of={ProgressStepperStories.Playground} />
-
-## API
-
-<DocsStory of={ProgressStepperStories.ProgressStates} />
-
-<DocsStory of={ProgressStepperStories.AllStepsComplete} />
-
-<DocsStory of={ProgressStepperStories.FewerSteps} />
-
-<DocsStory of={ProgressStepperStories.EightSteps} />

package/src/__layout__/Workflow/v2/_docs/ProgressStepper.stories.tsx

@@ -1,94 +0,0 @@
-import React from "react"
-import { Meta, StoryObj } from "@storybook/react"
-import { Workflow } from "../"
-import { WorkflowControls } from "./controls"
-
-const meta = {
-  title: "Layout/Workflow/Workflow (v2)/Components/Progress Stepper",
-  component: Workflow.ProgressStepper,
-  argTypes: {
-    currentStepId: WorkflowControls.currentStepId,
-  },
-  args: {
-    currentStepId: "preview-step",
-    steps: [
-      { label: "Settings", id: "settings-step" },
-      { label: "Questions", id: "questions-step" },
-      { label: "Preview", id: "preview-step" },
-      { label: "Employees", id: "employees-step" },
-      { label: "Schedule", id: "schedule-step" },
-    ],
-    isComplete: false,
-  },
-  decorators: [
-    Story => (
-      <div className="bg-blue-500 p-8">
-        <Story />
-      </div>
-    ),
-  ],
-} satisfies Meta<typeof Workflow.ProgressStepper>
-
-export default meta
-
-type Story = StoryObj<typeof meta>
-
-/**
- * <p>This component is used in the `Footer` to track progress of the Workflows steps.</p>
- * <p>It has no reverse variant and should only be used in the Worflow's `Footer` component.</p>
- */
-export const Playground: Story = {
-  parameters: {
-    docs: {
-      canvas: {
-        sourceState: "shown",
-      },
-    },
-  },
-}
-
-/** <p>To ensure WCAG AA compliance, there are 3 visually destinct states.</p>
- * <p>These are reflected in their accessible names for screen reader: "Completed", "Current" and "Not started"</p>
- */
-export const ProgressStates: Story = {
-  args: {
-    currentStepId: "questions-step",
-  },
-}
-
-/**
- * <p>You can use the `isComplete` follow a successful submission to render all steps as complete.</p>
- */
-export const AllStepsComplete: Story = {
-  args: {
-    currentStepId: "schedule-step",
-    isComplete: true,
-  },
-}
-
-export const FewerSteps: Story = {
-  args: {
-    currentStepId: "questions-step",
-    steps: [
-      { label: "Settings", id: "settings-step" },
-      { label: "Questions", id: "questions-step" },
-      { label: "Preview", id: "preview-step" },
-    ],
-  },
-}
-
-/**
- * <p>We have baked in a container query to ensure the component can be responsive.</p>
- * <p>When a step reaches its minimum size (4.5rem), it will hide the display name to maximise realestate.</p>
- */
-export const EightSteps: Story = {
-  args: {
-    currentStepId: "questions-step",
-    steps: [
-      ...meta.args.steps,
-      { label: "Plan", id: "plan-step" },
-      { label: "Provision", id: "provision-step" },
-      { label: "Procure", id: "procure-step" },
-    ],
-  },
-}