Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.45 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.45 KB
Raw

logo

webview-bridge

NPM NPM NPM

Fully Type-Safe Integration for React Native WebView and Web

webview-bridge is a powerful interface that acts as a bridge between React Native and web applications using react-native-webview. It providing seamless interaction and ensuring type safety.

Inspired by the functionality of tRPC, webview-bridge simplifies the communication process between react-native-webview and web applications.

Key Features:

  • Built upon react-native-webview.
  • Designed with zero external dependencies (except for react-native-webview).
  • Type-Safety
  • Backward Compatibility
  • No App Review Needed
  • Shared State

webview-bridge

Documentation

visit Docs

Example

visit Example

Exporting Type Declarations

To enhance your experience with webview-bridge, it's recommended to export the type declaration of the native bridge object to the web application. Here are a few ways to achieve this:

  1. Monorepo Setup (Recommended): Use a monorepo setup to export the type of the native bridge.
  2. Custom Declaration File: Build a bridge declaration file using tsc and move the file as needed.
  3. Private npm Registry: Utilize a private npm registry to export the type of the native bridge.

Contributor Guide

If you would like to contribute to webview-bridge by submitting bug fixes or performance improvements, please refer to our CONTRIBUTING.md guide for detailed instructions. We welcome and appreciate your contributions.