Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[EuiPage*_Deprecated] Use @deprecated flag #6194

Merged
merged 2 commits into from
Aug 30, 2022
Merged

[EuiPage*_Deprecated] Use @deprecated flag #6194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
381d71b
Use @deprecated tag to mark components as deprecated in supporting IDEs
cee-chen Aug 30, 2022
b82d03c
changelog
cee-chen Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/components/page/page_content/page_content.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ export type EuiPageContentProps = CommonProps &
};

/**
* **DEPRECATED**
* Use EuiPageSection instead
* @deprecated Use EuiPageSection instead
*/
export const EuiPageContent_Deprecated: FunctionComponent<EuiPageContentProps> = ({
verticalPosition,
Expand Down
3 changes: 1 addition & 2 deletions src/components/page/page_content/page_content_body.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ export interface EuiPageContentBodyProps
}

/**
* **DEPRECATED**
* Use EuiPageSection instead
* @deprecated Use EuiPageSection instead
*/
export const EuiPageContentBody_Deprecated: FunctionComponent<EuiPageContentBodyProps> = ({
children,
Expand Down
3 changes: 1 addition & 2 deletions src/components/page/page_content/page_content_header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ export interface EuiPageContentHeaderProps
}

/**
* **DEPRECATED**
* Use EuiPageHeader instead
* @deprecated Use EuiPageHeader instead
*/
export const EuiPageContentHeader_Deprecated: FunctionComponent<EuiPageContentHeaderProps> = ({
children,
Expand Down
3 changes: 1 addition & 2 deletions src/components/page/page_content/page_content_header_section.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ export interface EuiPageContentHeaderSectionProps
HTMLAttributes<HTMLDivElement> {}

/**
* **DEPRECATED**
* Use EuiPageHeader instead
* @deprecated Use EuiPageHeader instead
*/
export const EuiPageContentHeaderSection_Deprecated: FunctionComponent<EuiPageContentHeaderSectionProps> = ({
children,
Expand Down
3 changes: 1 addition & 2 deletions src/components/page/page_side_bar/page_side_bar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<EuiPageSideBarProps> = ({
children,
Expand Down
4 changes: 3 additions & 1 deletion src/components/page/page_template.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<EuiPageTemplateProps_Deprecated> = ({
template = 'default',
Expand Down
3 changes: 3 additions & 0 deletions upcoming_changelogs/6194.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.