Gaëtan Renaudeau c421819913 Merge pull request #69 from shahen94/master | il y a 7 ans | |
---|---|---|
android | il y a 7 ans | |
ios | il y a 7 ans | |
windows | il y a 7 ans | |
.flowconfig | il y a 8 ans | |
.gitignore | il y a 8 ans | |
LICENSE | il y a 8 ans | |
README.md | il y a 7 ans | |
index.js | il y a 7 ans | |
jsconfig.json | il y a 7 ans | |
package.json | il y a 7 ans |
Capture a React Native view to an image.
iOS: For React Native version between
0.30.x
and0.39.x
, you should usereact-native-view-shot@1.5.1
.
import { takeSnapshot } from "react-native-view-shot";
takeSnapshot(viewRef, {
format: "jpeg",
quality: 0.8
})
.then(
uri => console.log("Image saved to", uri),
error => console.error("Oops, snapshot failed", error)
);
Checkout react-native-view-shot-example
takeSnapshot(view, options)
Returns a Promise of the image URI.
view
is a reference to a React Native component.options
may include:
width
/ height
(number): the width and height of the final image (resized from the View bound. don’t provide it if you want the original pixel size).format
(string): either png
or jpg
/jpeg
or webm
(Android). Defaults to png
.quality
(number): the quality. 0.0 - 1.0 (default). (only available on lossy formats like jpeg)result
(string), the method you want to use to save the snapshot, one of:"file"
(default): save to a temporary file (that will only exist for as long as the app is running)."base64"
: encode as base64 and returns the raw string. Use only with small images as this may result of lags (the string is sent over the bridge). N.B. This is not a data uri, use data-uri
instead."data-uri"
: same as base64
but also includes the Data URI scheme header.path
(string): The absolute path where the file get generated. Read below before using it!snapshotContentContainer
(bool): if true and when view is a ScrollView, the “content container” height will be evaluated instead of the container height.path
option and dirs
constantsIMPORTANT: We might actually drop the path feature because of its complexity in the current codebase (and bugs that are not fixed), please consider using react-native-view-shot with https://github.com/itinance/react-native-fs to solve this.
By default, takeSnapshot will export in a temporary folder and the snapshot file will be deleted as soon as the app leaves.
But if you use the path
option, you make the snapshot file more permanent and at a specific file location. it is up to you to manage the image file lifecycle, the library won’t clean it for you (which might result of leaking files on user’s phone if you are not careful). There is also no guarantee the file will be successfully saved: you can reach permissions problem, this also is platform specific.
If you still want to do this, we expose a few somewhat universal “constants” to ease the work.
import { takeSnapshot, dirs } from "react-native-view-shot";
// cross platform dirs:
const { CacheDir, DocumentDir, MainBundleDir, MovieDir, MusicDir, PictureDir } = dirs;
// only available Android:
const { DCIMDir, DownloadDir, RingtoneDir, SDCardDir } = dirs;
takeSnapshot(viewRef, { path: PictureDir+"/foo.png" })
.then(
uri => console.log("Image saved to", uri),
error => console.error("Oops, snapshot failed", error)
);
Model tested: iPhone 6 (iOS), Nexus 5 (Android).
System | iOS | Android | Windows |
---|---|---|---|
View,Text,Image,.. | YES | YES | YES |
WebView | YES | YES1 | YES |
gl-react v2 | YES | NO2 | NO3 |
react-native-video | NO | NO | NO |
react-native-maps | YES | NO4 | NO3 |
- Only supported by wrapping a
<View collapsable={false}>
parent and snapshotting it.- It returns an empty image (not a failure Promise).
- Component itself lacks platform support.
- But you can just use the react-native-maps snapshot function: https://github.com/airbnb/react-native-maps#take-snapshot-of-map
Snapshots are not guaranteed to be pixel perfect. It also depends on the platform. Here is some difference we have noticed and how to workaround.
takeSnapshot
promise gets rejected (the library won’t crash).collapsable
is set to false
if you want to snapshot a View. Some content might even need to be wrapped into such <View collapsable={false}>
to actually make them snapshotable! Otherwise that view won’t reflect any UI View. (found by @gaguirre)Uri
. (the file
result returns an Uri
so it’s consistent with iOS and can be given to APIs like Image.getSize
)npm install --save react-native-view-shot
react-native link react-native-view-shot
Libraries
➜ Add Files to [your project's name]
node_modules
➜ react-native-view-shot
and add RNViewShot.xcodeproj
libRNViewShot.a
to your project’s Build Phases
➜ Link Binary With Libraries
Cmd+R
)<android/app/src/main/java/[...]/MainActivity.java
import fr.greweb.reactnativeviewshot.RNViewShotPackage;
to the imports at the top of the filenew RNViewShotPackage()
to the list returned by the getPackages()
methodandroid/settings.gradle
:
include ':react-native-view-shot'
project(':react-native-view-shot').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-view-shot/android')
android/app/build.gradle
:
compile project(':react-native-view-shot')
Add
➜ ExisitingProject
node_modules
➜ react-native-view-shot
and add RNViewShot.csproj
(UWP) or optionally RNViewShot.Net46.csproj
(WPF)Add
➜ Reference
RNViewShot
(UWP) or RNViewShot.Net46
(WPF)