react-native-webview.git
Thibault Malbranche b1b662628e feat(Android Webview): Support onShouldStartLoadWithRequest on Android (#107) 6 年之前
.circleci chore(ci and npm): Setup CircleCI and semantic-release 6 年之前
android feat(Android Webview): Support onShouldStartLoadWithRequest on Android (#107) 6 年之前
bin Added starter setup script 6 年之前
docs feat(WKWebView): [ios] Add allowsLinkPreview property to WKWebView (#170) 6 年之前
ios feat(WKWebView): [ios] Add allowsLinkPreview property to WKWebView (#170) 6 年之前
js feat(Android Webview): Support onShouldStartLoadWithRequest on Android (#107) 6 年之前
typings feat(WKWebView): [ios] Add allowsLinkPreview property to WKWebView (#170) 6 年之前
.flowconfig Add WebView Flow types 6 年之前
.flowconfig.android Add WebView Flow types 6 年之前
.gitignore refactor(Android): New project setup + kotlin events (#121) 6 年之前
.releaserc fix(semantic-release): Use git plugin to auto commit 6 年之前
LICENSE WIP: iOS WKWebView 6 年之前
README.md chore(readme): Added contributing guide and empyrical link (#146) 6 年之前
index.js Added RNCWebViewManager to xcode proj 6 年之前
package.json chore(release): 2.13.0 [skip ci] 6 年之前
react-native-webview.podspec fix(package.json): Add license to podspec and update package.json version dynamically. (#98) 6 年之前
yarn.lock feat(typings): Add typescript definitions (#95) 6 年之前

README.md

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).

Platforms Supported

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

Note: React Native WebView is not currently supported by Expo unless you “eject”.

Versioning

If you need the exact same WebView as the one from react-native, please use version 2.0.0. Future versions will follow semantic versioning.

Getting Started

$ yarn add react-native-webview
$ react-native link react-native-webview

Read our Getting Started Guide for more.

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
        source={{ uri: "https://infinite.red/react-native" }}
        style={{ marginTop: 20 }}
        onLoadProgress={e => console.log(e.nativeEvent.progress)}
      />
    );
  }
}

For more, read the API Reference and Guide. If you’re interested in contributing, check out the Contributing Guide.

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.

Troubleshooting

  • If you’re getting Invariant Violation: Native component for "RNCWKWebView does not exist" it likely means you forgot to run react-native link or there was some error with the linking process

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 test:ios:flow for iOS
    • yarn test:android:flow 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:
    • "test:example:flow": "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

License

MIT