Update README.md
This commit is contained in:
parent
0fe45de879
commit
a4c6f210cf
15
README.md
15
README.md
|
@ -11,7 +11,6 @@ _Garrett McCullough, mobile engineer at Virta Health_
|
|||
|
||||
- [x] iOS (both UIWebView and WKWebView)
|
||||
- [x] Android
|
||||
- [ ] Windows 10 (coming soon)
|
||||
|
||||
_Note: React Native WebView is not currently supported by Expo unless you "eject"._
|
||||
|
||||
|
@ -19,6 +18,8 @@ _Note: React Native WebView is not currently supported by Expo unless you "eject
|
|||
|
||||
If you need the exact same WebView as the one from react-native, please use version **2.0.0**. Future versions will follow [semantic versioning](https://semver.org/).
|
||||
|
||||
Please note that version >= 5.0.3 only support **react-native >=0.58**
|
||||
|
||||
## Getting Started
|
||||
|
||||
```
|
||||
|
@ -44,7 +45,6 @@ class MyWebComponent extends Component {
|
|||
<WebView
|
||||
source={{ uri: "https://infinite.red/react-native" }}
|
||||
style={{ marginTop: 20 }}
|
||||
onLoadProgress={e => console.log(e.nativeEvent.progress)}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
@ -61,16 +61,9 @@ Simply install React Native WebView and then use it in place of the core WebView
|
|||
|
||||
- If you're getting `Invariant Violation: Native component for "RNCWKWebView does not exist"` it likely means you forgot to run `react-native link` or there was some error with the linking process
|
||||
|
||||
### Contributor Notes
|
||||
## Contributing
|
||||
|
||||
- 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 test:ios:flow` for iOS
|
||||
- `yarn test:android:flow` 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:
|
||||
- `"test:example:flow": "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.
|
||||
See [Contributing.md](https://github.com/react-native-community/react-native-webview/blob/master/docs/Contributing.md)
|
||||
|
||||
## Maintainers
|
||||
|
||||
|
|
Loading…
Reference in New Issue