carefrees-react-native-webview-x5
v0.2.3
Published
React Native WebView component for iOS, Android, macOS, and Windows
Downloads
13
Readme
React Native WebView
React Native WebView is a community maintained WebView component for React Native. It is intended to be a replacement for the built-in WebView (which was removed from core).
Maintainers
Many thanks to these companies for providing us with time to work on open source.
Please note that maintainers spend a lot of free time working on this too so feel free to sponsor them, it really makes a difference.
Windows and macOS are managed by Microsoft, notably:
- Alexander Sklar (Twitter @alexsklar) from React Native for Windows
- Chiara Mooney from React Native for Windows @ Microsoft
Shout-out to Jamon Holmgren from Infinite Red for helping a lot with the repo when he had more available time.
Disclaimer
Maintaining WebView is very complex, because it is often used for many different usecases (rendering svgs, pdfs, login flows, and much more). We also support many platforms and both architecture of react-native.
Since WebView was extracted from React Native core, nearly 500 pull requests have been merged.
Considering that we have limited time, issues will mostly serve as a discussion place for the community, while we will prioritize reviewing and merging pull requests.
Platform compatibility
This project is compatible with iOS, Android, Windows and macOS.
This project support both the old (paper) and the new architecture (fabric).
This project is compatible with expo.
Getting Started
Read our Getting Started Guide. If any step seems unclear, please create a pull request.
Versioning
This project follows semantic versioning. We do not hesitate to release breaking changes but they will be in a major version.
Usage
Import the WebView
component from react-native-webview
and use it like so:
import React, { Component } from 'react';
import { StyleSheet, Text, View } from 'react-native';
import { WebView } from 'react-native-webview';
// ...
const MyWebComponent = () => {
return <WebView source={{ uri: 'https://reactnative.dev/' }} style={{ flex: 1 }} />;
}
For more, read the API Reference and Guide. If you're interested in contributing, check out the Contributing Guide.
Common issues
- If you're getting
Invariant Violation: Native component for "RNCCarefreesWebView does not exist"
it likely means you forgot to runreact-native link
or there was some error with the linking process - If you encounter a build error during the task
:app:mergeDexRelease
, you need to enable multidex support inandroid/app/build.gradle
as discussed in this issue
Contributing
Contributions are welcome, see Contributing.md
License
MIT
Translations
This readme is available in: