Combine with kibana#163137 (#24)

cee-chen · Aug 4, 2023 · b8a710f · b8a710f
1 parent 11c370c
commit b8a710f
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 25 deletions.
diff --git a/packages/react/kibana_context/render/render_provider.tsx b/packages/react/kibana_context/render/render_provider.tsx
@@ -8,33 +8,25 @@
 
 import React, { FC } from 'react';
 
-import { EuiErrorBoundary } from '@elastic/eui';
-import type { I18nStart } from '@kbn/core-i18n-browser';
 import {
-  KibanaThemeProvider,
-  type KibanaThemeProviderProps,
-} from '@kbn/react-kibana-context-theme';
+  KibanaRootContextProvider,
+  type KibanaRootContextProviderProps,
+} from '@kbn/react-kibana-context-root';
 
 /** Props for the KibanaContextProvider */
-export interface KibanaRenderContextProviderProps extends KibanaThemeProviderProps {
-  /** The `I18nStart` API from `CoreStart`. */
-  i18n: I18nStart;
-}
+export type KibanaRenderContextProviderProps = Omit<KibanaRootContextProviderProps, 'globalStyles'>;
 
 /**
  * The `KibanaRenderContextProvider` provides the necessary context for an out-of-current
  * React render, such as using `ReactDOM.render()`.
  */
 export const KibanaRenderContextProvider: FC<KibanaRenderContextProviderProps> = ({
   children,
-  i18n,
   ...props
 }) => {
   return (
-    <i18n.Context>
-      <KibanaThemeProvider {...props}>
-        <EuiErrorBoundary>{children}</EuiErrorBoundary>
-      </KibanaThemeProvider>
-    </i18n.Context>
+    <KibanaRootContextProvider globalStyles={false} {...props}>
+      {children}
+    </KibanaRootContextProvider>
   );
 };
diff --git a/packages/react/kibana_context/render/tsconfig.json b/packages/react/kibana_context/render/tsconfig.json
@@ -16,7 +16,6 @@
     "target/**/*"
   ],
   "kbn_references": [
-    "@kbn/core-i18n-browser",
-    "@kbn/react-kibana-context-theme",
+    "@kbn/react-kibana-context-root",
   ]
 }
diff --git a/packages/react/kibana_context/root/eui_provider.tsx b/packages/react/kibana_context/root/eui_provider.tsx
@@ -48,7 +48,8 @@ utilitiesCache.compat = true;
 const cache = { default: emotionCache, global: globalCache, utility: utilitiesCache };
 
 /**
- * Prepares and returns a configured `EuiProvider` for use in Kibana roots.
+ * Prepares and returns a configured `EuiProvider` for use in Kibana roots.  In most cases, this utility context
+ * should not be used.  Instead, refer to `KibanaRootContextProvider` to set up the root of Kibana.
  */
 export const KibanaEuiProvider: FC<KibanaEuiProviderProps> = ({
   theme: { theme$ },

diff --git a/packages/react/kibana_context/root/index.ts b/packages/react/kibana_context/root/index.ts
@@ -7,3 +7,4 @@
  */
 
 export { KibanaRootContextProvider, type KibanaRootContextProviderProps } from './root_provider';
+export { KibanaEuiProvider, type KibanaEuiProviderProps } from './eui_provider';
diff --git a/packages/react/kibana_context/theme/theme_provider.tsx b/packages/react/kibana_context/theme/theme_provider.tsx
@@ -10,12 +10,13 @@ import React, { useMemo } from 'react';
 import useObservable from 'react-use/lib/useObservable';
 
 import { EuiThemeProvider, EuiThemeProviderProps } from '@elastic/eui';
+
 // @ts-ignore EUI exports this component internally, but Kibana isn't picking it up its types
 import { useIsNestedEuiProvider } from '@elastic/eui/lib/components/provider/nested';
 // @ts-ignore EUI exports this component internally, but Kibana isn't picking it up its types
 import { emitEuiProviderWarning } from '@elastic/eui/lib/services/theme/warning';
 
-import { KibanaEuiProvider } from '@kbn/react-kibana-context-root/eui_provider';
+import { KibanaEuiProvider } from '@kbn/react-kibana-context-root';
 
 import {
   getColorMode,
@@ -46,7 +47,7 @@ export interface KibanaThemeProviderProps extends EuiProps {
  * TODO: Restore this to the main `KibanaThemeProvider` once all theme providers can be guaranteed
  * to have a parent `EuiProvider`
  */
-export const KibanaThemeProviderOnly = ({
+const KibanaThemeProviderOnly = ({
   theme: { theme$ },
   euiTheme: theme,
   children,
@@ -62,11 +63,11 @@ export const KibanaThemeProviderOnly = ({
  * Unfortunately, a lot of plugins are using `KibanaThemeProvider` without a parent
  * `EuiProvider` which provides very necessary setup (e.g. Emotion cache, breakpoints).
  *
- * If so, we need to render an EuiProvider first (but without global styles, since those
- * are already handled by `KibanaRootContextProvider`)
+ * If a render call is using the deprecated context, we need to render an EuiProvider first
+ * (but without global styles, since those are already handled by `KibanaRootContextProvider`)
  *
- * TODO: We can hopefully remove this and revert to only exporting the above component once
- * all plugins are on `KibanaRootContextProvider`?
+ * TODO: clintandrewhall - We can remove this and revert to only exporting the above component
+ * once all out-of-band renders are using `KibanaRenderContextProvider`.
  */
 const KibanaThemeProviderCheck = ({ theme, children, ...props }: KibanaThemeProviderProps) => {
   const hasEuiProvider = useIsNestedEuiProvider();
@@ -79,7 +80,7 @@ const KibanaThemeProviderCheck = ({ theme, children, ...props }: KibanaThemeProv
     );
   } else {
     emitEuiProviderWarning(
-      'Your plugin used an KibanaThemeProvider without a required parent KibanaRootContextProvider.'
+      'KibanaThemeProvider requires a parent KibanaRenderContextProvider.  Check your React tree and ensure that they are wrapped in a KibanaRenderContextProvider.'
     );
     return (
       <KibanaEuiProvider theme={theme} globalStyles={false}>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,4 @@
		*/

		export { KibanaRootContextProvider, type KibanaRootContextProviderProps } from './root_provider';
		export { KibanaEuiProvider, type KibanaEuiProviderProps } from './eui_provider';