react-native-webview/README.md

59 lines
1.6 KiB
Markdown
Raw Normal View History

# React Native WebView - a Modern, Cross-Platform WebView for React Native
2018-08-13 04:52:47 +00:00
**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)).
2018-08-13 04:52:47 +00:00
## Platforms Supported
* [x] iOS
* [x] Android
* [ ] Windows 10 (coming soon)
## Installation
```
$ npm install --save react-native-webview
$ react-native link react-native-webview
2018-08-13 04:52:47 +00:00
```
## Usage
Import the `WebView` component from `react-native-webview` and use it like so:
2018-08-13 04:52:47 +00:00
```jsx
import React, { Component } from 'react'
import { StyleSheet, Text, View } from 'react-native'
import { WebView } from 'react-native-webview'
2018-08-13 04:52:47 +00:00
// ...
class MyWebComponent extends Component {
render () {
return (
<WebView
src={{uri: "https://infinite.red"}}
style={{marginTop: 20}}
/>
)
}
}
```
Additional properties are supported and will be added here; for now, refer to the previous React Native WebView documentation for more.
[https://facebook.github.io/react-native/docs/webview](https://facebook.github.io/react-native/docs/webview)
## Migrate from React Native core WebView to React Native WebView
2018-08-13 04:52:47 +00:00
Simply install React Native WebView and then use it in place of the core WebView. Their APIs are currently identical.
2018-08-13 04:52:47 +00:00
## Contributing
_Guide coming soon_
## Maintainers
* [Jamon Holmgren](https://github.com/jamonholmgren) ([Twitter](https://twitter.com/jamonholmgren)) from [Infinite Red](https://infinite.red/react-native)
## License
MIT