react-native-webview-bridge

A messaging bridge for React-App and React-Native-WebView.

📍 Overview

react-native-webview-bridge provides effective communication between React and React Native App using react-native-webview. It acts like a message broker and enables message exchange, making applications more interactive and dynamic.

You don't need to implment yourself such as event listener setup, message handling and posting across different application components, react-native-webview-bridge will do it for you.

🚀 Getting Started

Installation

Add to your react or react-native project by running the following command:

npm i @cheeselemon/react-native-webview-bridge

Or if you're using yarn:

yarn add @cheeselemon/react-native-webview-bridge

Usage

React Application

Basic usage inside your React component:

import { useReactNativeWebViewBridgeForReact } from "@cheeselemon/react-native-webview-bridge";

function MyComponent() {
  const { postMessage } = useReactNativeWebViewBridgeForReact({
    handler: (eventName: string, data: any) => {
      // handle published event from react-native app
    },
  });

  // post message to react-native app
  const handleClick = () => {
    postMessage("eventName", { data: "string or object" });
  };
}

Note that when handler is defined, the hook will automatically listen to messages from react-native app and call the handler function with the event name and data. The underlying hook will also automatically add event listener to the window object.

There may be circumstances where you only want to publish events to react-native app and not listen to events from react-native app. In this case, you can omit the handler function:

const { postMessage } = useReactNativeWebViewBridgeForReact({});

Or if you only want to listen to events from react-native app and not publish events to react-native app, you can omit the postMessage function:

useReactNativeWebViewBridgeForReact({
  handler: (eventName: string, data: any) => {
    // handle published event from react-native app
  },
});

React Native Application

Basic usage inside your React Native component:

import WebView from 'react-native-webview';
import { useReactNativeWebViewBridgeForReactNative } from "@cheeselemon/react-native-webview-bridge";

function MyComponent() {
  const webViewRef = useRef<WebView>(null);
  // needs reference to webview for postMessage
  const { postMessage, handleMessage } = useReactNativeWebViewBridgeForReactNative(webViewRef);

  // post message to react app
  const handleClick = () => {
    postMessage("eventName", { data: "string or object" });
  };

  
  return <WebView
    ref={webViewRef}
    onMessage={(event) => {
      // pass event object directly for processing
      const handled = handleMessage(event, (eventName: string, data: any) => {
        // handle published event from react app here
      });

      // it is possible to handle some other events that are not published by this library.
      if(!handled){
        const { data } = event.nativeEvent; // do whatever you want
      }
    }}
  />
}

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.
• Report Issues: Submit bugs found or log feature requests for CHEESELEMON.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine using a Git client.

   git clone <your-forked-repo-url>

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear and concise message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

📄 License

MIT License

Copyright (c) 2023 cheeselemon

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Return