Merge pull request #122 from break-stuff/react-1.5-release-prep

react wrappers release prep
break-stuff · May 15, 2024 · 147c56f · 147c56f
2 parents ac7d1ee + 782950d
commit 147c56f
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/packages/react-wrappers/CHANGELOG.md b/packages/react-wrappers/CHANGELOG.md
@@ -5,6 +5,7 @@
 - Added ability to extend react types
 - Added attribute mapping
 - Added component tag name scoping 
+- Added SSR Safe rendering to wrappers
 
 ## 1.4.2
 

diff --git a/packages/react-wrappers/README.md b/packages/react-wrappers/README.md
@@ -457,4 +457,10 @@ The custom elements will now be rendered with the new tag names.
 </test_radio-group_test2>
 ```
 
-> ***IMPORTANT:*** It is important to note that this will not define your elements with scopes. It will also not scope any components used within your components. It only renders the specified tag name.
+> ***IMPORTANT:*** It is important to note that this will not define your elements with scopes. It will also not scope any components used within your components. It only renders the specified tag name.
+
+## SSR Safety
+
+If you or anyone are planning on using your components in an environment where they are being server-side rendered like in [Next.js](https://nextjs.org/) or [Remix](https://remix.run/), be sure to set the config `ssrSafe` to `true`. This will allow your components to run in those environments without throwing any errors.
+
+> ***IMPORTANT:*** This feature does not make your components render on the server (although the tag will be), but instead waits for the client before attempting to register and execute your components.
diff --git a/packages/react-wrappers/package.json b/packages/react-wrappers/package.json
@@ -1,6 +1,6 @@
 {
   "name": "custom-element-react-wrappers",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "A tool for generating react-compatible wrappers for custom elements",
   "main": "index.js",
   "module": "index.js",