@kaizen/components 1.62.0 → 1.63.1

package/dist/types/__layout__/Workflow/v2/Workflow.d.ts

@@ -1,27 +0,0 @@
-import { HTMLAttributes } from "react";
-import { OverrideClassName } from "../../../types/OverrideClassName";
-import { FooterProps, HeaderProps } from "./subcomponents";
-export type WorkflowProps = OverrideClassName<HTMLAttributes<HTMLDivElement>> & FooterProps & Pick<HeaderProps, "workflowName" | "status" | "headerActions">;
-export declare const Workflow: {
-    ({ steps, currentStepId, isComplete, workflowName, status, headerActions, children, nextAction, previousAction, classNameOverride, ...restProps }: WorkflowProps): JSX.Element;
-    Header: {
-        ({ workflowName, stepName, status, headerActions, ...restProps }: HeaderProps): JSX.Element;
-        displayName: string;
-    };
-    Footer: {
-        ({ steps, currentStepId, isComplete, previousAction, nextAction, ...restProps }: FooterProps): JSX.Element;
-        displayName: string;
-    };
-    Main: {
-        ({ children, classNameOverride, ...restProps }: import("./subcomponents").WorkflowMainProps): JSX.Element;
-        displayName: string;
-    };
-    ProgressStepper: {
-        ({ currentStepId, steps, isComplete, ...restprops }: import("./subcomponents").ProgressStepperProps): JSX.Element;
-        displayName: string;
-    };
-    Wrapper: {
-        ({ children, classNameOverride, ...restProps }: import("./subcomponents").WorkflowWrapperProps): JSX.Element;
-        displayName: string;
-    };
-};

package/dist/types/__layout__/Workflow/v2/_docs/controls/controls.d.ts

@@ -1,2 +0,0 @@
-import { ArgTypes } from "@storybook/react";
-export declare const WorkflowControls: Partial<ArgTypes>;

package/dist/types/__layout__/Workflow/v2/_docs/controls/index.d.ts

@@ -1 +0,0 @@
-export * from "./controls";

package/dist/types/__layout__/Workflow/v2/index.d.ts

@@ -1,27 +0,0 @@
-import { WorkflowProps as WorkflowPropsV2 } from "./Workflow";
-/** * @deprecated upgrade to v3 for the latest release */
-export declare const Workflow: {
-    ({ steps, currentStepId, isComplete, workflowName, status, headerActions, children, nextAction, previousAction, classNameOverride, ...restProps }: WorkflowPropsV2): JSX.Element;
-    Header: {
-        ({ workflowName, stepName, status, headerActions, ...restProps }: import("./subcomponents").HeaderProps): JSX.Element;
-        displayName: string;
-    };
-    Footer: {
-        ({ steps, currentStepId, isComplete, previousAction, nextAction, ...restProps }: import("./subcomponents").FooterProps): JSX.Element;
-        displayName: string;
-    };
-    Main: {
-        ({ children, classNameOverride, ...restProps }: import("./subcomponents").WorkflowMainProps): JSX.Element;
-        displayName: string;
-    };
-    ProgressStepper: {
-        ({ currentStepId, steps, isComplete, ...restprops }: import("./subcomponents").ProgressStepperProps): JSX.Element;
-        displayName: string;
-    };
-    Wrapper: {
-        ({ children, classNameOverride, ...restProps }: import("./subcomponents").WorkflowWrapperProps): JSX.Element;
-        displayName: string;
-    };
-};
-/** * @deprecated upgrade to v3 for the latest release */
-export type WorkflowProps = WorkflowPropsV2;

package/dist/types/__layout__/Workflow/v2/subcomponents/Footer/components/FooterActions/FooterActions.d.ts

