|
@@ -0,0 +1,58 @@
|
|
1
|
+# Infinite Red WebView - a Modern, Cross-Platform WebView for React Native
|
|
2
|
+
|
|
3
|
+**Infinite Red 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)).
|
|
4
|
+
|
|
5
|
+## Platforms Supported
|
|
6
|
+
|
|
7
|
+* [x] iOS
|
|
8
|
+* [x] Android
|
|
9
|
+* [ ] Windows 10 (coming soon)
|
|
10
|
+
|
|
11
|
+## Installation
|
|
12
|
+
|
|
13
|
+```
|
|
14
|
+$ npm install --save ir-webview
|
|
15
|
+$ react-native link ir-webview
|
|
16
|
+```
|
|
17
|
+
|
|
18
|
+## Usage
|
|
19
|
+
|
|
20
|
+Import the `WebView` component from `ir-webview` and use it like so:
|
|
21
|
+
|
|
22
|
+```jsx
|
|
23
|
+import React, { Component } from 'react'
|
|
24
|
+import { StyleSheet, Text, View } from 'react-native'
|
|
25
|
+import { WebView } from 'ir-webview'
|
|
26
|
+
|
|
27
|
+// ...
|
|
28
|
+class MyWebComponent extends Component {
|
|
29
|
+ render () {
|
|
30
|
+ return (
|
|
31
|
+ <WebView
|
|
32
|
+ src={{uri: "https://infinite.red"}}
|
|
33
|
+ style={{marginTop: 20}}
|
|
34
|
+ />
|
|
35
|
+ )
|
|
36
|
+ }
|
|
37
|
+}
|
|
38
|
+```
|
|
39
|
+
|
|
40
|
+Additional properties are supported and will be added here; for now, refer to the previous React Native WebView documentation for more.
|
|
41
|
+
|
|
42
|
+[https://facebook.github.io/react-native/docs/webview](https://facebook.github.io/react-native/docs/webview)
|
|
43
|
+
|
|
44
|
+## Migrate from React Native core WebView to Infinite Red WebView
|
|
45
|
+
|
|
46
|
+Simply install Infinite Red WebView and then use it in place of the core WebView. Their APIs are currently identical.
|
|
47
|
+
|
|
48
|
+## Contributing
|
|
49
|
+
|
|
50
|
+_Guide coming soon_
|
|
51
|
+
|
|
52
|
+## Maintainers
|
|
53
|
+
|
|
54
|
+* [Jamon Holmgren](https://github.com/jamonholmgren) ([Twitter](https://twitter.com/jamonholmgren)) from [Infinite Red](https://infinite.red/react-native)
|
|
55
|
+
|
|
56
|
+## License
|
|
57
|
+
|
|
58
|
+MIT
|