More clearly mark EuiPageSideBarProps as deprecated

- it's causing confusion in Kibana
elastic · Dec 7, 2022 · c48afd7 · c48afd7
1 parent 701f244
commit c48afd7
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/src/components/page/index.ts b/src/components/page/index.ts
@@ -39,7 +39,7 @@ export {
 export type { EuiPageSectionProps } from './page_section';
 export { EuiPageSection } from './page_section';
 
-export type { EuiPageSideBarProps } from './page_side_bar';
+export type { EuiPageSideBarProps_Deprecated } from './page_side_bar';
 export { EuiPageSideBar_Deprecated } from './page_side_bar';
 
 export type { EuiPageSidebarProps } from './page_sidebar';

diff --git a/src/components/page/page_side_bar/index.ts b/src/components/page/page_side_bar/index.ts
@@ -6,5 +6,5 @@
  * Side Public License, v 1.
  */
 
-export type { EuiPageSideBarProps } from './page_side_bar';
+export type { EuiPageSideBarProps_Deprecated } from './page_side_bar';
 export { EuiPageSideBar_Deprecated } from './page_side_bar';
diff --git a/src/components/page/page_side_bar/page_side_bar.tsx b/src/components/page/page_side_bar/page_side_bar.tsx
@@ -19,7 +19,10 @@ const paddingSizeToClassNameMap = {
 
 export const PADDING_SIZES = keysOf(paddingSizeToClassNameMap);
 
-export interface EuiPageSideBarProps
+/**
+ * @deprecated Use the new EuiPageSidebarProps in page/page_sidebar instead
+ */
+export interface EuiPageSideBarProps_Deprecated
   extends CommonProps,
     HTMLAttributes<HTMLDivElement> {
   /**
@@ -35,7 +38,7 @@ export interface EuiPageSideBarProps
 /**
  * @deprecated Use the new EuiPageSidebar in page/page_sidebar instead
  */
-export const EuiPageSideBar_Deprecated: FunctionComponent<EuiPageSideBarProps> = ({
+export const EuiPageSideBar_Deprecated: FunctionComponent<EuiPageSideBarProps_Deprecated> = ({
   children,
   className,
   sticky,

diff --git a/src/components/page/page_template.tsx b/src/components/page/page_template.tsx
@@ -12,7 +12,7 @@ import { css } from '@emotion/react';
 import { EuiPage, EuiPageProps } from './page';
 import {
   EuiPageSideBar_Deprecated as EuiPageSideBar,
-  EuiPageSideBarProps,
+  EuiPageSideBarProps_Deprecated as EuiPageSideBarProps,
 } from './page_side_bar';
 import { EuiPageBody, EuiPageBodyProps } from './page_body';
 import { EuiPageHeader, EuiPageHeaderProps } from './page_header';