add React v19 TypeScript error suppression guidance for global compon…

…ents (#277)
reown-com · Feb 5, 2025 · 3bc0d7c · 3bc0d7c
1 parent a4c941d
commit 3bc0d7c
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 0 deletions.
diff --git a/docs/appkit/next/core/components.mdx b/docs/appkit/next/core/components.mdx
@@ -6,7 +6,16 @@ import Components from '../../shared/components.mdx'
 import Table from '../../../components/Table'
 
 # Web Components
+:::warning
+If you are using React v19 and global components. Please add, before the component, the following directive to temporarily suppress TypeScript errors until the upgrade is fully supported:  
 
+```tsx
+{/* @ts-expect-error msg */}
+<appkit-button />
+```
+
+This will prevent TypeScript from reporting errors related to global component types.  
+:::
 <Components />
 
 ### `<appkit-wallet-button  />`

diff --git a/docs/appkit/next/core/installation.mdx b/docs/appkit/next/core/installation.mdx
@@ -140,6 +140,16 @@ Create a new project on Reown Cloud at https://cloud.reown.com and obtain a new
 
 ## Trigger the modal
 
+:::warning
+If you are using React v19 and global components. Please add, before the component, the following directive to temporarily suppress TypeScript errors until the upgrade is fully supported:  
+
+```tsx
+{/* @ts-expect-error msg */}
+<appkit-button />
+```
+
+This will prevent TypeScript from reporting errors related to global component types.  
+:::
 <PlatformTabs groupId="eth-lib" activeOptions={["wagmi", "ethers5","ethers","solana","bitcoin"]}>
 <PlatformTabItem value="wagmi">
 

diff --git a/docs/appkit/react/core/components.mdx b/docs/appkit/react/core/components.mdx
@@ -6,7 +6,18 @@ import Table from '../../../components/Table'
 import Components from '../../shared/components.mdx'
 
 # Web Components
+## Trigger the modal
 
+:::warning
+If you are using React v19 and global components. Please add, before the component, the following directive to temporarily suppress TypeScript errors until the upgrade is fully supported:  
+
+```tsx
+{/* @ts-expect-error msg */}
+<appkit-button />
+```
+
+This will prevent TypeScript from reporting errors related to global component types.  
+:::
 <Components />
 
 ### `<appkit-wallet-button  />` 

diff --git a/docs/appkit/react/core/installation.mdx b/docs/appkit/react/core/installation.mdx
@@ -144,6 +144,17 @@ Create a new project on reown Cloud at https://cloud.reown.com and obtain a new
 
 ## Trigger the modal
 
+:::warning
+If you are using React v19 and global components. Please add, before the component, the following directive to temporarily suppress TypeScript errors until the upgrade is fully supported:  
+
+```tsx
+{/* @ts-expect-error msg */}
+<appkit-button />
+```
+
+This will prevent TypeScript from reporting errors related to global component types.  
+:::
+
 <PlatformTabs groupId="eth-lib" activeOptions={["wagmi", "ethers5","ethers","solana","bitcoin"]}>
 <PlatformTabItem value="wagmi">