fix: adds deprecation message on createShadowDomElements

okta · Oct 23, 2024 · dc18d41 · dc18d41
1 parent 8bd12c7
commit dc18d41
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/odyssey-react-mui/src/web-component/shadow-dom.ts b/packages/odyssey-react-mui/src/web-component/shadow-dom.ts
@@ -28,6 +28,9 @@ export type ShadowDomElements = ReturnType<
   typeof createUnattachedShadowDomElements
 >;
 
+/**
+ * @deprecated Use `renderReactInWebComponent` instead. This function was necessary when using bare Shadow DOM, but with UI Shell rendering in a Web Component, you won't be able to render your Shadow DOM in its Shadow DOM without using a Web Component.
+ */
 export const createShadowDomElements = (containerElement: HTMLElement) => {
   const shadowRoot = containerElement.attachShadow({ mode: "open" });