@wrdagency/react-islands 0.1.1 → 0.2.0

package/README.md

@@ -28,12 +28,10 @@ On the client you can then render each of those islands. They'll automatically h
 ```
 // index.ts
 import * as islands from "./islands";
+import { hydrateIslands } from "@wrdagency/react-islands";
 
-const isDev = (process.env.NODE_ENV || "development").trim() === "development";
+hydrateIslands( islands );
 
-for (const island of Object.values(islands)) {
-	island.render({ hydrate: !isDev });
-}
 ```
 
 Create a pre-render script. You can configure your build tool to use this as a seperate entrypoint.

package/dist/index.d.mts

@@ -1,12 +1,40 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
 import { FC } from 'react';
-import { I as IslandOpts, a as Island } from './types-Dn7YlQVB.mjs';
+import { I as Island, a as IslandOpts } from './types-BWtowKeL.mjs';
 
-declare function createIsland(component: FC, opts: IslandOpts): Island;
+/**
+ * Create a higher-order component with certain fixed.
+ *
+ * Useful for quickly creating multiple variants of the same component to use as islands.
+ *
+ * @param component FC<T>
+ * @param setProps Partial<T>
+ * @returns FC<T>
+ */
 declare function withProps<T>(component: FC<T>, setProps: Partial<T>): FC<T>;
+/**
+ * Render all Islands in a record.
+ *
+ * Useful if you are importing * from an islands directory.
+ *
+ * @param islands Record<string, Island>
+ */
+declare function hydrateIslands(islands: Record<string, Island>): void;
+
+/**
+ * Create a React Island.
+ *
+ * You can render the island using the Island.render function.
+ *
+ * @param component React.FC
+ * @param opts IslandOpts
+ * @returns Island
+ */
+declare function createIsland(component: FC, opts: IslandOpts): Island;
+/**
+ * Checks if the current script is running in a pre-render.
+ *
+ * @returns boolean
+ */
 declare function isServer(): boolean;
-declare function RawHTML({ html }: {
-    html: string;
-}): react_jsx_runtime.JSX.Element;
 
-export { RawHTML, createIsland, isServer, withProps };
+export { Island, createIsland, hydrateIslands, isServer, withProps };

package/dist/index.d.ts

@@ -1,12 +1,40 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
 import { FC } from 'react';
-import { I as IslandOpts, a as Island } from './types-Dn7YlQVB.js';
+import { I as Island, a as IslandOpts } from './types-BWtowKeL.js';
 
-declare function createIsland(component: FC, opts: IslandOpts): Island;
+/**
+ * Create a higher-order component with certain fixed.
+ *
+ * Useful for quickly creating multiple variants of the same component to use as islands.
+ *
+ * @param component FC<T>
+ * @param setProps Partial<T>
+ * @returns FC<T>
+ */
 declare function withProps<T>(component: FC<T>, setProps: Partial<T>): FC<T>;
+/**
+ * Render all Islands in a record.
+ *
+ * Useful if you are importing * from an islands directory.
+ *
+ * @param islands Record<string, Island>
+ */
+declare function hydrateIslands(islands: Record<string, Island>): void;
+
+/**
+ * Create a React Island.
+ *
+ * You can render the island using the Island.render function.
+ *
+ * @param component React.FC
+ * @param opts IslandOpts
+ * @returns Island
+ */
+declare function createIsland(component: FC, opts: IslandOpts): Island;
+/**
+ * Checks if the current script is running in a pre-render.
+ *
+ * @returns boolean
+ */
 declare function isServer(): boolean;
-declare function RawHTML({ html }: {
-    html: string;
-}): react_jsx_runtime.JSX.Element;
 
-export { RawHTML, createIsland, isServer, withProps };
+export { Island, createIsland, hydrateIslands, isServer, withProps };