From 8163b035adbc8f9a0fe20ea639e6132369bb1196 Mon Sep 17 00:00:00 2001 From: Geoffrey Chong Date: Wed, 8 Nov 2023 14:18:55 +1100 Subject: [PATCH] deprecations --- .../GuidanceBlock/GuidanceBlock.tsx | 3 +- .../KaizenDraft/Illustration/Scene.tsx | 180 +++++++++++++----- .../component-library/components/Box/Box.tsx | 2 +- .../components/Icon/Icon.tsx | 3 +- .../components/Text/Text.tsx | 2 +- packages/tabs/src/Tab.tsx | 2 +- packages/tabs/src/TabList.tsx | 2 +- packages/tabs/src/TabPanel.tsx | 2 +- packages/tabs/src/TabPanels.tsx | 2 +- packages/tabs/src/Tabs.tsx | 5 +- 10 files changed, 144 insertions(+), 59 deletions(-) diff --git a/draft-packages/guidance-block/KaizenDraft/GuidanceBlock/GuidanceBlock.tsx b/draft-packages/guidance-block/KaizenDraft/GuidanceBlock/GuidanceBlock.tsx index fbb074b..784fdca 100644 --- 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/illustration/KaizenDraft/Illustration/Scene.tsx b/draft-packages/illustration/KaizenDraft/Illustration/Scene.tsx index 3e436c2..cb859ab 100644 --- a/draft-packages/illustration/KaizenDraft/Illustration/Scene.tsx +++ b/draft-packages/illustration/KaizenDraft/Illustration/Scene.tsx @@ -26,7 +26,9 @@ interface NotAnimatedProps extends BaseAnimatedSceneProps { export type AnimatedSceneProps = AnimatedProps | NotAnimatedProps // Brand Moments - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const BrandMomentPositiveOutro = ({ isAnimated, enableAspectRatio, @@ -53,7 +55,9 @@ export const BrandMomentPositiveOutro = ({ ) } BrandMomentPositiveOutro.displayName = "BrandMomentPositiveOutro" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const BrandMomentLogin = ({ isAnimated, enableAspectRatio, @@ -80,7 +84,9 @@ export const BrandMomentLogin = ({ ) } BrandMomentLogin.displayName = "BrandMomentLogin" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const BrandMomentError = ({ isAnimated, enableAspectRatio, @@ -107,7 +113,9 @@ export const BrandMomentError = ({ ) } BrandMomentError.displayName = "BrandMomentError" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const BrandMomentNewAccountOnboarding = ({ enableAspectRatio, ...props @@ -119,7 +127,9 @@ export const BrandMomentNewAccountOnboarding = ({ /> ) BrandMomentNewAccountOnboarding.displayName = "BrandMomentNewAccountOnboarding" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const BrandMomentUploadEmployeeData = ({ enableAspectRatio, ...props @@ -131,7 +141,9 @@ export const BrandMomentUploadEmployeeData = ({ /> ) BrandMomentUploadEmployeeData.displayName = "BrandMomentUploadEmployeeData" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const BrandMomentStarterKit = ({ enableAspectRatio, ...props @@ -145,7 +157,9 @@ export const BrandMomentStarterKit = ({ BrandMomentStarterKit.displayName = "BrandMomentStarterKit" // Empty States - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const EmptyStatesAction = ({ isAnimated, enableAspectRatio, @@ -172,7 +186,9 @@ export const EmptyStatesAction = ({ ) } EmptyStatesAction.displayName = "EmptyStatesAction" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const EmptyStatesInformative = ({ isAnimated, enableAspectRatio, @@ -199,7 +215,9 @@ export const EmptyStatesInformative = ({ ) } EmptyStatesInformative.displayName = "EmptyStatesInformative" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const EmptyStatesNegative = ({ isAnimated, enableAspectRatio, @@ -226,7 +244,9 @@ export const EmptyStatesNegative = ({ ) } EmptyStatesNegative.displayName = "EmptyStatesNegative" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const EmptyStatesPositive = ({ isAnimated, enableAspectRatio, @@ -253,7 +273,9 @@ export const EmptyStatesPositive = ({ ) } EmptyStatesPositive.displayName = "EmptyStatesPositive" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const EmptyStatesNeutral = ({ isAnimated, enableAspectRatio, @@ -282,7 +304,9 @@ export const EmptyStatesNeutral = ({ EmptyStatesNeutral.displayName = "EmptyStatesNeutral" // Information Modals - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const Information360Upgrade = ({ enableAspectRatio, ...props @@ -294,7 +318,9 @@ export const Information360Upgrade = ({ /> ) Information360Upgrade.displayName = "Information360Upgrade" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const InformationDemographicFocus = ({ enableAspectRatio, ...props @@ -306,7 +332,9 @@ export const InformationDemographicFocus = ({ /> ) InformationDemographicFocus.displayName = "InformationDemographicFocus" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const InformationTurnoverCalculator = ({ enableAspectRatio, ...props @@ -318,7 +346,9 @@ export const InformationTurnoverCalculator = ({ /> ) InformationTurnoverCalculator.displayName = "InformationTurnoverCalculator" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const InformationTurnoverForecast = ({ enableAspectRatio, ...props @@ -330,7 +360,9 @@ export const InformationTurnoverForecast = ({ /> ) InformationTurnoverForecast.displayName = "InformationTurnoverForecast" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const InformationEmergingTrends = ({ enableAspectRatio, ...props @@ -342,7 +374,9 @@ export const InformationEmergingTrends = ({ /> ) InformationEmergingTrends.displayName = "InformationEmergingTrends" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const InformationEmployeeLifecycle = ({ enableAspectRatio, ...props @@ -354,7 +388,9 @@ export const InformationEmployeeLifecycle = ({ /> ) InformationEmployeeLifecycle.displayName = "InformationEmployeeLifecycle" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const InformationReportOwner = ({ enableAspectRatio, ...props @@ -366,7 +402,9 @@ export const InformationReportOwner = ({ /> ) InformationReportOwner.displayName = "InformationReportOwner" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const InformationReportOwnerByRule = ({ enableAspectRatio, ...props @@ -380,7 +418,9 @@ export const InformationReportOwnerByRule = ({ InformationReportOwnerByRule.displayName = "InformationReportOwnerByRule" // Miscellaneous - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const Collaboration = ({ enableAspectRatio, ...props @@ -392,7 +432,9 @@ export const Collaboration = ({ /> ) Collaboration.displayName = "Collaboration" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const Communication = ({ enableAspectRatio, ...props @@ -404,7 +446,9 @@ export const Communication = ({ /> ) Communication.displayName = "Communication" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const CompanyValues = ({ enableAspectRatio, ...props @@ -416,7 +460,9 @@ export const CompanyValues = ({ /> ) CompanyValues.displayName = "CompanyValues" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const ConnectTheDots = ({ enableAspectRatio, ...props @@ -428,7 +474,9 @@ export const ConnectTheDots = ({ /> ) ConnectTheDots.displayName = "ConnectTheDots" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const CultureLab = ({ enableAspectRatio, ...props @@ -440,7 +488,9 @@ export const CultureLab = ({ /> ) CultureLab.displayName = "CultureLab" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const TermsAgreement = ({ enableAspectRatio, ...props @@ -454,7 +504,9 @@ export const TermsAgreement = ({ TermsAgreement.displayName = "TermsAgreement" // Skills Coach - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoach1On1Meetings = ({ enableAspectRatio, ...props @@ -466,7 +518,9 @@ export const SkillsCoach1On1Meetings = ({ /> ) SkillsCoach1On1Meetings.displayName = "SkillsCoach1On1Meetings" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachCoaching = ({ enableAspectRatio, ...props @@ -478,7 +532,9 @@ export const SkillsCoachCoaching = ({ /> ) SkillsCoachCoaching.displayName = "SkillsCoachCoaching" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachEmployeeDevelopment = ({ enableAspectRatio, ...props @@ -490,7 +546,9 @@ export const SkillsCoachEmployeeDevelopment = ({ /> ) SkillsCoachEmployeeDevelopment.displayName = "SkillsCoachEmployeeDevelopment" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachEssentialFeedback = ({ enableAspectRatio, ...props @@ -502,7 +560,9 @@ export const SkillsCoachEssentialFeedback = ({ /> ) SkillsCoachEssentialFeedback.displayName = "SkillsCoachEssentialFeedback" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachEssentialProductivity = ({ enableAspectRatio, ...props @@ -515,7 +575,9 @@ export const SkillsCoachEssentialProductivity = ({ ) SkillsCoachEssentialProductivity.displayName = "SkillsCoachEssentialProductivity" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachEssentialResilience = ({ enableAspectRatio, ...props @@ -527,7 +589,9 @@ export const SkillsCoachEssentialResilience = ({ /> ) SkillsCoachEssentialResilience.displayName = "SkillsCoachEssentialResilience" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachInfluentialCommunication = ({ enableAspectRatio, ...props @@ -540,7 +604,9 @@ export const SkillsCoachInfluentialCommunication = ({ ) SkillsCoachInfluentialCommunication.displayName = "SkillsCoachInfluentialCommunication" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachLeadingChange = ({ enableAspectRatio, ...props @@ -552,7 +618,9 @@ export const SkillsCoachLeadingChange = ({ /> ) SkillsCoachLeadingChange.displayName = "SkillsCoachLeadingChange" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachFeedback = ({ enableAspectRatio, ...props @@ -564,7 +632,9 @@ export const SkillsCoachFeedback = ({ /> ) SkillsCoachFeedback.displayName = "SkillsCoachFeedback" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachManagerHub = ({ enableAspectRatio, ...props @@ -576,7 +646,9 @@ export const SkillsCoachManagerHub = ({ /> ) SkillsCoachManagerHub.displayName = "SkillsCoachManagerHub" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachProductivity = ({ enableAspectRatio, ...props @@ -588,7 +660,9 @@ export const SkillsCoachProductivity = ({ /> ) SkillsCoachProductivity.displayName = "SkillsCoachProductivity" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachRemoteManager = ({ enableAspectRatio, ...props @@ -600,7 +674,9 @@ export const SkillsCoachRemoteManager = ({ /> ) SkillsCoachRemoteManager.displayName = "SkillsCoachRemoteManager" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachResilience = ({ enableAspectRatio, ...props @@ -612,7 +688,9 @@ export const SkillsCoachResilience = ({ /> ) SkillsCoachResilience.displayName = "SkillsCoachResilience" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SkillsCoachStrategy = ({ enableAspectRatio, ...props @@ -626,7 +704,9 @@ export const SkillsCoachStrategy = ({ SkillsCoachStrategy.displayName = "SkillsCoachStrategy" // Engagement - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const Programs = ({ enableAspectRatio, ...props @@ -638,7 +718,9 @@ export const Programs = ({ /> ) Programs.displayName = "Programs" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const EngagementSurveySummaryFemale = ({ enableAspectRatio, ...props @@ -650,7 +732,9 @@ export const EngagementSurveySummaryFemale = ({ /> ) EngagementSurveySummaryFemale.displayName = "EngagementSurveySummaryFemale" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const EngagementSurveySummaryMale = ({ enableAspectRatio, ...props @@ -662,7 +746,9 @@ export const EngagementSurveySummaryMale = ({ /> ) EngagementSurveySummaryMale.displayName = "EngagementSurveySummaryMale" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SurveyOverviewClosed = ({ enableAspectRatio, ...props @@ -674,7 +760,9 @@ export const SurveyOverviewClosed = ({ /> ) SurveyOverviewClosed.displayName = "SurveyOverviewClosed" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const SurveyGetStarted = ({ enableAspectRatio, ...props @@ -686,7 +774,9 @@ export const SurveyGetStarted = ({ /> ) SurveyGetStarted.displayName = "SurveyGetStarted" - +/** + * @deprecated Please use the same component from `@kaizen/components` + */ export const PerformanceCompanySettings = ({ enableAspectRatio, ...props diff --git a/packages/component-library/components/Box/Box.tsx b/packages/component-library/components/Box/Box.tsx index a97f84e..52508e0 100644 --- a/packages/component-library/components/Box/Box.tsx +++ b/packages/component-library/components/Box/Box.tsx @@ -15,7 +15,7 @@ export interface BoxProps } /** - * {@link https://cultureamp.design/storybook/?path=/docs/components-box--box-default Storybook} + * @deprecated Please replace with `div` plus Tailwind. */ export const Box = ({ children, diff --git a/packages/component-library/components/Icon/Icon.tsx b/packages/component-library/components/Icon/Icon.tsx index d9048ff..549e5b0 100644 --- a/packages/component-library/components/Icon/Icon.tsx +++ b/packages/component-library/components/Icon/Icon.tsx @@ -18,8 +18,7 @@ export interface IconProps } /** - * {@link https://cultureamp.design/components/icon/ Guidance} | - * {@link https://cultureamp.design/storybook/?path=/docs/components-icon--meaningful-kaizen-site-demo Storybook} + * @deprecated Replace with individual React icons. See: {@link https://cultureamp.design/?path=/docs/components-icons--docs Reference} */ export const Icon = ({ icon, diff --git a/packages/component-library/components/Text/Text.tsx b/packages/component-library/components/Text/Text.tsx index 95a8e58..e81a8d5 100644 --- a/packages/component-library/components/Text/Text.tsx +++ b/packages/component-library/components/Text/Text.tsx @@ -36,7 +36,7 @@ type TextProps = { } /** - * @deprecated Text is deprecated. Use Paragraph or Heading instead. + * @deprecated Please use the same component from `@kaizen/components` */ const Text = ({ tag, diff --git a/packages/tabs/src/Tab.tsx b/packages/tabs/src/Tab.tsx index 9725cc1..b8a5987 100644 --- a/packages/tabs/src/Tab.tsx +++ b/packages/tabs/src/Tab.tsx @@ -21,7 +21,7 @@ export interface TabProps { } /** - * A tab button + * @deprecated Please use the same component from `@kaizen/components` */ export const Tab = (props: TabProps): JSX.Element => { const { isSelected, badge, disabled, children } = props diff --git a/packages/tabs/src/TabList.tsx b/packages/tabs/src/TabList.tsx index 1f0b106..07b7985 100644 --- a/packages/tabs/src/TabList.tsx +++ b/packages/tabs/src/TabList.tsx @@ -16,7 +16,7 @@ export interface TabListProps { } /** - * Wrapper for the tabs themselves + * @deprecated Please use the same component from `@kaizen/components` */ export const TabList = (props: TabListProps): JSX.Element => { const { "aria-label": ariaLabel, noPadding = false, children } = props diff --git a/packages/tabs/src/TabPanel.tsx b/packages/tabs/src/TabPanel.tsx index 241bc0c..327781c 100644 --- a/packages/tabs/src/TabPanel.tsx +++ b/packages/tabs/src/TabPanel.tsx @@ -7,7 +7,7 @@ export interface TabPanelProps { } /** - * Wrapper for the content that shows when tab is active + * @deprecated Please use the same component from `@kaizen/components` */ export const TabPanel = (props: TabPanelProps): JSX.Element => { const { children } = props diff --git a/packages/tabs/src/TabPanels.tsx b/packages/tabs/src/TabPanels.tsx index 7bcc127..d60fd61 100644 --- a/packages/tabs/src/TabPanels.tsx +++ b/packages/tabs/src/TabPanels.tsx @@ -5,7 +5,7 @@ export interface TabPanelsProps { } /** - * Wrapper for the content panels + * @deprecated Please use the same component from `@kaizen/components` */ export const TabPanels = (props: TabPanelsProps): JSX.Element => { const { children } = props diff --git a/packages/tabs/src/Tabs.tsx b/packages/tabs/src/Tabs.tsx index 2f8f98e..abab308 100644 --- a/packages/tabs/src/Tabs.tsx +++ b/packages/tabs/src/Tabs.tsx @@ -26,10 +26,7 @@ export interface TabsProps { } /** - * {@link https://cultureamp.design/components/tabs/ Guidance} | - * {@link https://cultureamp.design/storybook/?path=/docs/components-tabs--controlled Storybook} - * - * Wrapper around the whole thing: holds a tab list and tab panels + * @deprecated Please use the same component from `@kaizen/components` */ export const Tabs = (props: TabsProps): JSX.Element => { const {