@exodus/react-native-webview 11.26.1-exodus.32 → 11.26.1-exodus.34

package/bin/setup

@@ -1,26 +0,0 @@
-#! /bin/bash
-
-# Node installed?
-if ! [ -x "$(command -v node)" ]; then
-  echo 'Error: node is not installed.' >&2
-
-  if ! [ -x "$(command -v brew)" ]; then
-    echo 'Go here to install: https://nodejs.org/en/download/'
-  fi
-
-  if [ -x "$(command -v brew)" ]; then
-    echo 'You have Homebrew installed, so run "brew install node".'
-  fi
-  
-  exit 1
-fi
-
-# React Native installed?
-if ! [ -x "$(command -v react-native)" ]; then
-  echo 'Error: React Native is not installed.' >&2
-  echo 'Go here: https://reactnative.dev/docs/getting-started.html' >&2
-  echo 'Use the "Building Projects With Native Code" option.'
-  exit 1
-fi
-
-# TODO: Automate setup on new machines

package/docs/Contributing.md

@@ -1,102 +0,0 @@
-# Contributing to React Native WebView
-
-First off, _thank you_ for considering contributing to the React Native Community. The community-supported packages are only possible because of amazing people like you.
-
-Secondly, we'd like the contribution experience to be as good as possible. While we are a small all-volunteer team, we are happy to hear feedback about your experience, and if we can make the docs or experience better please let us know.
-
-## How to test changes
-
-After you fork the repo, clone it to your machine, and make your changes, you'll want to test them in an app.
-
-There are two methods of testing:
-1) Testing within a clone of react-native-webview
-2) Testing in a new `react-native init` project
-
-### Testing within react-native-webview
-
-#### For all platforms:
-
-```sh
-yarn install
-```
-
-#### For Android:
-
-```sh
-yarn android
-```
-
-The Android example app will built, the Metro Bundler will launch, and the example app will be installed and started in the Android emulator.
-
-#### For iOS:
-
-```sh
-pod install --project-directory=ios
-yarn ios
-```
-
-The iOS example app will be built, the Metro bundler will launch, and the example app will be installed and started in the Simulator.
-
-#### For macOS:
-
-```sh
-pod install --project-directory=macos
-yarn macos
-```
-
-The macOS example app will be built, the Metro bundler will launch, and the example app will be installed and started.
-
-#### For Windows:
-
-```sh
-yarn windows
-```
-
-The Windows example app will be built, the Metro bundler will launch, and the example app will be installed and started.
-
-### Testing in a new `react-native init` project
-
-In a new `react-native init` project, do this:
-
-```
-$ yarn add ../react-native-webview
-$ react-native link react-native-webview
-```
-
-You may run into a problem where the `jest-haste-map` module map says react-native was added twice:
-
-```
-Loading dependency graph...(node:32651) UnhandledPromiseRejectionWarning: Error: jest-haste-map: Haste module naming collision:
-  Duplicate module name: react-native
-  Paths: /Users/myuser/TestApp/node_modules/react-native/package.json collides with /Users/myuser/TestApp/node_modules/react-native-webview/node_modules/react-native/package.json
-```
-
-Just remove the second path like this:
-
-```
-$ rm -rf ./node_modules/react-native-webview/node_modules/react-native
-```
-
-And then re-run the packager:
-
-```
-$ react-native start --reset-cache
-```
-
-When you make a change, you'll probably need to unlink, remove, re-add, and re-link `react-native-webview`:
-
-```
-$ react-native unlink react-native-webview && yarn remove react-native-webview
-$ yarn add ../react-native-webview && react-native link react-native-webview
-```
-
-## Notes
-
-- We use TypeScript.
-- After pulling this repo and installing all dependencies, you can run tests using the command: `yarn ci`
-
-## Translations
-
-This file is available at:
-
-- [Brazilian portuguese](Contributing.portuguese.md)

package/docs/Custom-Android.md

