From 26d2f5ced471c500cb547411c4a77de65e391740 Mon Sep 17 00:00:00 2001 From: Jamon Holmgren Date: Sat, 8 Sep 2018 10:42:02 -0700 Subject: [PATCH] WIP: iOS WKWebView --- LICENSE | 21 ++ README.md | 6 +- js/WKWebView.ios.js | 36 +++ js/WebView.android.js | 3 +- js/WebView.ios.js | 8 +- js/shims/DeprecatedViewPropTypes.js | 409 ++++++++++++++++++++++++++++ js/shims/ViewAccessibility.js | 55 ++++ js/shims/deprecatedPropType.js | 34 +++ package.json | 4 +- 9 files changed, 567 insertions(+), 9 deletions(-) create mode 100644 LICENSE create mode 100644 js/WKWebView.ios.js create mode 100644 js/shims/DeprecatedViewPropTypes.js create mode 100644 js/shims/ViewAccessibility.js create mode 100644 js/shims/deprecatedPropType.js diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9e05101 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2015-present, Facebook, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 39a1764..374432e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # React Native WebView - a Modern, Cross-Platform WebView for React Native -**React Native WebView** is a modern, well-supported, and cross-platform (even Windows!) WebView for React Native. It is intended to be a replacement for the built-in WebView (which may be [removed from core](https://github.com/react-native-community/discussions-and-proposals/pull/3)). +**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](https://github.com/react-native-community/discussions-and-proposals/pull/3)). ## Platforms Supported @@ -49,6 +49,10 @@ Simply install React Native WebView and then use it in place of the core WebView _Guide coming soon_ +### Contributor Notes + +* I'm currently shimming `ViewAccessibility`, `deprecatedPropType`, and `DeprecatedViewPropTypes` because I'm building my test app for React Native 0.56.0. If I upgrade to a version that exports these and we agree to only support that version going forward, then I'll remove them and pull in from React Native core. You can find these shims in `./js/shims`. + ## Maintainers * [Jamon Holmgren](https://github.com/jamonholmgren) ([Twitter](https://twitter.com/jamonholmgren)) from [Infinite Red](https://infinite.red/react-native) diff --git a/js/WKWebView.ios.js b/js/WKWebView.ios.js new file mode 100644 index 0000000..ebf0edb --- /dev/null +++ b/js/WKWebView.ios.js @@ -0,0 +1,36 @@ +/** + * 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 + * @providesModule WKWebView + */ + +import React from 'react'; + +import { requireNativeComponent } from 'react-native'; + +const RCTWKWebView = requireNativeComponent('RCTWKWebView'); + +class WKWebView extends React.Component { + componentWillReceiveProps(nextProps) { + this.showRedboxOnPropChanges(nextProps, 'allowsInlineMediaPlayback'); + this.showRedboxOnPropChanges(nextProps, 'mediaPlaybackRequiresUserAction'); + this.showRedboxOnPropChanges(nextProps, 'dataDetectorTypes'); + } + + showRedboxOnPropChanges(nextProps, propName) { + if (this.props[propName] !== nextProps[propName]) { + console.error(`Changes to property ${propName} do nothing after the initial render.`); + } + } + + render() { + return ; + } +} + +module.exports = WKWebView; diff --git a/js/WebView.android.js b/js/WebView.android.js index 0bf0461..99b12d7 100644 --- a/js/WebView.android.js +++ b/js/WebView.android.js @@ -24,7 +24,8 @@ import { requireNativeComponent } from 'react-native'; -import deprecatedPropType from 'deprecated-prop-type'; +import deprecatedPropType from './shims/deprecatedPropType'; +import DeprecatedViewPropTypes from './shims/DeprecatedViewPropTypes' import keyMirror from 'fbjs/lib/keyMirror'; import WebViewShared from './WebViewShared'; diff --git a/js/WebView.ios.js b/js/WebView.ios.js index 3e3b736..84f555b 100644 --- a/js/WebView.ios.js +++ b/js/WebView.ios.js @@ -22,7 +22,6 @@ import { Text, UIManager, View, - ViewPropTypes, requireNativeComponent, NativeModules, Image @@ -31,7 +30,8 @@ import { import invariant from 'fbjs/lib/invariant'; import keyMirror from 'fbjs/lib/keyMirror'; -import deprecatedPropType from 'deprecated-prop-type'; +import deprecatedPropType from './shims/deprecatedPropType'; +import DeprecatedViewPropTypes from './shims/DeprecatedViewPropTypes' import WebViewShared from './WebViewShared'; @@ -47,8 +47,8 @@ function processDecelerationRate(decelerationRate) { return decelerationRate; } - -const RNCWebViewManager = NativeModules.WebViewManager; +const RCTWebViewManager = NativeModules.WebViewManager; +const RCTWKWebViewManager = NativeModules.WKWebViewManager; const BGWASH = 'rgba(255,255,255,0.8)'; const RCT_WEBVIEW_REF = 'webview'; diff --git a/js/shims/DeprecatedViewPropTypes.js b/js/shims/DeprecatedViewPropTypes.js new file mode 100644 index 0000000..c4411cb --- /dev/null +++ b/js/shims/DeprecatedViewPropTypes.js @@ -0,0 +1,409 @@ +/** + * 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 { + EdgeInsetsPropType, + PlatformViewPropTypes, + // ViewStylePropTypes, + // StyleSheetPropType +} from 'react-native'; + +import PropTypes from 'prop-types'; + +import ViewAccessibility from './ViewAccessibility' + +const { + AccessibilityComponentTypes, + AccessibilityTraits, + AccessibilityRoles, + AccessibilityStates, +} = ViewAccessibility; + +// TODO: Figure out how to properly import StyleSheetPropType, or shim it +const stylePropType = PropTypes.object; // StyleSheetPropType(ViewStylePropTypes); + +module.exports = { + /** + * When `true`, indicates that the view is an accessibility element. + * By default, all the touchable elements are accessible. + * + * See http://facebook.github.io/react-native/docs/view.html#accessible + */ + accessible: PropTypes.bool, + + /** + * Overrides the text that's read by the screen reader when the user interacts + * with the element. By default, the label is constructed by traversing all + * the children and accumulating all the `Text` nodes separated by space. + * + * See http://facebook.github.io/react-native/docs/view.html#accessibilitylabel + */ + accessibilityLabel: PropTypes.node, + + /** + * An accessibility hint helps users understand what will happen when they perform + * an action on the accessibility element when that result is not obvious from the + * accessibility label. + * + * + * See http://facebook.github.io/react-native/docs/view.html#accessibilityHint + */ + accessibilityHint: PropTypes.string, + + /** + * Provides an array of custom actions available for accessibility. + * + * @platform ios + */ + accessibilityActions: PropTypes.arrayOf(PropTypes.string), + + /** + * Prevents view from being inverted if set to true and color inversion is turned on. + * + * @platform ios + */ + accessibilityIgnoresInvertColors: PropTypes.bool, + + /** + * Indicates to accessibility services to treat UI component like a + * native one. Works for Android only. + * + * @platform android + * + * See http://facebook.github.io/react-native/docs/view.html#accessibilitycomponenttype + */ + accessibilityComponentType: PropTypes.oneOf(AccessibilityComponentTypes), + + /** + * Indicates to accessibility services to treat UI component like a specific role. + */ + accessibilityRole: PropTypes.oneOf(AccessibilityRoles), + + /** + * Indicates to accessibility services that UI Component is in a specific State. + */ + accessibilityStates: PropTypes.arrayOf(PropTypes.oneOf(AccessibilityStates)), + /** + * Indicates to accessibility services whether the user should be notified + * when this view changes. Works for Android API >= 19 only. + * + * @platform android + * + * See http://facebook.github.io/react-native/docs/view.html#accessibilityliveregion + */ + accessibilityLiveRegion: PropTypes.oneOf(['none', 'polite', 'assertive']), + + /** + * Controls how view is important for accessibility which is if it + * fires accessibility events and if it is reported to accessibility services + * that query the screen. Works for Android only. + * + * @platform android + * + * See http://facebook.github.io/react-native/docs/view.html#importantforaccessibility + */ + importantForAccessibility: PropTypes.oneOf([ + 'auto', + 'yes', + 'no', + 'no-hide-descendants', + ]), + + /** + * Provides additional traits to screen reader. By default no traits are + * provided unless specified otherwise in element. + * + * You can provide one trait or an array of many traits. + * + * @platform ios + * + * See http://facebook.github.io/react-native/docs/view.html#accessibilitytraits + */ + accessibilityTraits: PropTypes.oneOfType([ + PropTypes.oneOf(AccessibilityTraits), + PropTypes.arrayOf(PropTypes.oneOf(AccessibilityTraits)), + ]), + + /** + * A value indicating whether VoiceOver should ignore the elements + * within views that are siblings of the receiver. + * Default is `false`. + * + * @platform ios + * + * See http://facebook.github.io/react-native/docs/view.html#accessibilityviewismodal + */ + accessibilityViewIsModal: PropTypes.bool, + + /** + * A value indicating whether the accessibility elements contained within + * this accessibility element are hidden. + * + * @platform ios + * + * See http://facebook.github.io/react-native/docs/view.html#accessibilityElementsHidden + */ + accessibilityElementsHidden: PropTypes.bool, + + /** + * When `accessible` is true, the system will try to invoke this function + * when the user performs an accessibility custom action. + * + * @platform ios + */ + onAccessibilityAction: PropTypes.func, + + /** + * When `accessible` is true, the system will try to invoke this function + * when the user performs accessibility tap gesture. + * + * See http://facebook.github.io/react-native/docs/view.html#onaccessibilitytap + */ + onAccessibilityTap: PropTypes.func, + + /** + * When `accessible` is `true`, the system will invoke this function when the + * user performs the magic tap gesture. + * + * See http://facebook.github.io/react-native/docs/view.html#onmagictap + */ + onMagicTap: PropTypes.func, + + /** + * Used to locate this view in end-to-end tests. + * + * > This disables the 'layout-only view removal' optimization for this view! + * + * See http://facebook.github.io/react-native/docs/view.html#testid + */ + testID: PropTypes.string, + + /** + * Used to locate this view from native classes. + * + * > This disables the 'layout-only view removal' optimization for this view! + * + * See http://facebook.github.io/react-native/docs/view.html#nativeid + */ + nativeID: PropTypes.string, + + /** + * For most touch interactions, you'll simply want to wrap your component in + * `TouchableHighlight` or `TouchableOpacity`. Check out `Touchable.js`, + * `ScrollResponder.js` and `ResponderEventPlugin.js` for more discussion. + */ + + /** + * The View is now responding for touch events. This is the time to highlight + * and show the user what is happening. + * + * `View.props.onResponderGrant: (event) => {}`, where `event` is a synthetic + * touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onrespondergrant + */ + onResponderGrant: PropTypes.func, + + /** + * The user is moving their finger. + * + * `View.props.onResponderMove: (event) => {}`, where `event` is a synthetic + * touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onrespondermove + */ + onResponderMove: PropTypes.func, + + /** + * Another responder is already active and will not release it to that `View` + * asking to be the responder. + * + * `View.props.onResponderReject: (event) => {}`, where `event` is a + * synthetic touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onresponderreject + */ + onResponderReject: PropTypes.func, + + /** + * Fired at the end of the touch. + * + * `View.props.onResponderRelease: (event) => {}`, where `event` is a + * synthetic touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onresponderrelease + */ + onResponderRelease: PropTypes.func, + + /** + * The responder has been taken from the `View`. Might be taken by other + * views after a call to `onResponderTerminationRequest`, or might be taken + * by the OS without asking (e.g., happens with control center/ notification + * center on iOS) + * + * `View.props.onResponderTerminate: (event) => {}`, where `event` is a + * synthetic touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onresponderterminate + */ + onResponderTerminate: PropTypes.func, + + /** + * Some other `View` wants to become responder and is asking this `View` to + * release its responder. Returning `true` allows its release. + * + * `View.props.onResponderTerminationRequest: (event) => {}`, where `event` + * is a synthetic touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onresponderterminationrequest + */ + onResponderTerminationRequest: PropTypes.func, + + /** + * Does this view want to become responder on the start of a touch? + * + * `View.props.onStartShouldSetResponder: (event) => [true | false]`, where + * `event` is a synthetic touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onstartshouldsetresponder + */ + onStartShouldSetResponder: PropTypes.func, + + /** + * If a parent `View` wants to prevent a child `View` from becoming responder + * on a touch start, it should have this handler which returns `true`. + * + * `View.props.onStartShouldSetResponderCapture: (event) => [true | false]`, + * where `event` is a synthetic touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onstartshouldsetrespondercapture + */ + onStartShouldSetResponderCapture: PropTypes.func, + + /** + * Does this view want to "claim" touch responsiveness? This is called for + * every touch move on the `View` when it is not the responder. + * + * `View.props.onMoveShouldSetResponder: (event) => [true | false]`, where + * `event` is a synthetic touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onmoveshouldsetresponder + */ + onMoveShouldSetResponder: PropTypes.func, + + /** + * If a parent `View` wants to prevent a child `View` from becoming responder + * on a move, it should have this handler which returns `true`. + * + * `View.props.onMoveShouldSetResponderCapture: (event) => [true | false]`, + * where `event` is a synthetic touch event as described above. + * + * See http://facebook.github.io/react-native/docs/view.html#onMoveShouldsetrespondercapture + */ + onMoveShouldSetResponderCapture: PropTypes.func, + + /** + * This defines how far a touch event can start away from the view. + * Typical interface guidelines recommend touch targets that are at least + * 30 - 40 points/density-independent pixels. + * + * > The touch area never extends past the parent view bounds and the Z-index + * > of sibling views always takes precedence if a touch hits two overlapping + * > views. + * + * See http://facebook.github.io/react-native/docs/view.html#hitslop + */ + hitSlop: EdgeInsetsPropType, + + /** + * Invoked on mount and layout changes with: + * + * `{nativeEvent: { layout: {x, y, width, height}}}` + * + * This event is fired immediately once the layout has been calculated, but + * the new layout may not yet be reflected on the screen at the time the + * event is received, especially if a layout animation is in progress. + * + * See http://facebook.github.io/react-native/docs/view.html#onlayout + */ + onLayout: PropTypes.func, + + /** + * Controls whether the `View` can be the target of touch events. + * + * See http://facebook.github.io/react-native/docs/view.html#pointerevents + */ + pointerEvents: PropTypes.oneOf(['box-none', 'none', 'box-only', 'auto']), + + /** + * See http://facebook.github.io/react-native/docs/style.html + */ + style: stylePropType, + + /** + * This is a special performance property exposed by `RCTView` and is useful + * for scrolling content when there are many subviews, most of which are + * offscreen. For this property to be effective, it must be applied to a + * view that contains many subviews that extend outside its bound. The + * subviews must also have `overflow: hidden`, as should the containing view + * (or one of its superviews). + * + * See http://facebook.github.io/react-native/docs/view.html#removeclippedsubviews + */ + removeClippedSubviews: PropTypes.bool, + + /** + * Whether this `View` should render itself (and all of its children) into a + * single hardware texture on the GPU. + * + * @platform android + * + * See http://facebook.github.io/react-native/docs/view.html#rendertohardwaretextureandroid + */ + renderToHardwareTextureAndroid: PropTypes.bool, + + /** + * Whether this `View` should be rendered as a bitmap before compositing. + * + * @platform ios + * + * See http://facebook.github.io/react-native/docs/view.html#shouldrasterizeios + */ + shouldRasterizeIOS: PropTypes.bool, + + /** + * Views that are only used to layout their children or otherwise don't draw + * anything may be automatically removed from the native hierarchy as an + * optimization. Set this property to `false` to disable this optimization and + * ensure that this `View` exists in the native view hierarchy. + * + * @platform android + * + * See http://facebook.github.io/react-native/docs/view.html#collapsable + */ + collapsable: PropTypes.bool, + + /** + * Whether this `View` needs to rendered offscreen and composited with an + * alpha in order to preserve 100% correct colors and blending behavior. + * + * @platform android + * + * See http://facebook.github.io/react-native/docs/view.html#needsoffscreenalphacompositing + */ + needsOffscreenAlphaCompositing: PropTypes.bool, + + /** + * Any additional platform-specific view prop types, or prop type overrides. + */ + ...PlatformViewPropTypes, +}; diff --git a/js/shims/ViewAccessibility.js b/js/shims/ViewAccessibility.js new file mode 100644 index 0000000..e4880dd --- /dev/null +++ b/js/shims/ViewAccessibility.js @@ -0,0 +1,55 @@ +/** + * 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 strict + */ + +'use strict'; + +module.exports = { + AccessibilityTraits: [ + 'none', + 'button', + 'link', + 'header', + 'search', + 'image', + 'selected', + 'plays', + 'key', + 'text', + 'summary', + 'disabled', + 'frequentUpdates', + 'startsMedia', + 'adjustable', + 'allowsDirectInteraction', + 'pageTurn', + ], + AccessibilityComponentTypes: [ + 'none', + 'button', + 'radiobutton_checked', + 'radiobutton_unchecked', + ], + // This must be kept in sync with the AccessibilityRolesMask in RCTViewManager.m + AccessibilityRoles: [ + 'none', + 'button', + 'link', + 'search', + 'image', + 'keyboardkey', + 'text', + 'adjustable', + 'imagebutton', + 'header', + 'summary', + ], + // This must be kept in sync with the AccessibilityStatesMask in RCTViewManager.m + AccessibilityStates: ['selected', 'disabled'], +}; diff --git a/js/shims/deprecatedPropType.js b/js/shims/deprecatedPropType.js new file mode 100644 index 0000000..74d99a6 --- /dev/null +++ b/js/shims/deprecatedPropType.js @@ -0,0 +1,34 @@ +/** + * 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 strict-local + */ + +'use strict'; + +import { UIManager } from 'react-native'; + +/** + * Adds a deprecation warning when the prop is used. + */ +function deprecatedPropType( + propType, + explanation, +) { + return function validate(props, propName, componentName, ...rest) { + // Don't warn for native components. + if (!UIManager[componentName] && props[propName] !== undefined) { + console.warn( + `\`${propName}\` supplied to \`${componentName}\` has been deprecated. ${explanation}`, + ); + } + + return propType(props, propName, componentName, ...rest); + }; +} + +module.exports = deprecatedPropType; diff --git a/package.json b/package.json index 853d9aa..f09c9bc 100644 --- a/package.json +++ b/package.json @@ -2,9 +2,7 @@ "name": "react-native-webview", "description": "React Native WebView component for iOS, Android, and Windows 10", "main": "index.js", - "authors": [ - "Jamon Holmgren " - ], + "author": "Jamon Holmgren ", "version": "0.0.1", "peerDependencies": { "react": "^16.0",