Keine Beschreibung

WebView.ios.js 13KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496
  1. /**
  2. * Copyright (c) 2015-present, Facebook, Inc.
  3. *
  4. * This source code is licensed under the MIT license found in the
  5. * LICENSE file in the root directory of this source tree.
  6. *
  7. * @format
  8. * @flow
  9. */
  10. import React from 'react';
  11. import {
  12. ActivityIndicator,
  13. Linking,
  14. StyleSheet,
  15. Text,
  16. UIManager,
  17. View,
  18. requireNativeComponent,
  19. NativeModules,
  20. Image,
  21. findNodeHandle,
  22. } from 'react-native';
  23. import invariant from 'fbjs/lib/invariant';
  24. import keyMirror from 'fbjs/lib/keyMirror';
  25. import WebViewShared from './WebViewShared';
  26. import type {
  27. WebViewEvent,
  28. WebViewError,
  29. WebViewErrorEvent,
  30. WebViewMessageEvent,
  31. WebViewNavigationEvent,
  32. WebViewSharedProps,
  33. WebViewSource,
  34. WebViewProgressEvent,
  35. } from './WebViewTypes';
  36. const resolveAssetSource = Image.resolveAssetSource;
  37. // Imported from https://github.com/facebook/react-native/blob/master/Libraries/Components/ScrollView/processDecelerationRate.js
  38. function processDecelerationRate(decelerationRate) {
  39. if (decelerationRate === 'normal') {
  40. decelerationRate = 0.998;
  41. } else if (decelerationRate === 'fast') {
  42. decelerationRate = 0.99;
  43. }
  44. return decelerationRate;
  45. }
  46. const RNCUIWebViewManager = NativeModules.RNCUIWebViewManager;
  47. const RNCWKWebViewManager = NativeModules.RNCWKWebViewManager;
  48. const BGWASH = 'rgba(255,255,255,0.8)';
  49. const WebViewState = keyMirror({
  50. IDLE: null,
  51. LOADING: null,
  52. ERROR: null,
  53. });
  54. const NavigationType = keyMirror({
  55. click: true,
  56. formsubmit: true,
  57. backforward: true,
  58. reload: true,
  59. formresubmit: true,
  60. other: true,
  61. });
  62. const JSNavigationScheme = 'react-js-navigation';
  63. type State = {|
  64. viewState: WebViewState,
  65. lastErrorEvent: ?WebViewError,
  66. |};
  67. const DataDetectorTypes = [
  68. 'phoneNumber',
  69. 'link',
  70. 'address',
  71. 'calendarEvent',
  72. 'trackingNumber',
  73. 'flightNumber',
  74. 'lookupSuggestion',
  75. 'none',
  76. 'all',
  77. ];
  78. const defaultRenderLoading = () => (
  79. <View style={styles.loadingView}>
  80. <ActivityIndicator />
  81. </View>
  82. );
  83. const defaultRenderError = (errorDomain, errorCode, errorDesc) => (
  84. <View style={styles.errorContainer}>
  85. <Text style={styles.errorTextTitle}>Error loading page</Text>
  86. <Text style={styles.errorText}>{'Domain: ' + errorDomain}</Text>
  87. <Text style={styles.errorText}>{'Error Code: ' + errorCode}</Text>
  88. <Text style={styles.errorText}>{'Description: ' + errorDesc}</Text>
  89. </View>
  90. );
  91. /**
  92. * `WebView` renders web content in a native view.
  93. *
  94. *```
  95. * import React, { Component } from 'react';
  96. * import { WebView } from 'react-native';
  97. *
  98. * class MyWeb extends Component {
  99. * render() {
  100. * return (
  101. * <WebView
  102. * source={{uri: 'https://github.com/facebook/react-native'}}
  103. * style={{marginTop: 20}}
  104. * />
  105. * );
  106. * }
  107. * }
  108. *```
  109. *
  110. * You can use this component to navigate back and forth in the web view's
  111. * history and configure various properties for the web content.
  112. */
  113. class WebView extends React.Component<WebViewSharedProps, State> {
  114. static JSNavigationScheme = JSNavigationScheme;
  115. static NavigationType = NavigationType;
  116. static defaultProps = {
  117. useWebKit: true,
  118. originWhitelist: WebViewShared.defaultOriginWhitelist,
  119. };
  120. state = {
  121. viewState: this.props.startInLoadingState
  122. ? WebViewState.LOADING
  123. : WebViewState.IDLE,
  124. lastErrorEvent: null,
  125. };
  126. webViewRef = React.createRef();
  127. UNSAFE_componentWillMount() {
  128. if (
  129. this.props.useWebKit === true &&
  130. this.props.scalesPageToFit !== undefined
  131. ) {
  132. console.warn(
  133. 'The scalesPageToFit property is not supported when useWebKit = true',
  134. );
  135. }
  136. }
  137. render() {
  138. let otherView = null;
  139. let scalesPageToFit;
  140. if (this.props.useWebKit) {
  141. ({ scalesPageToFit } = this.props);
  142. } else {
  143. ({ scalesPageToFit = true } = this.props);
  144. }
  145. if (this.state.viewState === WebViewState.LOADING) {
  146. otherView = (this.props.renderLoading || defaultRenderLoading)();
  147. } else if (this.state.viewState === WebViewState.ERROR) {
  148. const errorEvent = this.state.lastErrorEvent;
  149. invariant(errorEvent != null, 'lastErrorEvent expected to be non-null');
  150. otherView = (this.props.renderError || defaultRenderError)(
  151. errorEvent.domain,
  152. errorEvent.code,
  153. errorEvent.description,
  154. );
  155. } else if (this.state.viewState !== WebViewState.IDLE) {
  156. console.error(
  157. 'RNCWebView invalid state encountered: ' + this.state.viewState,
  158. );
  159. }
  160. const webViewStyles = [styles.container, styles.webView, this.props.style];
  161. if (
  162. this.state.viewState === WebViewState.LOADING ||
  163. this.state.viewState === WebViewState.ERROR
  164. ) {
  165. // if we're in either LOADING or ERROR states, don't show the webView
  166. webViewStyles.push(styles.hidden);
  167. }
  168. const nativeConfig = this.props.nativeConfig || {};
  169. let viewManager = nativeConfig.viewManager;
  170. if (this.props.useWebKit) {
  171. viewManager = viewManager || RNCWKWebViewManager;
  172. } else {
  173. viewManager = viewManager || RNCUIWebViewManager;
  174. }
  175. const compiledWhitelist = [
  176. 'about:blank',
  177. ...(this.props.originWhitelist || []),
  178. ].map(WebViewShared.originWhitelistToRegex);
  179. const onShouldStartLoadWithRequest = event => {
  180. let shouldStart = true;
  181. const { url } = event.nativeEvent;
  182. const origin = WebViewShared.extractOrigin(url);
  183. const passesWhitelist = compiledWhitelist.some(x =>
  184. new RegExp(x).test(origin),
  185. );
  186. shouldStart = shouldStart && passesWhitelist;
  187. if (!passesWhitelist) {
  188. Linking.openURL(url);
  189. }
  190. if (this.props.onShouldStartLoadWithRequest) {
  191. shouldStart =
  192. shouldStart &&
  193. this.props.onShouldStartLoadWithRequest(event.nativeEvent);
  194. }
  195. invariant(viewManager != null, 'viewManager expected to be non-null');
  196. viewManager.startLoadWithResult(
  197. !!shouldStart,
  198. event.nativeEvent.lockIdentifier,
  199. );
  200. };
  201. const decelerationRate = processDecelerationRate(
  202. this.props.decelerationRate,
  203. );
  204. let source: WebViewSource = this.props.source || {};
  205. if (!this.props.source && this.props.html) {
  206. source = { html: this.props.html };
  207. } else if (!this.props.source && this.props.url) {
  208. source = { uri: this.props.url };
  209. }
  210. const messagingEnabled = typeof this.props.onMessage === 'function';
  211. let NativeWebView = nativeConfig.component;
  212. if (this.props.useWebKit) {
  213. NativeWebView = NativeWebView || RNCWKWebView;
  214. } else {
  215. NativeWebView = NativeWebView || RNCUIWebView;
  216. }
  217. const webView = (
  218. <NativeWebView
  219. ref={this.webViewRef}
  220. key="webViewKey"
  221. style={webViewStyles}
  222. source={resolveAssetSource(source)}
  223. injectedJavaScript={this.props.injectedJavaScript}
  224. bounces={this.props.bounces}
  225. scrollEnabled={this.props.scrollEnabled}
  226. decelerationRate={decelerationRate}
  227. contentInset={this.props.contentInset}
  228. automaticallyAdjustContentInsets={
  229. this.props.automaticallyAdjustContentInsets
  230. }
  231. hideKeyboardAccessoryView={this.props.hideKeyboardAccessoryView}
  232. onLoadingStart={this._onLoadingStart}
  233. onLoadingFinish={this._onLoadingFinish}
  234. onLoadingError={this._onLoadingError}
  235. onLoadingProgress={this._onLoadingProgress}
  236. messagingEnabled={messagingEnabled}
  237. onMessage={this._onMessage}
  238. onShouldStartLoadWithRequest={onShouldStartLoadWithRequest}
  239. scalesPageToFit={scalesPageToFit}
  240. allowsInlineMediaPlayback={this.props.allowsInlineMediaPlayback}
  241. mediaPlaybackRequiresUserAction={
  242. this.props.mediaPlaybackRequiresUserAction
  243. }
  244. dataDetectorTypes={this.props.dataDetectorTypes}
  245. {...nativeConfig.props}
  246. />
  247. );
  248. return (
  249. <View style={styles.container}>
  250. {webView}
  251. {otherView}
  252. </View>
  253. );
  254. }
  255. _getCommands() {
  256. if (!this.props.useWebKit) {
  257. return UIManager.RNCUIWebView.Commands;
  258. }
  259. return UIManager.RNCWKWebView.Commands;
  260. }
  261. /**
  262. * Go forward one page in the web view's history.
  263. */
  264. goForward = () => {
  265. UIManager.dispatchViewManagerCommand(
  266. this.getWebViewHandle(),
  267. this._getCommands().goForward,
  268. null,
  269. );
  270. };
  271. /**
  272. * Go back one page in the web view's history.
  273. */
  274. goBack = () => {
  275. UIManager.dispatchViewManagerCommand(
  276. this.getWebViewHandle(),
  277. this._getCommands().goBack,
  278. null,
  279. );
  280. };
  281. /**
  282. * Reloads the current page.
  283. */
  284. reload = () => {
  285. this.setState({ viewState: WebViewState.LOADING });
  286. UIManager.dispatchViewManagerCommand(
  287. this.getWebViewHandle(),
  288. this._getCommands().reload,
  289. null,
  290. );
  291. };
  292. /**
  293. * Stop loading the current page.
  294. */
  295. stopLoading = () => {
  296. UIManager.dispatchViewManagerCommand(
  297. this.getWebViewHandle(),
  298. this._getCommands().stopLoading,
  299. null,
  300. );
  301. };
  302. /**
  303. * Posts a message to the web view, which will emit a `message` event.
  304. * Accepts one argument, `data`, which must be a string.
  305. *
  306. * In your webview, you'll need to something like the following.
  307. *
  308. * ```js
  309. * document.addEventListener('message', e => { document.title = e.data; });
  310. * ```
  311. */
  312. postMessage = (data: string) => {
  313. UIManager.dispatchViewManagerCommand(
  314. this.getWebViewHandle(),
  315. this._getCommands().postMessage,
  316. [String(data)],
  317. );
  318. };
  319. /**
  320. * Injects a javascript string into the referenced WebView. Deliberately does not
  321. * return a response because using eval() to return a response breaks this method
  322. * on pages with a Content Security Policy that disallows eval(). If you need that
  323. * functionality, look into postMessage/onMessage.
  324. */
  325. injectJavaScript = (data: string) => {
  326. UIManager.dispatchViewManagerCommand(
  327. this.getWebViewHandle(),
  328. this._getCommands().injectJavaScript,
  329. [data],
  330. );
  331. };
  332. /**
  333. * We return an event with a bunch of fields including:
  334. * url, title, loading, canGoBack, canGoForward
  335. */
  336. _updateNavigationState = (event: WebViewNavigationEvent) => {
  337. if (this.props.onNavigationStateChange) {
  338. this.props.onNavigationStateChange(event.nativeEvent);
  339. }
  340. };
  341. /**
  342. * Returns the native `WebView` node.
  343. */
  344. getWebViewHandle = () => {
  345. return findNodeHandle(this.webViewRef.current);
  346. };
  347. _onLoadingStart = (event: WebViewNavigationEvent) => {
  348. const onLoadStart = this.props.onLoadStart;
  349. onLoadStart && onLoadStart(event);
  350. this._updateNavigationState(event);
  351. };
  352. _onLoadingError = (event: WebViewErrorEvent) => {
  353. event.persist(); // persist this event because we need to store it
  354. const { onError, onLoadEnd } = this.props;
  355. onError && onError(event);
  356. onLoadEnd && onLoadEnd(event);
  357. console.warn('Encountered an error loading page', event.nativeEvent);
  358. this.setState({
  359. lastErrorEvent: event.nativeEvent,
  360. viewState: WebViewState.ERROR,
  361. });
  362. };
  363. _onLoadingFinish = (event: WebViewNavigationEvent) => {
  364. const { onLoad, onLoadEnd } = this.props;
  365. onLoad && onLoad(event);
  366. onLoadEnd && onLoadEnd(event);
  367. this.setState({
  368. viewState: WebViewState.IDLE,
  369. });
  370. this._updateNavigationState(event);
  371. };
  372. _onMessage = (event: WebViewMessageEvent) => {
  373. const { onMessage } = this.props;
  374. onMessage && onMessage(event);
  375. };
  376. _onLoadingProgress = (event: WebViewProgressEvent) => {
  377. const {onLoadProgress} = this.props;
  378. onLoadProgress && onLoadProgress(event);
  379. }
  380. componentDidUpdate(prevProps: WebViewSharedProps) {
  381. if (!(prevProps.useWebKit && this.props.useWebKit)) {
  382. return;
  383. }
  384. this._showRedboxOnPropChanges(prevProps, 'allowsInlineMediaPlayback');
  385. this._showRedboxOnPropChanges(prevProps, 'mediaPlaybackRequiresUserAction');
  386. this._showRedboxOnPropChanges(prevProps, 'dataDetectorTypes');
  387. if (this.props.scalesPageToFit !== undefined) {
  388. console.warn(
  389. 'The scalesPageToFit property is not supported when useWebKit = true',
  390. );
  391. }
  392. }
  393. _showRedboxOnPropChanges(prevProps, propName: string) {
  394. if (this.props[propName] !== prevProps[propName]) {
  395. console.error(
  396. `Changes to property ${propName} do nothing after the initial render.`,
  397. );
  398. }
  399. }
  400. }
  401. const RNCUIWebView = requireNativeComponent('RNCUIWebView');
  402. const RNCWKWebView = requireNativeComponent('RNCWKWebView');
  403. const styles = StyleSheet.create({
  404. container: {
  405. flex: 1,
  406. },
  407. errorContainer: {
  408. flex: 1,
  409. justifyContent: 'center',
  410. alignItems: 'center',
  411. backgroundColor: BGWASH,
  412. },
  413. errorText: {
  414. fontSize: 14,
  415. textAlign: 'center',
  416. marginBottom: 2,
  417. },
  418. errorTextTitle: {
  419. fontSize: 15,
  420. fontWeight: '500',
  421. marginBottom: 10,
  422. },
  423. hidden: {
  424. height: 0,
  425. flex: 0, // disable 'flex:1' when hiding a View
  426. },
  427. loadingView: {
  428. backgroundColor: BGWASH,
  429. flex: 1,
  430. justifyContent: 'center',
  431. alignItems: 'center',
  432. height: 100,
  433. },
  434. webView: {
  435. backgroundColor: '#ffffff',
  436. },
  437. });
  438. module.exports = WebView;