Go to file
Caleb Clarke 6a9116f2d1
feat(events): Add isTopFrame to shouldStartLoadForRequest (#1537)
* Add isTopFrame to shouldStartLoadForRequest on iOS

onLoadingStart is not raised for inner frames, but onShouldStartLoadWithRequest still is. This keeps that behavior but adds isTopFrame to onShouldStartLoadWithRequest so that apps can perform their own filtering if desired.

* Update docs

Co-authored-by: Jamon Holmgren <jamonholmgren@gmail.com>
2020-08-15 11:21:38 +02:00
.circleci chore(windows): Set up Windows CI (#1358 by @kaiguo) 2020-05-08 13:24:37 -07:00
.github chore(ci): Cleanup windows ci (#1558) 2020-08-13 23:43:23 -07:00
.vscode feat(typescript): Source code rewrite using typescript (#425) 2019-03-20 12:35:13 +00:00
__tests__ chore(windows): Set up Windows CI (#1358 by @kaiguo) 2020-05-08 13:24:37 -07:00
android feat(events): Add isTopFrame to shouldStartLoadForRequest (#1537) 2020-08-15 11:21:38 +02:00
apple feat(events): Add isTopFrame to shouldStartLoadForRequest (#1537) 2020-08-15 11:21:38 +02:00
bin chore(docs): Update React Native links to reactnative.dev (#1233) 2020-02-25 22:54:06 -08:00
docs feat(events): Add isTopFrame to shouldStartLoadForRequest (#1537) 2020-08-15 11:21:38 +02:00
example chore(windows): Add a .gitattributes to fix line endings across myriad files. (#1431 by @trcoffman) 2020-06-16 11:53:22 -07:00
ios/RNCWebView.xcodeproj feat(macOS): Make podspec compatible with macOS (#1328) 2020-04-24 19:54:17 +02:00
jest-setups chore(windows): Set up Windows CI (#1358 by @kaiguo) 2020-05-08 13:24:37 -07:00
macos/RNCWebView.xcodeproj feat(macOS): Make podspec compatible with macOS (#1328) 2020-04-24 19:54:17 +02:00
src feat(events): Add isTopFrame to shouldStartLoadForRequest (#1537) 2020-08-15 11:21:38 +02:00
windows chore(windows): Add a .gitattributes to fix line endings across myriad files. (#1431 by @trcoffman) 2020-06-16 11:53:22 -07:00
.all-contributorsrc chore(docs): add dvicory as a contributor (#576) 2019-05-17 09:28:05 +02:00
.eslintignore feat(android): fix overflow issues and match iOS default renders (#472) 2019-04-02 16:05:56 +02:00
.eslintrc.js fix(deps): updated dependancies and types (#847) 2019-09-19 11:40:51 +02:00
.flowconfig Add WebView Flow types 2018-09-10 18:46:07 -06:00
.flowconfig.android Add WebView Flow types 2018-09-10 18:46:07 -06:00
.gitattributes chore(windows): Add a .gitattributes to fix line endings across myriad files. (#1431 by @trcoffman) 2020-06-16 11:53:22 -07:00
.gitignore chore(windows): Set up Windows CI (#1358 by @kaiguo) 2020-05-08 13:24:37 -07:00
.prettierrc.js feat(typescript): Source code rewrite using typescript (#425) 2019-03-20 12:35:13 +00:00
.releaserc fix(semantic-release): Use git plugin to auto commit 2018-10-18 11:37:43 +02:00
LICENSE WIP: iOS WKWebView 2018-09-08 10:42:02 -07:00
README.md chore(docs): Update brazilian translation and reference in main readme.. (#1332 by @akinncar) 2020-05-28 16:55:00 -07:00
babel.config.js chore(example): Added three test examples: Alerts, Scrolling, and Background. 2020-01-21 11:39:40 -08:00
index.d.ts feat(iOS): Add onFileDownload callback (#1214) 2020-04-29 09:09:22 -07:00
index.js feat(typescript): Source code rewrite using typescript (#425) 2019-03-20 12:35:13 +00:00
jest.config.js feat(android): fix overflow issues and match iOS default renders (#472) 2019-04-02 16:05:56 +02:00
metro.config.js feat(macOS): macOS Support (#1164) 2020-02-12 15:39:11 -08:00
metro.config.macos.js feat(macOS): macOS Support (#1164) 2020-02-12 15:39:11 -08:00
metro.config.windows.js chore(ci): Cleanup windows ci (#1558) 2020-08-13 23:43:23 -07:00
package.json chore(release): 10.5.0 [skip ci] 2020-08-15 03:22:47 +00:00
react-native-webview.podspec feat(macOS): Make podspec compatible with macOS (#1328) 2020-04-24 19:54:17 +02:00
react-native.config.js feat(compatibility): Support React Native 0.62 (#1364 by @jussikinnula and @kaiguo) 2020-05-26 20:55:02 -07:00
tsconfig.json feat(typescript): Source code rewrite using typescript (#425) 2019-03-20 12:35:13 +00:00
yarn.lock chore(windows): Add a .gitattributes to fix line endings across myriad files. (#1431 by @trcoffman) 2020-06-16 11:53:22 -07:00

README.md

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

star this repo PRs Welcome All Contributors Known Vulnerabilities NPM Version Lean Core Extracted

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.

Platforms Supported

  • iOS
  • Android
  • macOS
  • Windows

Note: Expo support for React Native WebView started with Expo SDK v33.0.0.

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:

Current Version: version

  • 8.0.0 - onNavigationStateChange now triggers with hash url changes

  • 7.0.1 - Removed UIWebView

  • 6.0.2 - Update to AndroidX. Make sure to enable it in your project's android/gradle.properties. See Getting Started Guide.

  • 5.0.1 - Refactored the old postMessage implementation for communication from webview to native.

  • 4.0.0 - Added cache (enabled by default).

  • 3.0.0 - WKWebview: Add shared process pool so cookies and localStorage are shared across webviews in iOS (enabled by default).

  • 2.0.0 - First release this is a replica of the core webview component

Upcoming:

  • this.webView.postMessage() removal (never documented and less flexible than injectJavascript) -> how to migrate
  • 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://reactnative.dev/' }} />;
  }
}

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 "RNCWebView does not exist" it likely means you forgot to run react-native link or there was some error with the linking process

Contributing

See Contributing.md

Contributors

Thanks goes to these wonderful people (emoji key):

Thibault Malbranche
Thibault Malbranche

💻 🤔 👀 📖 🚧 ⚠️ 🚇 💬
Jamon Holmgren
Jamon Holmgren

💻 🤔 👀 📖 🚧 ⚠️ 💡 💬
Andrei Pfeiffer
Andrei Pfeiffer

💻 👀 🤔
Michael Diarmid
Michael Diarmid

💻 👀 🤔 🔧
Scott Mathson
Scott Mathson

💻 📖
Margaret
Margaret

💻 📖
Jordan Sexton
Jordan Sexton

💻 📖
Malcolm Scruggs
Malcolm Scruggs

💻 🔧 ⚠️
Momazo7u7
Momazo7u7

📖
Marco
Marco

📖
Julien Eluard
Julien Eluard

📖
Jian Wei
Jian Wei

💻 📖
Sergei Butko
Sergei Butko

📖
TMomemt
TMomemt

💻
Eric Lewis
Eric Lewis

💻 📖
Daniel Vicory
Daniel Vicory

💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT

Translations

This readme is available in: