updated deprecations

cultureamp · Sep 7, 2023 · 234cea4 · 234cea4
1 parent 2faae9e
commit 234cea4
Show file tree

Hide file tree

Showing 15 changed files with 21 additions and 24 deletions.
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/packages/brand-moment/src/BrandMoment.tsx b/packages/brand-moment/src/BrandMoment.tsx
@@ -25,6 +25,9 @@ export interface BrandMomentProps
   }
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const BrandMoment = ({
   mood,
   illustration,

diff --git a/packages/brand/src/Brand/Brand.tsx b/packages/brand/src/Brand/Brand.tsx
@@ -14,6 +14,9 @@ export interface BrandProps
   reversed?: boolean
 }
 
+/**
+ * @deprecated Please use the same component from `@kaizen/components`
+ */
 export const Brand = ({
   variant,
   alt,

diff --git a/packages/button/src/Button/Button.tsx b/packages/button/src/Button/Button.tsx
@@ -26,8 +26,7 @@ export type ButtonProps = GenericProps &
   }
 
 /**
- * {@link https://cultureamp.design/components/button/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-button--default-kaizen-site-demo Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const Button = forwardRef(
   (props: ButtonProps, ref: Ref<ButtonRef | undefined>) => (

diff --git a/packages/button/src/Button/DirectionalLink.tsx b/packages/button/src/Button/DirectionalLink.tsx
@@ -19,8 +19,7 @@ const iconMap = {
 }
 
 /**
- * {@link https://cultureamp.design/components/pagination/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/story/components-button-pagination-buttons--default-kaizen-directional-link Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const DirectionalLink = (props: DirectionalLinkProps): JSX.Element => (
   <GenericButton

diff --git a/packages/button/src/Button/IconButton.tsx b/packages/button/src/Button/IconButton.tsx
@@ -24,8 +24,7 @@ export type IconButtonProps = GenericProps &
   }
 
 /**
- * {@link https://cultureamp.design/components/icon-button/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/docs/components-button--default-kaizen-demo-icon Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const IconButton = (props: IconButtonProps): JSX.Element => (
   <GenericButton iconButton {...props} />

diff --git a/packages/button/src/Button/PaginationLink.tsx b/packages/button/src/Button/PaginationLink.tsx
@@ -9,8 +9,7 @@ export interface PaginationLinkProps extends GenericProps {
 }
 
 /**
- * {@link https://cultureamp.design/components/pagination/ Guidance} |
- * {@link https://cultureamp.design/storybook/?path=/story/components-button-pagination-buttons--default-kaizen-pagination-link Storybook}
+ * @deprecated Please use the same component from `@kaizen/components`
  */
 export const PaginationLink = (props: PaginationLinkProps): JSX.Element => (
   <GenericButton

diff --git a/packages/button/src/Button/components/GenericButton.tsx b/packages/button/src/Button/components/GenericButton.tsx
@@ -89,6 +89,9 @@ const getCustomProps = (props: Record<string, any>): Record<string, string> => {
   }, {})
 }
 
+/**
+ * @deprecated We no longer support the external use of GenericButton
+ */
 const GenericButton = forwardRef(
   (props: Props, ref: Ref<ButtonRef | undefined>) => {
     const buttonRef = useRef<HTMLButtonElement | HTMLAnchorElement>()