merge upstream/master

docs/Reference.md

@@ -47,6 +47,7 @@ This document lays out the current public properties and methods for the React N
 - [`allowFileAccess`](Reference.md#allowFileAccess)
 - [`saveFormDataDisabled`](Reference.md#saveFormDataDisabled)
 - [`pagingEnabled`](Reference.md#pagingEnabled)
+- [`allowsLinkPreview`](Reference.md#allowsLinkPreview)
 
 ## Methods Index
 
@@ -528,6 +529,16 @@ If the value of this property is true, the scroll view stops on multiples of the
 | ------- | -------- | -------- |
 | boolean | No       | iOS      |
 
+---
+
+### `allowsLinkPreview`
+
+A Boolean value that determines whether pressing on a link displays a preview of the destination for the link. In iOS this property is available on devices that support 3D Touch. In iOS 10 and later, the default value is true; before that, the default value is false.
+
+| Type    | Required | Platform |
+| ------- | -------- | -------- |
+| boolean | No       | iOS      |
+
 ## Methods
 
 ### `extraNativeComponentConfig()`

ios/RNCWKWebView.h

@@ -39,6 +39,7 @@ shouldStartLoadForRequest:(NSMutableDictionary<NSString *, id> *)request
 @property (nonatomic, assign) BOOL hideKeyboardAccessoryView;
 @property (nonatomic, assign) BOOL allowsBackForwardNavigationGestures;
 @property (nonatomic, copy) NSString *userAgent;
+@property (nonatomic, assign) BOOL allowsLinkPreview;
 
 - (void)postMessage:(NSString *)message;
 - (void)injectJavaScript:(NSString *)script;

ios/RNCWKWebView.m

@@ -113,8 +113,10 @@ static NSString *const MessageHanderName = @"ReactNative";
     _webView.scrollView.scrollEnabled = _scrollEnabled;
     _webView.scrollView.pagingEnabled = _pagingEnabled;
     _webView.scrollView.bounces = _bounces;
+    _webView.allowsLinkPreview = _allowsLinkPreview;
     [_webView addObserver:self forKeyPath:@"estimatedProgress" options:NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew context:nil];
     _webView.allowsBackForwardNavigationGestures = _allowsBackForwardNavigationGestures;
+
     if (_userAgent) {
       _webView.customUserAgent = _userAgent;
     }

ios/RNCWKWebViewManager.m

@@ -47,6 +47,7 @@ RCT_EXPORT_VIEW_PROPERTY(hideKeyboardAccessoryView, BOOL)
 RCT_EXPORT_VIEW_PROPERTY(allowsBackForwardNavigationGestures, BOOL)
 RCT_EXPORT_VIEW_PROPERTY(pagingEnabled, BOOL)
 RCT_EXPORT_VIEW_PROPERTY(userAgent, NSString)
+RCT_EXPORT_VIEW_PROPERTY(allowsLinkPreview, BOOL)
 
 /**
  * Expose methods to enable messaging the webview.

js/WebViewTypes.js

@@ -0,0 +1,468 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @flow
+ */
+
+'use strict';
+
+import type {Node, Element, ComponentType} from 'react';
+
+import type {SyntheticEvent} from 'CoreEventTypes';
+import type {EdgeInsetsProp} from 'EdgeInsetsPropType';
+import type {ViewStyleProp} from 'StyleSheet';
+import type {ViewProps} from 'ViewPropTypes';
+
+export type WebViewNativeEvent = $ReadOnly<{|
+  url: string,
+  loading: boolean,
+  title: string,
+  canGoBack: boolean,
+  canGoForward: boolean,
+|}>;
+
+export type WebViewProgressEvent = $ReadOnly<{|
+    ...WebViewNativeEvent,
+    progress: number,
+|}>
+
+export type WebViewNavigation = $ReadOnly<{|
+  ...WebViewNativeEvent,
+  navigationType:
+    | 'click'
+    | 'formsubmit'
+    | 'backforward'
+    | 'reload'
+    | 'formresubmit'
+    | 'other',
+|}>;
+
+export type WebViewMessage = $ReadOnly<{|
+  ...WebViewNativeEvent,
+  data: string,
+|}>;
+
+export type WebViewError = $ReadOnly<{|
+  ...WebViewNativeEvent,
+  /**
+   * `domain` is only used on iOS
+   */
+  domain: ?string,
+  code: number,
+  description: string,
+|}>;
+
+export type WebViewEvent = SyntheticEvent<WebViewNativeEvent>;
+
+export type WebViewNavigationEvent = SyntheticEvent<WebViewNavigation>;
+
+export type WebViewMessageEvent = SyntheticEvent<WebViewMessage>;
+
+export type WebViewErrorEvent = SyntheticEvent<WebViewError>;
+
+export type DataDetectorTypes =
+  | 'phoneNumber'
+  | 'link'
+  | 'address'
+  | 'calendarEvent'
+  | 'trackingNumber'
+  | 'flightNumber'
+  | 'lookupSuggestion'
+  | 'none'
+  | 'all';
+
+export type OverScrollModeType = 'always' | 'content' | 'never';
+
+export type WebViewSourceUri = $ReadOnly<{|
+  /**
+   * The URI to load in the `WebView`. Can be a local or remote file.
+   */
+  uri?: ?string,
+
+  /**
+   * The HTTP Method to use. Defaults to GET if not specified.
+   * NOTE: On Android, only GET and POST are supported.
+   */
+  method?: string,
+
+  /**
+   * Additional HTTP headers to send with the request.
+   * NOTE: On Android, this can only be used with GET requests.
+   */
+  headers?: Object,
+
+  /**
+   * The HTTP body to send with the request. This must be a valid
+   * UTF-8 string, and will be sent exactly as specified, with no
+   * additional encoding (e.g. URL-escaping or base64) applied.
+   * NOTE: On Android, this can only be used with POST requests.
+   */
+  body?: string,
+|}>;
+
+export type WebViewSourceHtml = $ReadOnly<{|
+  /**
+   * A static HTML page to display in the WebView.
+   */
+  html?: ?string,
+  /**
+   * The base URL to be used for any relative links in the HTML.
+   */
+  baseUrl?: ?string,
+|}>;
+
+export type WebViewSource = WebViewSourceUri | WebViewSourceHtml;
+
+export type WebViewNativeConfig = $ReadOnly<{|
+  /*
+   * The native component used to render the WebView.
+   */
+  component?: ComponentType<WebViewSharedProps>,
+  /*
+   * Set props directly on the native component WebView. Enables custom props which the
+   * original WebView doesn't pass through.
+   */
+  props?: ?Object,
+  /*
+   * Set the ViewManager to use for communication with the native side.
+   * @platform ios
+   */
+  viewManager?: ?Object,
+|}>;
+
+export type IOSWebViewProps = $ReadOnly<{|
+  /**
+   * If true, use WKWebView instead of UIWebView.
+   * @platform ios
+   */
+  useWebKit?: ?boolean,
+
+  /**
+   * Boolean value that determines whether the web view bounces
+   * when it reaches the edge of the content. The default value is `true`.
+   * @platform ios
+   */
+  bounces?: ?boolean,
+
+  /**
+   * A floating-point number that determines how quickly the scroll view
+   * decelerates after the user lifts their finger. You may also use the
+   * string shortcuts `"normal"` and `"fast"` which match the underlying iOS
+   * settings for `UIScrollViewDecelerationRateNormal` and
+   * `UIScrollViewDecelerationRateFast` respectively:
+   *
+   *   - normal: 0.998
+   *   - fast: 0.99 (the default for iOS web view)
+   * @platform ios
+   */
+  decelerationRate?: ?('fast' | 'normal' | number),
+
+  /**
+   * Boolean value that determines whether scrolling is enabled in the
+   * `WebView`. The default value is `true`.
+   * @platform ios
+   */
+  scrollEnabled?: ?boolean,
+
+  /**
+   * If the value of this property is true, the scroll view stops on multiples
+   * of the scroll view’s bounds when the user scrolls.
+   * The default value is false.
+   * @platform ios
+   */
+  pagingEnabled?: ?boolean,
+
+  /**
+   * The amount by which the web view content is inset from the edges of
+   * the scroll view. Defaults to {top: 0, left: 0, bottom: 0, right: 0}.
+   * @platform ios
+   */
+  contentInset?: ?EdgeInsetsProp,
+
+  /**
+   * Determines the types of data converted to clickable URLs in the web view's content.
+   * By default only phone numbers are detected.
+   *
+   * You can provide one type or an array of many types.
+   *
+   * Possible values for `dataDetectorTypes` are:
+   *
+   * - `'phoneNumber'`
+   * - `'link'`
+   * - `'address'`
+   * - `'calendarEvent'`
+   * - `'none'`
+   * - `'all'`
+   *
+   * With the new WebKit implementation, we have three new values:
+   * - `'trackingNumber'`,
+   * - `'flightNumber'`,
+   * - `'lookupSuggestion'`,
+   *
+   * @platform ios
+   */
+  dataDetectorTypes?:
+    | ?DataDetectorTypes
+    | $ReadOnlyArray<DataDetectorTypes>,
+
+  /**
+   * Function that allows custom handling of any web view requests. Return
+   * `true` from the function to continue loading the request and `false`
+   * to stop loading.
+   * @platform ios
+   */
+  onShouldStartLoadWithRequest?: (event: WebViewEvent) => mixed,
+
+  /**
+   * Boolean that determines whether HTML5 videos play inline or use the
+   * native full-screen controller. The default value is `false`.
+   *
+   * **NOTE** : In order for video to play inline, not only does this
+   * property need to be set to `true`, but the video element in the HTML
+   * document must also include the `webkit-playsinline` attribute.
+   * @platform ios
+   */
+  allowsInlineMediaPlayback?: ?boolean,
+  /**
+   * Hide the accessory view when the keyboard is open. Default is false to be
+   * backward compatible.
+   */
+  hideKeyboardAccessoryView?: ?boolean,
+  /**
+   * A Boolean value indicating whether horizontal swipe gestures will trigger
+   * back-forward list navigations.
+   */
+  allowsBackForwardNavigationGestures?: ?boolean,
+  /**
+   * The custom user agent string.
+   */
+  userAgent?: ?string,
+
+  /**
+   * A Boolean value that determines whether pressing on a link
+   * displays a preview of the destination for the link.
+   *
+   * This property is available on devices that support 3D Touch.
+   * In iOS 10 and later, the default value is `true`; before that, the default value is `false`.
+   * @platform ios
+   */
+  allowsLinkPreview?: ?boolean,
+|}>;
+
+export type AndroidWebViewProps = $ReadOnly<{|
+  onNavigationStateChange?: (event: WebViewNavigation) => mixed,
+  onContentSizeChange?: (event: WebViewEvent) => mixed,
+
+  /**
+   * https://developer.android.com/reference/android/view/View#OVER_SCROLL_NEVER
+   * Sets the overScrollMode. Possible values are:
+   *
+   * - `'always'` (default)
+   * - `'content'`
+   * - `'never'`
+   *
+   * @platform android
+   */
+  overScrollMode?: ?OverScrollModeType,
+
+  /**
+   * Sets whether Geolocation is enabled. The default is false.
+   * @platform android
+   */
+  geolocationEnabled?: ?boolean,
+
+  /**
+   * Boolean that sets whether JavaScript running in the context of a file
+   * scheme URL should be allowed to access content from any origin.
+   * Including accessing content from other file scheme URLs
+   * @platform android
+   */
+  allowUniversalAccessFromFileURLs?: ?boolean,
+
+  /**
+   * Sets whether the webview allow access to file system.
+   * @platform android
+   */
+  allowFileAccess?: ?boolean,
+
+  /**
+   * Used on Android only, controls whether form autocomplete data should be saved
+   * @platform android
+   */
+  saveFormDataDisabled?: ?boolean,
+
+  /*
+   * Used on Android only, controls whether the given list of URL prefixes should
+   * make {@link com.facebook.react.views.webview.ReactWebViewClient} to launch a
+   * default activity intent for those URL instead of loading it within the webview.
+   * Use this to list URLs that WebView cannot handle, e.g. a PDF url.
+   * @platform android
+   */
+  urlPrefixesForDefaultIntent?: $ReadOnlyArray<string>,
+
+  /**
+   * Boolean value to enable JavaScript in the `WebView`. Used on Android only
+   * as JavaScript is enabled by default on iOS. The default value is `true`.
+   * @platform android
+   */
+  javaScriptEnabled?: ?boolean,
+
+  /**
+   * Boolean value to enable third party cookies in the `WebView`. Used on
+   * Android Lollipop and above only as third party cookies are enabled by
+   * default on Android Kitkat and below and on iOS. The default value is `true`.
+   * @platform android
+   */
+  thirdPartyCookiesEnabled?: ?boolean,
+
+  /**
+   * Boolean value to control whether DOM Storage is enabled. Used only in
+   * Android.
+   * @platform android
+   */
+  domStorageEnabled?: ?boolean,
+
+  /**
+   * Sets the user-agent for the `WebView`.
+   * @platform android
+   */
+  userAgent?: ?string,
+
+  /**
+   * Specifies the mixed content mode. i.e WebView will allow a secure origin to load content from any other origin.
+   *
+   * Possible values for `mixedContentMode` are:
+   *
+   * - `'never'` (default) - WebView will not allow a secure origin to load content from an insecure origin.
+   * - `'always'` - WebView will allow a secure origin to load content from any other origin, even if that origin is insecure.
+   * - `'compatibility'` -  WebView will attempt to be compatible with the approach of a modern web browser with regard to mixed content.
+   * @platform android
+   */
+  mixedContentMode?: ?('never' | 'always' | 'compatibility'),
+|}>;
+
+export type WebViewSharedProps =  $ReadOnly<{|
+  ...ViewProps,
+  ...IOSWebViewProps,
+  ...AndroidWebViewProps,
+  /**
+   * Deprecated. Use `source` instead.
+   */
+  url?: ?string,
+  /**
+   * Deprecated. Use `source` instead.
+   */
+  html?: ?string,
+
+  /**
+   * Loads static html or a uri (with optional headers) in the WebView.
+   */
+  source?: ?WebViewSource,
+
+  /**
+   * Function that returns a view to show if there's an error.
+   */
+  renderError: (errorDomain: ?string, errorCode: number, errorDesc: string) => Element<any>, // view to show if there's an error
+
+  /**
+   * Function that returns a loading indicator.
+   */
+  renderLoading: () => Element<any>,
+
+  /**
+   * Function that is invoked when the `WebView` has finished loading.
+   */
+  onLoad: (event: WebViewNavigationEvent) => mixed,
+
+  /**
+   * Function that is invoked when the `WebView` load succeeds or fails.
+   */
+  onLoadEnd: (event: WebViewNavigationEvent | WebViewErrorEvent) => mixed,
+
+  /**
+   * Function that is invoked when the `WebView` starts loading.
+   */
+  onLoadStart: (event: WebViewNavigationEvent) => mixed,
+
+  /**
+   * Function that is invoked when the `WebView` load fails.
+   */
+  onError: (event: WebViewErrorEvent) => mixed,
+
+  /**
+   * Controls whether to adjust the content inset for web views that are
+   * placed behind a navigation bar, tab bar, or toolbar. The default value
+   * is `true`.
+   */
+  automaticallyAdjustContentInsets?: ?boolean,
+
+  /**
+   * Function that is invoked when the `WebView` loading starts or ends.
+   */
+  onNavigationStateChange?: (event: WebViewNavigation) => mixed,
+
+  /**
+   * A function that is invoked when the webview calls `window.postMessage`.
+   * Setting this property will inject a `postMessage` global into your
+   * webview, but will still call pre-existing values of `postMessage`.
+   *
+   * `window.postMessage` accepts one argument, `data`, which will be
+   * available on the event object, `event.nativeEvent.data`. `data`
+   * must be a string.
+   */
+  onMessage?: (event: WebViewMessageEvent) => mixed,
+
+  /**
+   * Function that is invoked when the `WebView` is loading.
+   */
+  onLoadProgress?: (event: WebViewProgressEvent) => mixed,
+
+  /**
+   * Boolean value that forces the `WebView` to show the loading view
+   * on the first load.
+   */
+  startInLoadingState?: ?boolean,
+
+  /**
+   * Set this to provide JavaScript that will be injected into the web page
+   * when the view loads.
+   */
+  injectedJavaScript?: ?string,
+
+  /**
+   * Boolean that controls whether the web content is scaled to fit
+   * the view and enables the user to change the scale. The default value
+   * is `true`.
+   *
+   * On iOS, when `useWebKit=true`, this prop will not work.
+   */
+  scalesPageToFit?: ?boolean,
+
+  /**
+   * Boolean that determines whether HTML5 audio and video requires the user
+   * to tap them before they start playing. The default value is `true`.
+   */
+  mediaPlaybackRequiresUserAction?: ?boolean,
+
+  /**
+   * List of origin strings to allow being navigated to. The strings allow
+   * wildcards and get matched against *just* the origin (not the full URL).
+   * If the user taps to navigate to a new page but the new page is not in
+   * this whitelist, we will open the URL in Safari.
+   * The default whitelisted origins are "http://*" and "https://*".
+   */
+  originWhitelist?: $ReadOnlyArray<string>,
+
+  /**
+   * Override the native component used to render the WebView. Enables a custom native
+   * WebView which uses the same JavaScript as the original WebView.
+   */
+  nativeConfig?: ?WebViewNativeConfig,
+
+  style?: ViewStyleProp,
+  children: Node,
+|}>;

package.json

@@ -8,7 +8,7 @@
     "Thibault Malbranche <malbranche.thibault@gmail.com>"
   ],
   "license": "MIT",
-  "version": "2.12.1",
+  "version": "2.13.0",
   "homepage": "https://github.com/react-native-community/react-native-webview#readme",
   "scripts": {
     "prebuild": "rimraf lib",

src/WebView.ios.tsx

@@ -281,6 +281,7 @@ export default class WebView extends React.Component<
           this.props.mediaPlaybackRequiresUserAction
         }
         dataDetectorTypes={this.props.dataDetectorTypes}
+        allowsLinkPreview={this.props.allowsLinkPreview}
         {...nativeConfig.props}
       />
     );

src/types/WebViewTypes.ts

@@ -238,6 +238,16 @@ export interface IOSWebViewProps {
    * If true, this will be able horizontal swipe gestures when using the WKWebView. The default value is `false`.
    */
   allowsBackForwardNavigationGestures?: boolean;
+
+  /**
+   * A Boolean value that determines whether pressing on a link
+   * displays a preview of the destination for the link.
+   *
+   * This property is available on devices that support 3D Touch.
+   * In iOS 10 and later, the default value is `true`; before that, the default value is `false`.
+   * @platform ios
+   */
+  allowsLinkPreview?: boolean;
 }
 
 export interface AndroidWebViewProps {