mirror of
https://github.com/status-im/react-native-webview.git
synced 2025-02-22 08:48:39 +00:00
63 lines
2.0 KiB
Markdown
63 lines
2.0 KiB
Markdown
# React Native WebView - a Modern, Cross-Platform WebView for React Native
|
|
|
|
**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
|
|
|
|
* [x] iOS
|
|
* [x] Android
|
|
* [ ] Windows 10 (coming soon)
|
|
|
|
## Installation
|
|
|
|
```
|
|
$ npm install --save react-native-webview
|
|
$ react-native link react-native-webview
|
|
```
|
|
|
|
## Usage
|
|
|
|
Import the `WebView` component from `react-native-webview` and use it like so:
|
|
|
|
```jsx
|
|
import React, { Component } from 'react'
|
|
import { StyleSheet, Text, View } from 'react-native'
|
|
import { WebView } from 'react-native-webview'
|
|
|
|
// ...
|
|
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
|
|
|
|
Simply install React Native WebView and then use it in place of the core WebView. Their APIs are currently identical.
|
|
|
|
## Contributing
|
|
|
|
_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)
|
|
|
|
## License
|
|
|
|
MIT
|