From 381d71b4623357992f8299523f5252c05258c634 Mon Sep 17 00:00:00 2001 From: Constance Chen Date: Tue, 30 Aug 2022 15:24:14 -0700 Subject: [PATCH 1/2] Use @deprecated tag to mark components as deprecated in supporting IDEs --- src/components/page/page_content/page_content.tsx | 3 +-- src/components/page/page_content/page_content_body.tsx | 3 +-- src/components/page/page_content/page_content_header.tsx | 3 +-- .../page/page_content/page_content_header_section.tsx | 3 +-- src/components/page/page_side_bar/page_side_bar.tsx | 3 +-- src/components/page/page_template.tsx | 4 +++- 6 files changed, 8 insertions(+), 11 deletions(-) diff --git a/src/components/page/page_content/page_content.tsx b/src/components/page/page_content/page_content.tsx index 73258838c6a..51e666f4e67 100644 --- a/src/components/page/page_content/page_content.tsx +++ b/src/components/page/page_content/page_content.tsx @@ -42,8 +42,7 @@ export type EuiPageContentProps = CommonProps & }; /** - * **DEPRECATED** - * Use EuiPageSection instead + * @deprecated Use EuiPageSection instead */ export const EuiPageContent_Deprecated: FunctionComponent = ({ verticalPosition, diff --git a/src/components/page/page_content/page_content_body.tsx b/src/components/page/page_content/page_content_body.tsx index 0f088801672..5eb3234cf03 100644 --- a/src/components/page/page_content/page_content_body.tsx +++ b/src/components/page/page_content/page_content_body.tsx @@ -35,8 +35,7 @@ export interface EuiPageContentBodyProps } /** - * **DEPRECATED** - * Use EuiPageSection instead + * @deprecated Use EuiPageSection instead */ export const EuiPageContentBody_Deprecated: FunctionComponent = ({ children, diff --git a/src/components/page/page_content/page_content_header.tsx b/src/components/page/page_content/page_content_header.tsx index aab8ceb3440..65c5637557f 100644 --- a/src/components/page/page_content/page_content_header.tsx +++ b/src/components/page/page_content/page_content_header.tsx @@ -21,8 +21,7 @@ export interface EuiPageContentHeaderProps } /** - * **DEPRECATED** - * Use EuiPageHeader instead + * @deprecated Use EuiPageHeader instead */ export const EuiPageContentHeader_Deprecated: FunctionComponent = ({ children, diff --git a/src/components/page/page_content/page_content_header_section.tsx b/src/components/page/page_content/page_content_header_section.tsx index 985f8f980e7..7da907356b3 100644 --- a/src/components/page/page_content/page_content_header_section.tsx +++ b/src/components/page/page_content/page_content_header_section.tsx @@ -15,8 +15,7 @@ export interface EuiPageContentHeaderSectionProps HTMLAttributes {} /** - * **DEPRECATED** - * Use EuiPageHeader instead + * @deprecated Use EuiPageHeader instead */ export const EuiPageContentHeaderSection_Deprecated: FunctionComponent = ({ children, diff --git a/src/components/page/page_side_bar/page_side_bar.tsx b/src/components/page/page_side_bar/page_side_bar.tsx index dbdc397271e..41463ad3016 100644 --- a/src/components/page/page_side_bar/page_side_bar.tsx +++ b/src/components/page/page_side_bar/page_side_bar.tsx @@ -33,8 +33,7 @@ export interface EuiPageSideBarProps } /** - * **DEPRECATED** - * Use the new EuiPageSidebar instead + * @deprecated Use the new EuiPageSidebar in page/page_sidebar instead */ export const EuiPageSideBar_Deprecated: FunctionComponent = ({ children, diff --git a/src/components/page/page_template.tsx b/src/components/page/page_template.tsx index 7a4147a8a24..957a2a829e0 100644 --- a/src/components/page/page_template.tsx +++ b/src/components/page/page_template.tsx @@ -101,7 +101,9 @@ export type EuiPageTemplateProps_Deprecated = Omit< /** * This component has been deprecated in favor of the new * namespaced version. You can still import this component - * for a period of time by importing `as EuiPageTemplate`. + * until August 2023 by importing `as EuiPageTemplate`. + * + * @deprecated use EuiPageTemplate from page_template/page_template instead */ export const EuiPageTemplate_Deprecated: FunctionComponent = ({ template = 'default', From b82d03ca013ef3a4b77060a527e894188b7809bf Mon Sep 17 00:00:00 2001 From: Constance Chen Date: Tue, 30 Aug 2022 15:34:26 -0700 Subject: [PATCH 2/2] changelog --- upcoming_changelogs/6194.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 upcoming_changelogs/6194.md diff --git a/upcoming_changelogs/6194.md b/upcoming_changelogs/6194.md new file mode 100644 index 00000000000..7e20f68b26b --- /dev/null +++ b/upcoming_changelogs/6194.md @@ -0,0 +1,3 @@ +**Deprecations** + +- Added `@deprecated` flags to `EuiPageContent_Deprecated`, `EuiPageContentBody_Deprecated`, `EuiPageContentHeader_Deprecated`, `EuiPageContentHeaderSection_Deprecated`, `EuiPageSideBar_Deprecated` and `EuiPageTemplate_Deprecated`, which will provide helpful hints to IDEs that support jsdoc flags. Consumers will have until August 2023 to migrate from these deprecated components.