@@ -1,11 +0,0 @@
-import { HTMLAttributes } from "react";
-import { OverrideClassName } from "../../../../../../../types/OverrideClassName";
-export type FooterActionsProps = {
-    actionType?: "Previous" | "Next";
-    action?: JSX.Element;
-} & OverrideClassName<Omit<HTMLAttributes<HTMLDivElement>, "children">>;
-/** A simple wrapper for a Footer previous or next action  */
-export declare const FooterAction: {
-    ({ actionType, action, ...restProps }: FooterActionsProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v2/subcomponents/Footer/components/FooterActions/index.d.ts

@@ -1 +0,0 @@
-export * from "./FooterActions";

package/dist/types/__layout__/Workflow/v2/subcomponents/Footer/components/ProgressStepper/index.d.ts

@@ -1 +0,0 @@
-export * from "./ProgressStepper";

package/dist/types/__layout__/Workflow/v2/subcomponents/Footer/components/Root/index.d.ts

@@ -1 +0,0 @@
-export * from "./Root";

package/dist/types/__layout__/Workflow/v2/subcomponents/Footer/components/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./Root";
-export * from "./ProgressStepper";
-export * from "./FooterActions";

package/dist/types/__layout__/Workflow/v2/subcomponents/Footer/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./Footer";
-export * from "./components";

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/Header.d.ts

@@ -1,6 +0,0 @@
-import { WorkflowActionsProps, WorkflowTitlesProps } from "./components";
-export type HeaderProps = WorkflowTitlesProps & WorkflowActionsProps;
-export declare const Header: {
-    ({ workflowName, stepName, status, headerActions, ...restProps }: HeaderProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/components/Actions/index.d.ts

@@ -1 +0,0 @@
-export * from "./Actions";

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/components/Branding/index.d.ts

@@ -1 +0,0 @@
-export * from "./Branding";

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/components/Root/Root.d.ts

@@ -1,7 +0,0 @@
-import { HTMLAttributes } from "react";
-import { OverrideClassName } from "../../../../../../../types/OverrideClassName";
-export type HeaderRootProps = OverrideClassName<HTMLAttributes<HTMLHeadingElement>>;
-export declare const HeaderRoot: {
-    ({ children, classNameOverride, ...restProps }: HeaderRootProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/components/Root/index.d.ts

@@ -1 +0,0 @@
-export * from "./Root";

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/components/Titles/Titles.d.ts

@@ -1,17 +0,0 @@
-import { HTMLAttributes } from "react";
-import { DefaultTagProps } from "../../../../../../../Tag";
-import { OverrideClassName } from "../../../../../../../types/OverrideClassName";
-export type WorkflowStatus = {
-    /** @default: "statusDraft" */
-    variant?: DefaultTagProps["variant"];
-    content?: string;
-};
-export type WorkflowTitlesProps = {
-    workflowName: string;
-    stepName: string;
-    status?: WorkflowStatus;
-} & OverrideClassName<HTMLAttributes<HTMLDivElement>>;
-export declare const Titles: {
-    ({ workflowName, stepName, status, ...restProps }: WorkflowTitlesProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/components/Titles/index.d.ts

@@ -1 +0,0 @@
-export * from "./Titles";

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/components/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./Titles";
-export * from "./Actions";
-export * from "./Branding";
-export * from "./Root";

package/dist/types/__layout__/Workflow/v2/subcomponents/Header/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./Header";
-export * from "./components";

package/dist/types/__layout__/Workflow/v2/subcomponents/Main/Main.d.ts

@@ -1,9 +0,0 @@
-import { HTMLAttributes, ReactNode } from "react";
-import { OverrideClassName } from "../../../../../types/OverrideClassName";
-export type WorkflowMainProps = OverrideClassName<HTMLAttributes<HTMLDivElement>> & {
-    children: ReactNode;
-};
-export declare const Main: {
-    ({ children, classNameOverride, ...restProps }: WorkflowMainProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v2/subcomponents/Main/index.d.ts

@@ -1 +0,0 @@
-export * from "./Main";

package/dist/types/__layout__/Workflow/v2/subcomponents/Wrapper/Wrapper.d.ts

@@ -1,9 +0,0 @@
-import { HTMLAttributes, ReactNode } from "react";
-import { OverrideClassName } from "../../../../../types/OverrideClassName";
-export type WorkflowWrapperProps = OverrideClassName<HTMLAttributes<HTMLDivElement>> & {
-    children: ReactNode;
-};
-export declare const Wrapper: {
-    ({ children, classNameOverride, ...restProps }: WorkflowWrapperProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v2/subcomponents/Wrapper/index.d.ts

@@ -1 +0,0 @@
-export * from "./Wrapper";

package/dist/types/__layout__/Workflow/v2/subcomponents/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./Footer";
-export * from "./Header";
-export * from "./Main";
-export * from "./Wrapper";

package/dist/types/__layout__/Workflow/v3/_docs/controls/controls.d.ts

@@ -1,2 +0,0 @@
-import { ArgTypes } from "@storybook/react";
-export declare const WorkflowControls: Partial<ArgTypes>;

package/dist/types/__layout__/Workflow/v3/_docs/controls/index.d.ts

@@ -1 +0,0 @@
-export * from "./controls";

package/dist/types/__layout__/Workflow/v3/subcomponents/Footer/Footer.d.ts

@@ -1,12 +0,0 @@
-import { OverrideClassName } from "../../../../../types/OverrideClassName";
-import { ProgressStepperProps, FooterRootProps } from "./components";
-export type FooterProps = {
-    /** An action to return to a previous step */
-    previousAction?: JSX.Element;
-    /** An action to progress to the next step or submit the form */
-    nextAction?: JSX.Element;
-} & ProgressStepperProps & OverrideClassName<Omit<FooterRootProps, "children">>;
-export declare const Footer: {
-    ({ steps, currentStepId, isComplete, previousAction, nextAction, ...restProps }: FooterProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v3/subcomponents/Footer/components/FooterActions/index.d.ts

@@ -1 +0,0 @@
-export * from "./FooterActions";

package/dist/types/__layout__/Workflow/v3/subcomponents/Footer/components/ProgressStepper/index.d.ts

@@ -1 +0,0 @@
-export * from "./ProgressStepper";

package/dist/types/__layout__/Workflow/v3/subcomponents/Footer/components/Root/Root.d.ts

@@ -1,7 +0,0 @@
-import { HTMLAttributes } from "react";
-import { OverrideClassName } from "../../../../../../../types/OverrideClassName";
-export type FooterRootProps = OverrideClassName<HTMLAttributes<HTMLHeadingElement>>;
-export declare const FooterRoot: {
-    ({ children, classNameOverride, ...restProps }: FooterRootProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v3/subcomponents/Footer/components/Root/index.d.ts

@@ -1 +0,0 @@
-export * from "./Root";

package/dist/types/__layout__/Workflow/v3/subcomponents/Footer/components/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./Root";
-export * from "./ProgressStepper";
-export * from "./FooterActions";

package/dist/types/__layout__/Workflow/v3/subcomponents/Footer/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./Footer";
-export * from "./components";

package/dist/types/__layout__/Workflow/v3/subcomponents/Header/components/Actions/Actions.d.ts

@@ -1,13 +0,0 @@
-import { HTMLAttributes } from "react";
-import { OverrideClassName } from "../../../../../../../types/OverrideClassName";
-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 declare const Actions: {
-    ({ headerActions, ...restProps }: WorkflowActionsProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v3/subcomponents/Header/components/Actions/index.d.ts

@@ -1 +0,0 @@
-export * from "./Actions";

package/dist/types/__layout__/Workflow/v3/subcomponents/Header/components/Branding/Branding.d.ts

@@ -1,11 +0,0 @@
-import { HTMLAttributes } from "react";
-import { BrandProps } from "../../../../../../../Brand";
-import { OverrideClassName } from "../../../../../../../types/OverrideClassName";
-export type WorflowBrandingProps = {
-    variant?: BrandProps["variant"];
-    alt: string;
-} & OverrideClassName<HTMLAttributes<HTMLDivElement>>;
-export declare const Branding: {
-    ({ variant, alt, }: WorflowBrandingProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v3/subcomponents/Header/components/Branding/index.d.ts

@@ -1 +0,0 @@
-export * from "./Branding";

package/dist/types/__layout__/Workflow/v3/subcomponents/Header/components/Root/index.d.ts

@@ -1 +0,0 @@
-export * from "./Root";

package/dist/types/__layout__/Workflow/v3/subcomponents/Header/components/Titles/index.d.ts

@@ -1 +0,0 @@
-export * from "./Titles";

package/dist/types/__layout__/Workflow/v3/subcomponents/Header/components/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./Titles";
-export * from "./Actions";
-export * from "./Branding";
-export * from "./Root";

package/dist/types/__layout__/Workflow/v3/subcomponents/Header/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./Header";
-export * from "./components";

package/dist/types/__layout__/Workflow/v3/subcomponents/Main/Main.d.ts

@@ -1,9 +0,0 @@
-import { HTMLAttributes, ReactNode } from "react";
-import { OverrideClassName } from "../../../../../types/OverrideClassName";
-export type WorkflowMainProps = OverrideClassName<HTMLAttributes<HTMLDivElement>> & {
-    children: ReactNode;
-};
-export declare const Main: {
-    ({ children, classNameOverride, ...restProps }: WorkflowMainProps): JSX.Element;
-    displayName: string;
-};

package/dist/types/__layout__/Workflow/v3/subcomponents/Main/index.d.ts

@@ -1 +0,0 @@
-export * from "./Main";

package/dist/types/__layout__/Workflow/v3/subcomponents/Wrapper/index.d.ts

@@ -1 +0,0 @@
-export * from "./Wrapper";

package/dist/types/__layout__/Workflow/v3/subcomponents/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./Footer";
-export * from "./Header";
-export * from "./Main";
-export * from "./Wrapper";

package/dist/types/__layout__/v1.d.ts

@@ -1 +0,0 @@
-export * from "./Workflow/v1";

package/dist/types/__layout__/v2.d.ts

@@ -1 +0,0 @@
-export * from "./Workflow/v2";

package/dist/types/__layout__/v3.d.ts

@@ -1 +0,0 @@
-export * from "./Workflow/v3";

package/src/__layout__/Workflow/v1/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 &
-  HeaderProps
-
-/**
- * @deprecated Use { Workflow } from `@kaizen/components/future`
- */
-export const Workflow = ({
-  stepName,
-  steps,
-  isComplete,
-  workflowName,
-  status,
-  headerActions,
-  children,
-  nextAction,
-  previousAction,
-  classNameOverride,
-  ...restProps
-}: WorkflowProps): JSX.Element => (
-  <Workflow.Wrapper classNameOverride={classNameOverride} {...restProps}>
-    <Workflow.Header
-      workflowName={workflowName}
-      stepName={stepName}
-      status={status}
-      headerActions={headerActions}
-    />
-    <Workflow.Main>{children}</Workflow.Main>
-    <Workflow.Footer
-      stepName={stepName}
-      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/v1/_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/v1/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/v1/_docs/ProgressStepper.stories.tsx

@@ -1,84 +0,0 @@
-import React from "react"
-import { Meta, StoryObj } from "@storybook/react"
-import { Workflow } from "../"
-
-const meta = {
-  title: "Layout/Workflow/Workflow (v1)/Components/Progress Stepper",
-  component: Workflow.ProgressStepper,
-  args: {
-    stepName: "Settings",
-    steps: ["Settings", "Questions", "Preview", "Employees", "Schedule"],
-    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: {
-    stepName: "Questions",
-  },
-}
-
-/**
- * <p>You can use the `isComplete` follow a successful submission to render all steps as complete.</p>
- */
-export const AllStepsComplete: Story = {
-  args: {
-    stepName: "Schedule",
-    isComplete: true,
-  },
-}
-
-export const FewerSteps: Story = {
-  args: {
-    stepName: "Questions",
-    steps: ["Settings", "Questions", "Preview"],
-  },
-}
-
-/**
- * <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: {
-    stepName: "Questions",
-    steps: [
-      "Settings",
-      "Questions",
-      "Preview",
-      "Employees",
-      "Schedule",
-      "Plan",
-      "Provision",
-      "Another thing",
-    ],
-  },
-}