status-im/react-native-webview
2
0
Fork 0
mirror of https://github.com/status-im/react-native-webview.git synced 2025-02-20 16:08:52 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Thibault Malbranche 2018-10-13 01:03:00 +02:00
parent e7534c2b61
commit e8517bb638
1 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -2,20 +2,22 @@
**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)).
**Please note that this package is pre-release and not yet ready for production use.**
## Platforms Supported
* [x] iOS (both UIWebView and WKWebView)
* [x] Android
* [ ] Windows 10 (coming soon)
- [x] iOS (both UIWebView and WKWebView)
- [x] Android
- [ ] Windows 10 (coming soon)
## Versionning
If you need the exact same Webview as the one from react-native, please use version **2.0.0**.
_This package will then follow semver rules with the next releases._
## Getting Started
*Note: this is currently a work-in-progress and not yet published to NPM.*
```
$ npm install --save https://github.com/react-native-community/react-native-webview
$ yarn add react-native-webview
$ react-native link react-native-webview
```
@ -26,19 +28,19 @@ Read our [Getting Started Guide](./docs/Getting-Started.md) for more.
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'
import React, { Component } from 'react';
import { StyleSheet, Text, View } from 'react-native';
import { WebView } from 'react-native-webview';
// ...
class MyWebComponent extends Component {
render () {
render() {
return (
<WebView
source={{uri: "https://infinite.red/react-native"}}
style={{marginTop: 20}}
source={{ uri: 'https://infinite.red/react-native' }}
style={{ marginTop: 20 }}
/>
)
);
}
}
```
@ -51,19 +53,19 @@ Simply install React Native WebView and then use it in place of the core WebView
### Contributor Notes
* I've removed all PropTypes for now. Instead, we'll be using Flow types. TypeScript types will be added at a later date.
* UIWebView is not tested fully and you will encounter some yellow warning boxes. Since it is deprecated, we don't intend to put a lot of time into supporting it, but feel free to submit PRs if you have a special use case. Note that you will need to specify `useWebKit={false}` to use UIWebView
* After pulling this repo and installing all dependencies, you can run flow on iOS and Android-specific files using the commands:
* `yarn flow` or `npm run flow` for iOS
* `yarn flow-android` or `npm run flow-android` for Android
* If you want to add another React Native platform to this repository, you will need to create another `.flowconfig` for it. If your platform is `example`, copy the main flowconfig and rename it to `.flowconfig.example`. Then edit the config to ignore other platforms, and add `.*/*[.]example.js` to the ignore lists of the other platforms. Then add an entry to `package.json` like this:
* ` "flow-example": "flow check --flowconfig-name .flowconfig.example"`
* Currently you need to install React Native 0.57 to be able to test these types - `flow check` will not pass against 0.56.
- I've removed all PropTypes for now. Instead, we'll be using Flow types. TypeScript types will be added at a later date.
- UIWebView is not tested fully and you will encounter some yellow warning boxes. Since it is deprecated, we don't intend to put a lot of time into supporting it, but feel free to submit PRs if you have a special use case. Note that you will need to specify `useWebKit={false}` to use UIWebView
- After pulling this repo and installing all dependencies, you can run flow on iOS and Android-specific files using the commands:
- `yarn flow` or `npm run flow` for iOS
- `yarn flow-android` or `npm run flow-android` for Android
- If you want to add another React Native platform to this repository, you will need to create another `.flowconfig` for it. If your platform is `example`, copy the main flowconfig and rename it to `.flowconfig.example`. Then edit the config to ignore other platforms, and add `.*/*[.]example.js` to the ignore lists of the other platforms. Then add an entry to `package.json` like this:
- `"flow-example": "flow check --flowconfig-name .flowconfig.example"`
- Currently you need to install React Native 0.57 to be able to test these types - `flow check` will not pass against 0.56.
## Maintainers
* [Jamon Holmgren](https://github.com/jamonholmgren) ([Twitter @jamonholmgren](https://twitter.com/jamonholmgren)) from [Infinite Red](https://infinite.red/react-native)
* [Thibault Malbranche](https://github.com/Titozzz) ([Twitter @titozzz](https://twitter.com/titozzz)) from [Brigad](https://brigad.co/about)
- [Jamon Holmgren](https://github.com/jamonholmgren) ([Twitter @jamonholmgren](https://twitter.com/jamonholmgren)) from [Infinite Red](https://infinite.red/react-native)
- [Thibault Malbranche](https://github.com/Titozzz) ([Twitter @titozzz](https://twitter.com/titozzz)) from [Brigad](https://brigad.co/about)
## License