mirror of https://github.com/status-im/react-native-webview.git synced 2025-02-23 01:08:36 +00:00

Adithya Reddy 211ae18971 chore(readme): Add getting started doc link (#370 )

The link was missing in the README for the getting started page, the square brackets were there though so looks like whoever wrote it just forgot to put the link there.

2019-03-01 08:53:37 +01:00

9.2 KiB

Raw Blame History

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

Core Maintainers - Sponsoring companies

This project is maintained for free by these people using both their free time and their company work time.

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

Platforms Supported

iOS (both UIWebView and WKWebView)
Android

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

Getting Started

Read our Getting Started Guide. If any step seems unclear, please create a detailed issue.

Versioning

This project follows semantic versioning. We do not hesitate to release breaking changes but they will be in a major version.

Breaking History:

2.0.0 - First release this is a replica of the core webview component
3.0.0 - WKWebview: Add shared process pool so cookies and localStorage are shared across webviews in iOS (enabled by default).
4.0.0 - Added cache (enabled by default).
5.0.1 - Refactored the old postMessage implementation for communication from webview to native.

Upcoming:

UIWebView removal
this.webView.postMessage() removal (never documented and less flexible than injectJavascript)
Typescript rewrite
Kotlin rewrite
Maybe Swift rewrite

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://facebook.github.io/react-native/" }}
      />
    );
  }
}

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

Common issues

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
There's a problem on some Android devices where the webview could overlap previous siblings from same parent. To fix this, wrap the WebView in a View with style overflow: hidden.