Giter VIP home page Giter VIP logo

react-native-webview-messaging's Introduction

React Native WebView Messaging

React Native WebView extension with 2-way event-based communication API

Demo

Installation

npm install react-native-webview-messaging

or with yarn

yarn add react-native-webview-messaging

Roadmap

  • channel for redux actions
  • enhanced dev environment

Examples

React Native view

import React, { Component } from 'react';
import { View, TouchableHighlight } from 'react-native';
import { WebView } from 'react-native-webview-messaging/WebView';

export class ExampleView extends Component {
  render() {
    return (
      <View>
        <WebView
          ref={ webview => { this.webview = webview; }}
          source={ require('./some-page.html') }
        />
        <TouchableHighlight onPress={this.sendMessageToWebView} underlayColor='transparent'>
          <Text>Send message to WebView</Text>
        </TouchableHighlight>
      </View>
    )
  }

  componentDidMount() {
    this.webview.messagesChannel.on('text', text => console.log(text));
    this.webview.messagesChannel.on('json', json => console.log(json));
    this.webview.messagesChannel.on('custom-event-from-webview', eventData => console.log(eventData));
  }

  sendMessageToWebView = () => {
    this.webview.sendJSON({
      payload: 'JSON from RN'
    });

    this.webview.send('plain text from RN');

    this.webview.emit('custom-event-from-rn', { payload: 'Custom event from RN' });
  }
}

WebView

import RNMsgChannel from 'react-native-webview-messaging';

RNMsgChannel.on('text', text => console.log(text));
RNMsgChannel.on('json', json => console.log(json));
RNMsgChannel.on('custom-event-from-rn', data => console.log(data));

RNMsgChannel.send('plain text from WebView');
RNMsgChannel.sendJSON({
  payload: 'JSON from WebView'
});

RNMsgChannel.emit('custom-event-from-webview', { payload: 'Custom event from WebView' })

API Docs

WebView

extends WebView from react-native

Import

// es6 modules
import { WebView } from 'react-native-webview-messaging/WebView';
// commonJS
const { WebView } = require('react-native-webview-messaging/WebView');

WebView#send(text: String)

Emits 'text' event on RNMessagesChannel inside WebView

WebView#sendJSON(json: Object)

Emits 'json' event on RNMessagesChannel inside WebView

WebView#emit(eventName: String, [eventData: Object])

Emits custom event on RNMessagesChannel inside WebView

messagesChannel: EventEmitter

Emits events sent from WebView

  • 'text' - emitted when RNMessagesChannel#send(text: String) is called in WebView
  • 'json' - emitted when RNMessagesChannel#sendJSON(json: Object) is called in WebView
  • you can also emit custom events with RNMessagesChannel#emit(eventName: String, [eventData: Object]) method

RNMessagesChannel

extends EventEmitter

Emits events sent from RN app

  • 'text' - emitted when WebView#send(text: String) is called in RN app
  • 'json' - emitted when WebView#sendJSON(json: Object) is called in RN app
  • you can also emit custom events with WebView#emit(eventName: String, [eventData: Object]) method

RNMessagesChannel#send(text: String)

Emits 'text' event to WebView#messagesChannel in RN app

RNMessagesChannel#sendJSON(json: Object)

Emits 'json' event to WebView#messagesChannel in RN app

RNMessagesChannel#emit(eventName: String, [eventData: Object])

Emits custom event to WebView#messagesChannel in RN app

Import

// es6 modules
import RNMessagesChannel from 'react-native-webview-messaging';
// commonJS
const RNMessagesChannel = require('react-native-webview-messaging');

LICENSE

MIT

react-native-webview-messaging's People

Contributors

reggie3 avatar dave-irvine avatar gaboesquivel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.