Deprecation, no breathing (#26)

* updated deprecations * Deprecate typography components * deprecated Radio, RadioGroup, RadioField, Label * deprecations * add missing deprecations * add changeset * modal deprecations * deprecate Select and Popover * Deprecate VisuallyHidden * deprecated table * update deprecations for spot illustrations * chore: deprecate Date(Range)Picker and TimeField * chore: update changeset * deprecated Skirt, SkirtCard, Content, Container * update changeset * update changeset * Deprecate Tooltip * deprecate menu and titleblock * add tooltip to changeset * deprecate Pagination * deprecate Well * deprecations * deprecate * deprecations * deprecations * deprecations * add changeset --------- Co-authored-by: Doug MacKenzie <[email protected]> Co-authored-by: Michael Winter <[email protected]> Co-authored-by: Cassandra Tam <[email protected]>
cultureamp · Nov 15, 2023 · 85d6981 · 85d6981
1 parent a6e89ef
commit 85d6981
Show file tree

Hide file tree

Showing 104 changed files with 797 additions and 167 deletions.
diff --git a/.changeset/sweet-shoes-taste.md b/.changeset/sweet-shoes-taste.md
@@ -0,0 +1,45 @@
+---
+"@kaizen/draft-likert-scale-legacy": patch
+"@kaizen/draft-filter-menu-button": patch
+"@kaizen/draft-title-block-zen": patch
+"@kaizen/draft-guidance-block": patch
+"@kaizen/draft-illustration": patch
+"@kaizen/draft-collapsible": patch
+"@kaizen/draft-empty-state": patch
+"@kaizen/draft-page-layout": patch
+"@kaizen/component-library": patch
+"@kaizen/loading-skeleton": patch
+"@kaizen/rich-text-editor": patch
+"@kaizen/draft-hero-card": patch
+"@kaizen/loading-spinner": patch
+"@kaizen/draft-divider": patch
+"@kaizen/draft-popover": patch
+"@kaizen/draft-tooltip": patch
+"@kaizen/draft-avatar": patch
+"@kaizen/draft-select": patch
+"@kaizen/brand-moment": patch
+"@kaizen/notification": patch
+"@kaizen/progress-bar": patch
+"@kaizen/split-button": patch
+"@kaizen/draft-badge": patch
+"@kaizen/draft-modal": patch
+"@kaizen/draft-table": patch
+"@kaizen/date-picker": patch
+"@kaizen/draft-card": patch
+"@kaizen/draft-form": patch
+"@kaizen/draft-menu": patch
+"@kaizen/draft-tabs": patch
+"@kaizen/draft-tile": patch
+"@kaizen/draft-well": patch
+"@kaizen/pagination": patch
+"@kaizen/responsive": patch
+"@kaizen/typography": patch
+"@kaizen/draft-tag": patch
+"@kaizen/button": patch
+"@kaizen/select": patch
+"@kaizen/brand": patch
+"@kaizen/a11y": patch
+"@kaizen/tabs": patch
+---
+
+Deprecated in favour of `@kaizen/components`
diff --git a/draft-packages/avatar/KaizenDraft/Avatar/Avatar.tsx b/draft-packages/avatar/KaizenDraft/Avatar/Avatar.tsx
@@ -113,8 +113,7 @@ const renderInitials = (
 }
 
 /**
- * {@link https://cultureamp.design/components/avatar/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-avatar-avatar--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const Avatar = ({
   fullName,

diff --git a/draft-packages/avatar/KaizenDraft/Avatar/AvatarGroup.tsx b/draft-packages/avatar/KaizenDraft/Avatar/AvatarGroup.tsx
@@ -67,8 +67,7 @@ const renderAvatars = (
 )
 
 /**
- * {@link https://cultureamp.design/components/avatar-group/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-avatar-avatar-group--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const AvatarGroup = ({
   size = "medium",

diff --git a/draft-packages/badge/KaizenDraft/Badge/Badge.tsx b/draft-packages/badge/KaizenDraft/Badge/Badge.tsx
@@ -28,8 +28,7 @@ interface DotProps extends Omit<CommonProps, "variant"> {
 export type BadgeProps = CommonProps | DotProps
 
 /**
- * {@link https://cultureamp.design/components/badge/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-badge--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const Badge = ({
   children,

diff --git a/draft-packages/card/KaizenDraft/Card/Card.tsx b/draft-packages/card/KaizenDraft/Card/Card.tsx
@@ -30,8 +30,7 @@ export interface CardProps
 }
 
 /**
- * {@link https://cultureamp.design/components/card/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/story/components-card--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const Card = ({
   children,

diff --git a/draft-packages/collapsible/KaizenDraft/Collapsible/Collapsible.tsx b/draft-packages/collapsible/KaizenDraft/Collapsible/Collapsible.tsx
@@ -52,8 +52,7 @@ type State = {
 }
 
 /**
- * {@link https://cultureamp.design/components/collapsible/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-collapsible--single-collapsible-kaizen-site-demo Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export class Collapsible extends React.Component<CollapsibleProps, State> {
   public state = {

diff --git a/draft-packages/collapsible/KaizenDraft/CollapsibleGroup/CollapsibleGroup.tsx b/draft-packages/collapsible/KaizenDraft/CollapsibleGroup/CollapsibleGroup.tsx
@@ -24,8 +24,7 @@ export interface CollapsibleGroupProps
 }
 
 /**
- * {@link https://cultureamp.design/components/collapsible/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-collapsible--collapsible-group-default Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const CollapsibleGroup = ({
   children,

diff --git a/draft-packages/collapsible/KaizenDraft/ExpertAdviceCollapsible/ExpertAdviceCollapsible.tsx b/draft-packages/collapsible/KaizenDraft/ExpertAdviceCollapsible/ExpertAdviceCollapsible.tsx
@@ -10,8 +10,7 @@ export type ExpertAdviceCollapsibleProps = Omit<
 >
 
 /**
- * {@link https://cultureamp.design/components/collapsible/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-collapsible-expert-advice-collapsible--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const ExpertAdviceCollapsible = (
   props: ExpertAdviceCollapsibleProps

diff --git a/draft-packages/divider/KaizenDraft/Divider/Divider.tsx b/draft-packages/divider/KaizenDraft/Divider/Divider.tsx
@@ -10,8 +10,7 @@ export interface DividerProps
 }
 
 /**
- * {@link https://cultureamp.design/components/divider/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-divider--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const Divider = ({
   variant,

diff --git a/draft-packages/empty-state/KaizenDraft/EmptyState/EmptyState.tsx b/draft-packages/empty-state/KaizenDraft/EmptyState/EmptyState.tsx
@@ -55,8 +55,7 @@ export interface EmptyStateProps
 }
 
 /**
- * {@link https://cultureamp.design/components/empty-state/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-empty-state--default-kaizen-site-demo Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const EmptyState = ({
   children,

diff --git a/draft-packages/filter-menu-button/KaizenDraft/FilterMenuButton/FilterMenuButton.tsx b/draft-packages/filter-menu-button/KaizenDraft/FilterMenuButton/FilterMenuButton.tsx
@@ -4,7 +4,7 @@ import { FilterSplitButton } from "./FilterSplitButton"
 import styles from "./FilterMenuButton.module.scss"
 
 /**
- * @deprecated draft-packages FilterMenuButton is deprecated. Please use FilterMultiSelect from "@kaizen/select" instead.
+ * @deprecated draft-packages FilterMenuButton is deprecated. Please use FilterMultiSelect from "@kaizen/components" instead.
  */
 export interface FilterMenuButtonProps {
   /* The html id attribute of the container element. This is also used
@@ -55,7 +55,9 @@ export interface FilterMenuButtonProps {
    */
   onFilterClear?: (e: React.MouseEvent<any>) => void
 }
-
+/**
+ * @deprecated draft-packages FilterMenuButton is deprecated. Please use FilterMultiSelect from "@kaizen/components" instead.
+ */
 export const FilterMenuButton = ({
   id,
   labelText,

diff --git a/draft-packages/filter-menu-button/KaizenDraft/FilterMenuButton/FilterSplitButton.tsx b/draft-packages/filter-menu-button/KaizenDraft/FilterMenuButton/FilterSplitButton.tsx
@@ -16,7 +16,9 @@ type FilterSplitButtonProps = {
   ariaControls: string
   isDropdownVisible: boolean
 }
-
+/**
+ * @deprecated draft-packages FilterSplitButton is deprecated. Please use FilterMultiSelect from "@kaizen/components" instead.
+ */
 export const FilterSplitButton = ({
   labelText,
   metadata,

diff --git a/draft-packages/form/KaizenDraft/Form/CheckboxField/CheckboxField.tsx b/draft-packages/form/KaizenDraft/Form/CheckboxField/CheckboxField.tsx
@@ -19,8 +19,7 @@ export interface CheckboxFieldProps extends Omit<CheckboxProps, "id"> {
 }
 
 /**
- * {@link https://cultureamp.design/components/checkbox-field/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-form-checkbox-field--interactive-kaizen-site-demo Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const CheckboxField = ({
   id: propsId,

diff --git a/draft-packages/form/KaizenDraft/Form/CheckboxGroup/CheckboxGroup.tsx b/draft-packages/form/KaizenDraft/Form/CheckboxGroup/CheckboxGroup.tsx
@@ -20,8 +20,7 @@ export interface CheckboxGroupProps
 }
 
 /**
- * {@link https://cultureamp.design/components/checkbox-group/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-form-checkbox-group--interactive-kaizen-site-demo Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const CheckboxGroup = ({
   children,

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/Checkbox/Checkbox.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/Checkbox/Checkbox.tsx
@@ -39,6 +39,9 @@ const renderCheckOrMixedIcon = (
 const getCheckedFromStatus = (checkedStatus: CheckedStatus): boolean =>
   checkedStatus === "on"
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const Checkbox = ({
   checkedStatus = "off",
   onCheck,

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/ClearButton/ClearButton.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/ClearButton/ClearButton.tsx
@@ -13,6 +13,9 @@ export interface ClearButtonProps
   isReversed?: boolean
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const ClearButton = ({
   classNameOverride,
   isReversed = false,

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/FieldGroup/FieldGroup.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/FieldGroup/FieldGroup.tsx
@@ -19,6 +19,9 @@ export interface FieldGroupProps
   automationId?: string
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const FieldGroup = ({
   children,
   inline = false,

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/FieldMessage/FieldMessage.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/FieldMessage/FieldMessage.tsx
@@ -22,6 +22,9 @@ export interface FieldMessageProps
   automationId?: string
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const FieldMessage = ({
   message,
   status = "default",

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/Input/Input.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/Input/Input.tsx
@@ -51,6 +51,9 @@ export interface InputProps
   automationId?: string
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const Input = ({
   inputRef,
   status = "default",

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/InputRange/InputRange.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/InputRange/InputRange.tsx
@@ -15,6 +15,9 @@ export interface InputRangeProps
   max?: number
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const InputRange = (props: InputRangeProps): JSX.Element => {
   const {
     id,

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/InputSearch/InputSearch.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/InputSearch/InputSearch.tsx
@@ -18,6 +18,9 @@ export interface InputSearchProps
   onClear?: () => void
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const InputSearch = (props: InputSearchProps): JSX.Element => {
   const {
     value,

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/Label/Label.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/Label/Label.tsx
@@ -21,6 +21,9 @@ export interface LabelProps
   automationId?: string
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const Label = ({
   children,
   labelText = "",

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/Radio/Radio.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/Radio/Radio.tsx
@@ -31,6 +31,9 @@ const renderSelected = (
   return
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const Radio = ({
   name,
   value,

diff --git a/draft-packages/form/KaizenDraft/Form/Primitives/TextArea/TextArea.tsx b/draft-packages/form/KaizenDraft/Form/Primitives/TextArea/TextArea.tsx
@@ -21,6 +21,9 @@ export interface TextAreaProps
   automationId?: string
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const TextArea = ({
   textAreaRef: propsTextAreaRef,
   status = "default",

diff --git a/draft-packages/form/KaizenDraft/Form/RadioField/RadioField.tsx b/draft-packages/form/KaizenDraft/Form/RadioField/RadioField.tsx
@@ -19,8 +19,7 @@ export interface RadioFieldProps extends Omit<RadioProps, "id"> {
 }
 
 /**
- * {@link https://cultureamp.design/components/radio-field/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-form-radio-field--interactive-kaizen-site-demo Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const RadioField = ({
   id: propsId,

diff --git a/draft-packages/form/KaizenDraft/Form/RadioGroup/RadioGroup.tsx b/draft-packages/form/KaizenDraft/Form/RadioGroup/RadioGroup.tsx
@@ -19,6 +19,9 @@ export interface RadioGroupProps
   automationId?: string
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const RadioGroup = ({
   children,
   labelId: propsLabelId,

diff --git a/draft-packages/form/KaizenDraft/Form/SearchField/SearchField.tsx b/draft-packages/form/KaizenDraft/Form/SearchField/SearchField.tsx
@@ -12,8 +12,7 @@ export interface SearchFieldProps extends Omit<InputSearchProps, "id"> {
 }
 
 /**
- * {@link https://cultureamp.design/components/search-field/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-form-search-field--default-kaizen-demo Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const SearchField = ({
   id: propsId,

diff --git a/draft-packages/form/KaizenDraft/Form/Slider/Slider.tsx b/draft-packages/form/KaizenDraft/Form/Slider/Slider.tsx
@@ -17,8 +17,7 @@ export interface SliderFieldProps extends Omit<InputRangeProps, "id"> {
 }
 
 /**
- * {@link https://cultureamp.design/components/slider/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-form-slider--controlled Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const Slider = (props: SliderFieldProps): JSX.Element => {
   const {

diff --git a/draft-packages/form/KaizenDraft/Form/TextAreaField/TextAreaField.tsx b/draft-packages/form/KaizenDraft/Form/TextAreaField/TextAreaField.tsx
@@ -20,8 +20,7 @@ export interface TextAreaFieldProps
 }
 
 /**
- * {@link https://cultureamp.design/components/text-area-field/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-form-text-area-field--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const TextAreaField = ({
   labelText,

diff --git a/draft-packages/form/KaizenDraft/Form/TextField/TextField.tsx b/draft-packages/form/KaizenDraft/Form/TextField/TextField.tsx
@@ -37,8 +37,7 @@ export interface TextFieldProps extends Omit<InputProps, OmittedInputProps> {
 }
 
 /**
- * {@link https://cultureamp.design/components/text-field/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-form-text-field--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const TextField = ({
   id: propsId,

diff --git a/draft-packages/guidance-block/KaizenDraft/GuidanceBlock/GuidanceBlock.tsx b/draft-packages/guidance-block/KaizenDraft/GuidanceBlock/GuidanceBlock.tsx
@@ -111,8 +111,7 @@ const WithTooltip = ({
   )
 
 /**
- * {@link https://cultureamp.design/components/guidance-block/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-guidance-block--default-story Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 class GuidanceBlock extends React.Component<
   GuidanceBlockProps,

diff --git a/draft-packages/hero-card/KaizenDraft/HeroCard/HeroCard.tsx b/draft-packages/hero-card/KaizenDraft/HeroCard/HeroCard.tsx
@@ -23,7 +23,7 @@ export interface HeroCardProps
 
 /**
  * @deprecated HeroCard is deprecated.
- * No further changes will be made to it as it will be superseded by Tile.
+ * No further changes will be made to it as it will be superseded by Tile from `@kaizen/components`
  */
 export const HeroCard = ({
   children,
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,9 @@ export interface InputRangeProps @@
       max?: number
     }
+    /**
+     * @deprecated Please use the same component from `@kaizen/components`
+     */
     export const InputRange = (props: InputRangeProps): JSX.Element => {
       const {
         id,
@@ Expand Down @@