@@ -1,222 +0,0 @@
-While the built-in web view has a lot of features, it is not possible to handle every use-case in React Native. You can, however, extend the web view with native code without forking React Native or duplicating all the existing web view code.
-
-Before you do this, you should be familiar with the concepts in [native UI components](https://reactnative.dev/docs/native-components-android). You should also familiarise yourself with the [native code for web views](https://github.com/react-native-webview/react-native-webview/blob/master/android/src/main/java/com/reactnativecommunity/webview/RNCWebViewManager.java), as you will have to use this as a reference when implementing new features—although a deep understanding is not required.
-
-## Native Code
-
-To get started, you'll need to create a subclass of `RNCWebViewManager`, `RNCWebView`, and `RNCWebViewClient`. In your view manager, you'll then need to override:
-
-- `createReactWebViewInstance`
-- `getName`
-- `addEventEmitters`
-
-```java
-@ReactModule(name = CustomWebViewManager.REACT_CLASS)
-public class CustomWebViewManager extends RNCWebViewManager {
-  /* This name must match what we're referring to in JS */
-  protected static final String REACT_CLASS = "RCTCustomWebView";
-
-  protected static class CustomWebViewClient extends RNCWebViewClient { }
-
-  protected static class CustomWebView extends RNCWebView {
-    public CustomWebView(ThemedReactContext reactContext) {
-      super(reactContext);
-    }
-  }
-
-  @Override
-  protected RNCWebView createRNCWebViewInstance(ThemedReactContext reactContext) {
-    return new CustomWebView(reactContext);
-  }
-
-  @Override
-  public String getName() {
-    return REACT_CLASS;
-  }
-
-  @Override
-  protected void addEventEmitters(ThemedReactContext reactContext, WebView view) {
-    view.setWebViewClient(new CustomWebViewClient());
-  }
-}
-```
-
-You'll need to follow the usual steps to [register the module](https://reactnative.dev/docs/native-modules-android#register-the-module-android-specific).
-
-### Adding New Properties
-
-To add a new property, you'll need to add it to `CustomWebView`, and then expose it in `CustomWebViewManager`.
-
-```java
-public class CustomWebViewManager extends RNCWebViewManager {
-  ...
-
-  protected static class CustomWebView extends RNCWebView {
-    public CustomWebView(ThemedReactContext reactContext) {
-      super(reactContext);
-    }
-
-    protected @Nullable String mFinalUrl;
-
-    public void setFinalUrl(String url) {
-        mFinalUrl = url;
-    }
-
-    public String getFinalUrl() {
-        return mFinalUrl;
-    }
-  }
-
-  ...
-
-  @ReactProp(name = "finalUrl")
-  public void setFinalUrl(WebView view, String url) {
-    ((CustomWebView) view).setFinalUrl(url);
-  }
-}
-```
-
-### Adding New Events
-
-For events, you'll first need to make create event subclass.
-
-```java
-// NavigationCompletedEvent.java
-public class NavigationCompletedEvent extends Event<NavigationCompletedEvent> {
-  private WritableMap mParams;
-
-  public NavigationCompletedEvent(int viewTag, WritableMap params) {
-    super(viewTag);
-    this.mParams = params;
-  }
-
-  @Override
-  public String getEventName() {
-    return "navigationCompleted";
-  }
-
-  @Override
-  public void dispatch(RCTEventEmitter rctEventEmitter) {
-    init(getViewTag());
-    rctEventEmitter.receiveEvent(getViewTag(), getEventName(), mParams);
-  }
-}
-```
-
-You can trigger the event in your web view client. You can hook existing handlers if your events are based on them.
-
-You should refer to [RNCWebViewManager.java](https://github.com/react-native-webview/react-native-webview/blob/master/android/src/main/java/com/reactnativecommunity/webview/RNCWebViewManager.java) in the react-native-webview codebase to see what handlers are available and how they are implemented. You can extend any methods here to provide extra functionality.
-
-```java
-public class NavigationCompletedEvent extends Event<NavigationCompletedEvent> {
-  private WritableMap mParams;
-
-  public NavigationCompletedEvent(int viewTag, WritableMap params) {
-    super(viewTag);
-    this.mParams = params;
-  }
-
-  @Override
-  public String getEventName() {
-    return "navigationCompleted";
-  }
-
-  @Override
-  public void dispatch(RCTEventEmitter rctEventEmitter) {
-    init(getViewTag());
-    rctEventEmitter.receiveEvent(getViewTag(), getEventName(), mParams);
-  }
-}
-
-// CustomWebViewManager.java
-protected static class CustomWebViewClient extends RNCWebViewClient {
-  @Override
-  public boolean shouldOverrideUrlLoading(WebView view, String url) {
-    boolean shouldOverride = super.shouldOverrideUrlLoading(view, url);
-    String finalUrl = ((CustomWebView) view).getFinalUrl();
-
-    if (!shouldOverride && url != null && finalUrl != null && new String(url).equals(finalUrl)) {
-      final WritableMap params = Arguments.createMap();
-      dispatchEvent(view, new NavigationCompletedEvent(view.getId(), params));
-    }
-
-    return shouldOverride;
-  }
-}
-```
-
-Finally, you'll need to expose the events in `CustomWebViewManager` through `getExportedCustomDirectEventTypeConstants`. Note that currently, the default implementation returns `null`, but this may change in the future.
-
-```java
-public class CustomWebViewManager extends RNCWebViewManager {
-  ...
-
-  @Override
-  public @Nullable
-  Map getExportedCustomDirectEventTypeConstants() {
-    Map<String, Object> export = super.getExportedCustomDirectEventTypeConstants();
-    if (export == null) {
-      export = MapBuilder.newHashMap();
-    }
-    export.put("navigationCompleted", MapBuilder.of("registrationName", "onNavigationCompleted"));
-    return export;
-  }
-}
-```
-
-## JavaScript Interface
-
-To use your custom web view, you may want to create a class for it. Your class must return a `WebView` component with the prop `nativeConfig.component` set to your native component (see below).
-
-To get your native component, you must use `requireNativeComponent`: the same as for regular custom components.
-
-```javascript
-import React, { Component } from 'react';
-import { requireNativeComponent } from 'react-native';
-import { WebView } from 'react-native-webview';
-
-export default class CustomWebView extends Component {
-  render() {
-    return (
-      <WebView {...this.props} nativeConfig={{ component: RCTCustomWebView }} />
-    );
-  }
-}
-
-const RCTCustomWebView = requireNativeComponent('RCTCustomWebView');
-```
-
-If you want to add custom props to your native component, you can use `nativeConfig.props` on the web view.
-
-For events, the event handler must always be set to a function. This means it isn't safe to use the event handler directly from `this.props`, as the user might not have provided one. The standard approach is to create a event handler in your class, and then invoking the event handler given in `this.props` if it exists.
-
-If you are unsure how something should be implemented from the JS side, look at [WebView.android.tsx](https://github.com/react-native-webview/react-native-webview/blob/master/src/WebView.android.tsx) in the React Native WebView source.
-
-```javascript
-export default class CustomWebView extends Component {
-  _onNavigationCompleted = (event) => {
-    const { onNavigationCompleted } = this.props;
-    onNavigationCompleted && onNavigationCompleted(event);
-  };
-
-  render() {
-    return (
-      <WebView
-        {...this.props}
-        nativeConfig={{
-          component: RCTCustomWebView,
-          props: {
-            finalUrl: this.props.finalUrl,
-            onNavigationCompleted: this._onNavigationCompleted,
-          },
-        }}
-      />
-    );
-  }
-}
-```
-## Translations
-
-This file is available at:
-
-- [Brazilian portuguese](Custom-Android.portuguese.md)

package/docs/Custom-iOS.md

@@ -1,236 +0,0 @@
-**NOTE: This document was imported from [the original WebView documentation](https://github.com/facebook/react-native-website/blob/7d3e9e120e38a7ba928f6b173eb98f88b6f2f85f/docs/custom-webview-ios.md). While it may prove useful, it has not been adapted to React Native WebView yet.**
-
-While the built-in web view has a lot of features, it is not possible to handle every use-case in React Native. You can, however, extend the web view with native code without forking React Native or duplicating all the existing web view code.
-
-Before you do this, you should be familiar with the concepts in [native UI components](native-components-ios). You should also familiarise yourself with the [native code for web views](https://github.com/react-native-webview/react-native-webview/blob/master/apple/RNCWebViewManager.m), as you will have to use this as a reference when implementing new features—although a deep understanding is not required.
-
-## Native Code
-
-Like for regular native components, you need a view manager and an web view.
-
-For the view, you'll need to make a subclass of `RCTWebView`.
-
-```objc
-// RCTCustomWebView.h
-#import <React/RCTWebView.h>
-
-@interface RCTCustomWebView : RCTWebView
-
-@end
-
-// RCTCustomWebView.m
-#import "RCTCustomWebView.h"
-
-@interface RCTCustomWebView ()
-
-@end
-
-@implementation RCTCustomWebView { }
-
-@end
-```
-
-For the view manager, you need to make a subclass `RCTWebViewManager`. You must still include:
-
-* `(UIView *)view` that returns your custom view
-* The `RCT_EXPORT_MODULE()` tag
-
-```objc
-// RCTCustomWebViewManager.h
-#import <React/RCTWebViewManager.h>
-
-@interface RCTCustomWebViewManager : RCTWebViewManager
-
-@end
-
-// RCTCustomWebViewManager.m
-#import "RCTCustomWebViewManager.h"
-#import "RCTCustomWebView.h"
-
-@interface RCTCustomWebViewManager () <RCTWebViewDelegate>
-
-@end
-
-@implementation RCTCustomWebViewManager { }
-
-RCT_EXPORT_MODULE()
-
-- (UIView *)view
-{
-  RCTCustomWebView *webView = [RCTCustomWebView new];
-  webView.delegate = self;
-  return webView;
-}
-
-@end
-```
-
-### Adding New Events and Properties
-
-Adding new properties and events is the same as regular UI components. For properties, you define an `@property` in the header. For events, you define a `RCTDirectEventBlock` in the view's `@interface`.
-
-```objc
-// RCTCustomWebView.h
-@property (nonatomic, copy) NSString *finalUrl;
-
-// RCTCustomWebView.m
-@interface RCTCustomWebView ()
-
-@property (nonatomic, copy) RCTDirectEventBlock onNavigationCompleted;
-
-@end
-```
-
-Then expose it in the view manager's `@implementation`.
-
-```objc
-// RCTCustomWebViewManager.m
-RCT_EXPORT_VIEW_PROPERTY(onNavigationCompleted, RCTDirectEventBlock)
-RCT_EXPORT_VIEW_PROPERTY(finalUrl, NSString)
-```
-
-### Extending Existing Events
-
-You should refer to [RCTWebView.m](https://github.com/facebook/react-native/blob/master/React/Views/RCTWebView.m) in the React Native codebase to see what handlers are available and how they are implemented. You can extend any methods here to provide extra functionality.
-
-By default, most methods aren't exposed from RCTWebView. If you need to expose them, you need to create an [Objective C category](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/CustomizingExistingClasses/CustomizingExistingClasses.html), and then expose all the methods you need to use.
-
-```objc
-// RCTWebView+Custom.h
-#import <React/RCTWebView.h>
-
-@interface RCTWebView (Custom)
-- (BOOL)webView:(__unused UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType;
-- (NSMutableDictionary<NSString *, id> *)baseEvent;
-@end
-```
-
-Once these are exposed, you can reference them in your custom web view class.
-
-```objc
-// RCTCustomWebView.m
-
-// Remember to import the category file.
-#import "RCTWebView+Custom.h"
-
-- (BOOL)webView:(__unused UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request
- navigationType:(UIWebViewNavigationType)navigationType
-{
-  BOOL allowed = [super webView:webView shouldStartLoadWithRequest:request navigationType:navigationType];
-
-  if (allowed) {
-    NSString* url = request.URL.absoluteString;
-    if (url && [url isEqualToString:_finalUrl]) {
-      if (_onNavigationCompleted) {
-        NSMutableDictionary<NSString *, id> *event = [self baseEvent];
-        _onNavigationCompleted(event);
-      }
-    }
-  }
-
-  return allowed;
-}
-```
-
-### Setting Client Certificate Authentication Credential
-
-If you open webpages that needs a Client Certificate for Authentication, you can create a credential and pass it to the webview:
-
-```
-[RNCWebView setClientAuthenticationCredential:credential];
-```
-
-This can be paired with a call from Javascript to pass a string label for the certificate stored in keychain and use native calls to fetch the certificate to create a credential object. This call can be made anywhere that makes sense for your application (e.g. as part of the user authentication stack). The only requirement is to make this call before displaying any webviews.
-
-### Allowing custom CAs (Certifica Authorities) and enabling SSL Pinning
-
-If you need to connect to a server which has a self signed certificate, or want to perform SSL Pinning on the webview requests, you need to pass a dictionary with the host as the key, and the certificate as the value of each item:
-
-
-```objc
--(void)installCerts {
-
-  // Get the bundle where the certificates in DER format are present.
-  NSBundle *bundle = [NSBundle mainBundle];
-  
-  NSMutableDictionary* certMap = [NSMutableDictionary new];
-
-  NSData *rootCertData = [NSData dataWithContentsOfFile:[bundle pathForResource:@"example_ca" ofType:@"der"]];
-
-  SecCertificateRef certificate = SecCertificateCreateWithData(NULL, (CFDataRef) rootCertData);
-   
-  OSStatus err = SecItemAdd((CFDictionaryRef) [NSDictionary dictionaryWithObjectsAndKeys:(id) kSecClassCertificate, kSecClass, certificate, kSecValueRef, nil], NULL);
-  
-  [certMap setObject:(__bridge id _Nonnull)(certificate) forKey:@"example.com"];
-
-  [RNCWebView setCustomCertificatesForHost:certMap];
-}
-
-```
-
-Multiple hosts can be added to the dictionary, and only one certificate for a host is allowed. The verification will succeed if any of the certificates in the chain of the request matches the one defined for the request's host.
-
-
-## JavaScript Interface
-
-To use your custom web view, you may want to create a class for it. Your class must return a `WebView` component with the prop `nativeConfig.component` set to your native component (see below).
-
-To get your native component, you must use `requireNativeComponent`: the same as for regular custom components.
-
-```javascript
-import React, {Component} from 'react';
-import {WebView, requireNativeComponent, NativeModules} from 'react-native';
-const {CustomWebViewManager} = NativeModules;
-
-export default class CustomWebView extends Component {
-  render() {
-    return (
-      <WebView
-        {...this.props}
-        nativeConfig={{
-          component: RCTCustomWebView,
-          viewManager: CustomWebViewManager,
-        }}
-      />
-    );
-  }
-}
-
-const RCTCustomWebView = requireNativeComponent('RCTCustomWebView');
-```
-
-If you want to add custom props to your native component, you can use `nativeConfig.props` on the web view. For iOS, you should also set the `nativeConfig.viewManager` prop with your custom WebView ViewManager as in the example above.
-
-For events, the event handler must always be set to a function. This means it isn't safe to use the event handler directly from `this.props`, as the user might not have provided one. The standard approach is to create a event handler in your class, and then invoking the event handler given in `this.props` if it exists.
-
-If you are unsure how something should be implemented from the JS side, look at [WebView.ios.tsx](https://github.com/react-native-webview/react-native-webview/blob/master/src/WebView.ios.tsx) in the React Native WebView source.
-
-```javascript
-export default class CustomWebView extends Component {
-  _onNavigationCompleted = (event) => {
-    const {onNavigationCompleted} = this.props;
-    onNavigationCompleted && onNavigationCompleted(event);
-  };
-
-  render() {
-    return (
-      <WebView
-        {...this.props}
-        nativeConfig={{
-          component: RCTCustomWebView,
-          props: {
-            finalUrl: this.props.finalUrl,
-            onNavigationCompleted: this._onNavigationCompleted,
-          },
-          viewManager: CustomWebViewManager,
-        }}
-      />
-    );
-  }
-}
-```
-## Translations
-
-This file is available at:
-
-- [Brazilian portuguese](Custom-iOS.portuguese.md)

package/docs/Debugging.md

@@ -1,101 +0,0 @@
-# React Native WebView Debugging Guide
-
-Here are some helpful React Native WebView debugging tips.
-
-## Script Errors
-
-It can be difficult to debug syntax errors and other script errors in WebView, since errors don't show up in a console by default.
-
-One option (if you're loading HTML from an external source) is to inject an error handler before the content is loaded.
-
-```js
-<WebView
-  injectedJavaScriptBeforeContentLoaded={`
-    window.onerror = function(message, sourcefile, lineno, colno, error) {
-      alert("Message: " + message + " - Source: " + sourcefile + " Line: " + lineno + ":" + colno);
-      return true;
-    };
-    true;
-  `}
-  source={{
-    uri:
-      'https://bl.ocks.org/jamonholmgren/raw/48423fd99537283beace1daa2688e80f/',
-  }}
-/>
-```
-
-This will provide an Alert box with (hopefully) useful debugging information.
-
-If you're injecting JavaScript, this may fail with `Script error` and no other useful information. One simple way to debug this is to wrap your injected JavaScript in a try/catch, like so:
-
-```js
-const js = `
-  try {
-    // your code here
-  } catch(e) {
-    alert(e)
-  }
-  true;
-`;
-```
-
-This will bring up an alert with the error message, which may or may not be helpful.
-
-If these two simple methods fail to uncover the bug, try using the next technique!
-
-## Debugging WebView Contents
-
-### iOS & Safari
-
-It's possible to debug WebView contents in the iOS simulator or on a device using Safari Developer Toolkit.
-
-#### Steps:
-
-1. Open Safari Preferences -> "Advanced" tab -> enable checkbox "Show Develop menu in menu bar"
-2. Start app with React Native WebView in iOS simulator or iOS device
-3. Safari -> Develop -> [device name] -> [app name] -> [url - title]
-4. You can now debug the WebView contents just as you would on the web
-
-##### Notes:
-
-When debugging on device you must enable Web Inspector in your device settings:
-
-Settings -> Safari -> Advanced -> Web Inspector
-
-Also, if you don't see your device in the Develop menu, and you started Safari before you started your simulator, try restarting Safari.
-
-### Android & Chrome
-
-It's possible to debug WebView contents in the Android emulator or on a device using Chrome DevTools.
-
-1. You will need to make the following change to `MainApplication.java` to enabled web contents debugging:
-
-```java
-  import android.webkit.WebView;
-
-  @Override
-  public void onCreate() {
-    super.onCreate();
-	  ...
-    WebView.setWebContentsDebuggingEnabled(true);
-  }
-```
-
-2. Start app with React Native WebView in Android emulator or Android device
-3. Open `chrome://inspect/#devices` on Chrome (Reference: [Remote debug Android devices](https://developer.chrome.com/docs/devtools/remote-debugging/))
-4. Select your device on the left and select "Inspect" on the WebView contents you'd like to inspect
-5. You can now debug the WebView contents just as you would on the web
-
-![image](https://user-images.githubusercontent.com/1479215/47129785-9476e480-d24b-11e8-8cb1-fba77ee1c072.png)
-
-##### Note:
-
-When debugging on device you must enable USB debugging in your device settings:
-
-Settings -> System -> About Phone -> Developer options -> enable USB debugging
-
-## Translations
-
-This file is available at:
-
-- [Brazilian portuguese](Debugging.portuguese.md)