@webview-bridge/react-native 1.6.1 → 1.6.2

package/dist/packages/react-native/src/createWebView.d.ts

@@ -2,16 +2,91 @@ import type { Bridge, BridgeStore, KeyOfOrString, Parser, ParserSchema } from ".
 import React from "react";
 import type { BridgeWebView } from "./types/webview";
 export type CreateWebViewArgs<BridgeObject extends Bridge, PostMessageSchema extends ParserSchema<any>> = {
+    /**
+     * The bridge object to be used in the WebView.
+    * @example
+      import { createWebView, bridge } from "@webview-bridge/react-native";
+      import InAppBrowser from "react-native-inappbrowser-reborn";
+  
+      // Register functions in the bridge object in your React Native code
+      export const appBridge = bridge({
+        async getMessage() {
+          return "Hello, I'm native";
+        },
+        async sum(a: number, b: number) {
+          return a + b;
+        },
+        async openInAppBrowser(url: string) {
+          if (await InAppBrowser.isAvailable()) {
+            await InAppBrowser.open(url);
+          }
+        },
+        // ... Add more functions as needed
+      });
+  
+      export const { WebView } = createWebView({
+        bridge: appBridge,
+        debug: true, // Enable console.log visibility in the native WebView
+      });
+      */
     bridge: BridgeStore<BridgeObject>;
+    /**
+     * If `true`, the console.log visibility in the WebView is enabled.
+     * @default false
+     */
     debug?: boolean;
+    /**
+     * Set the timeout in milliseconds for the response from the web method.
+     * @default 2000
+     */
     responseTimeout?: number;
+    /**
+     * The schema for the postMessage method.
+     * @link https://gronxb.github.io/webview-bridge/using-a-post-message.html
+     */
     postMessageSchema?: PostMessageSchema;
+    /**
+     * Callback function when a method that is not defined in the bridge is called.
+     * @link https://gronxb.github.io/webview-bridge/backward-compatibility/new-method.html#react-native-part
+     */
     fallback?: (method: keyof BridgeObject) => void;
 };
 export type WebMethod<T> = T & {
     isReady: boolean;
 };
+/**
+ * Create a WebView component that can communicate with the bridge.
+ * @link https://gronxb.github.io/webview-bridge/getting-started.html
+ * @example
+    import { createWebView, bridge } from "@webview-bridge/react-native";
+    import InAppBrowser from "react-native-inappbrowser-reborn";
+
+    // Register functions in the bridge object in your React Native code
+    export const appBridge = bridge({
+      async getMessage() {
+        return "Hello, I'm native";
+      },
+      async sum(a: number, b: number) {
+        return a + b;
+      },
+      async openInAppBrowser(url: string) {
+        if (await InAppBrowser.isAvailable()) {
+          await InAppBrowser.open(url);
+        }
+      },
+      // ... Add more functions as needed
+    });
+
+    export const { WebView } = createWebView({
+      bridge: appBridge,
+      debug: true, // Enable console.log visibility in the native WebView
+    });
+ */
 export declare const createWebView: <BridgeObject extends Bridge, PostMessageSchema extends ParserSchema<any>>({ bridge, debug, responseTimeout, postMessageSchema, fallback, }: CreateWebViewArgs<BridgeObject, PostMessageSchema>) => {
+    /**
+     * Sends an event from React Native to the Web.
+     * @link https://gronxb.github.io/webview-bridge/using-a-post-message.html
+     */
     postMessage: <EventName extends KeyOfOrString<PostMessageSchema>, Args extends Parser<PostMessageSchema, EventName>>(eventName: EventName, args: Args) => void;
     WebView: React.ForwardRefExoticComponent<import("react-native-webview/lib/WebViewTypes").IOSWebViewProps & import("react-native-webview/lib/WebViewTypes").AndroidWebViewProps & import("react-native-webview/lib/WebViewTypes").WindowsWebViewProps & React.RefAttributes<BridgeWebView>>;
     /**

package/dist/packages/react-native/src/createWebView.js

@@ -33,6 +33,34 @@ const react_native_webview_1 = __importDefault(require("react-native-webview"));
 const bridge_1 = require("./integrations/bridge");
 const console_1 = require("./integrations/console");
 const handleRegisterWebMethod_1 = require("./integrations/handleRegisterWebMethod");
+/**
+ * Create a WebView component that can communicate with the bridge.
+ * @link https://gronxb.github.io/webview-bridge/getting-started.html
+ * @example
+    import { createWebView, bridge } from "@webview-bridge/react-native";
+    import InAppBrowser from "react-native-inappbrowser-reborn";
+
+    // Register functions in the bridge object in your React Native code
+    export const appBridge = bridge({
+      async getMessage() {
+        return "Hello, I'm native";
+      },
+      async sum(a: number, b: number) {
+        return a + b;
+      },
+      async openInAppBrowser(url: string) {
+        if (await InAppBrowser.isAvailable()) {
+          await InAppBrowser.open(url);
+        }
+      },
+      // ... Add more functions as needed
+    });
+
+    export const { WebView } = createWebView({
+      bridge: appBridge,
+      debug: true, // Enable console.log visibility in the native WebView
+    });
+ */
 const createWebView = ({ bridge, debug, responseTimeout = 2000, postMessageSchema, fallback, }) => {
     const WebMethod = {
         current: {
@@ -47,6 +75,10 @@ const createWebView = ({ bridge, debug, responseTimeout = 2000, postMessageSchem
         }
     });
     return {
+        /**
+         * Sends an event from React Native to the Web.
+         * @link https://gronxb.github.io/webview-bridge/using-a-post-message.html
+         */
         postMessage: (eventName, args) => {
             let _args = args;
             if (postMessageSchema) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webview-bridge/react-native",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "type": "module",
   "description": "Fully Type-Safe Integration for React Native WebView and Web",
   "main": "dist/packages/react-native/src/index.js",