No Description

React Native WebView - a Modern, Cross-Platform WebView for React Native

React Native WebView is a modern, well-supported, and cross-platform WebView for React Native. It is intended to be a replacement for the built-in WebView (which will be removed from core).

Please note that this package is pre-release and not yet ready for production use.

Platforms Supported

iOS (both UIWebView and WKWebView)
Android
Windows 10 (coming soon)

Installation

Note: this is currently a work-in-progress and not yet published to NPM.

$ npm install --save https://github.com/react-native-community/react-native-webview
$ react-native link react-native-webview

Usage

Import the WebView component from react-native-webview and use it like so:

import React, { Component } from 'react'
import { StyleSheet, Text, View } from 'react-native'
import { WebView } from 'react-native-webview'

// ...
class MyWebComponent extends Component {
  render () {
    return (
      <WebView
        src={{uri: "https://infinite.red/react-native"}}
        style={{marginTop: 20}}
      />
    )
  }
}

Additional properties are supported and will be added here; for now, refer to the previous React Native WebView documentation for more.

https://facebook.github.io/react-native/docs/webview

Migrate from React Native core WebView to React Native WebView

Simply install React Native WebView and then use it in place of the core WebView. Their APIs are currently identical, except that this package defaults useWebKit={true} unlike the built-in WebView.

Contributor Notes

I’ve removed all PropTypes for now. Instead, we’ll be using Flow types. TypeScript types will be added at a later date.
UIWebView is not tested fully and you will encounter some yellow warning boxes. Since it is deprecated, we don’t intend to put a lot of time into supporting it, but feel free to submit PRs if you have a special use case. Note that you will need to specify useWebKit={false} to use UIWebView
After pulling this repo and installing all dependencies, you can run flow on iOS and Android-specific files using the commands:
- yarn flow or npm run flow for iOS
- yarn flow-android or npm run flow-android for Android
If you want to add another React Native platform to this repository, you will need to create another .flowconfig for it. If your platform is example, copy the main flowconfig and rename it to .flowconfig.example. Then edit the config to ignore other platforms, and add .*/*[.]example.js to the ignore lists of the other platforms. Then add an entry to package.json like this:
- "flow-example": "flow check --flowconfig-name .flowconfig.example"
Currently you need to install React Native 0.57 to be able to test these types - flow check will not pass against 0.56.

Maintainers

Jamon Holmgren (Twitter @jamonholmgren) from Infinite Red
Thibault Malbranche (Twitter @titozzz) from Brigad

License

MIT

README.md 3.3KB History Raw