Releases: gre/react-native-view-shot
Releases · gre/react-native-view-shot
v2.3.0
v2.2.0
v2.1.1
v2.1.0
v2.0.0
New ViewShot component, drop deprecated options, rename APIs
ViewShotis a React Component that you can use to snapshot anything, it is now the recommended way to use the library. It have different usages for different usecases, refer the README.
The simplest way to use it:
<ViewShot captureMode="mount" onCapture={uri => console.log("do something with ", uri)}> ...something to capture </ViewShot>ViewShot renders a View to wrap the children, this allows to hide complexity of using the library for Android (for some components you need to have a wrapping
View collapsable={false}for the lib to work. Using ViewShot, you no longer have to worry about this)
But you can still use the library with the imperative API:
takeSnapshot(viewRef, options)function was renamed tocaptureRef(viewRef, options)releaseCapture(uri)is a new function that accept an uri created with takeSnapshot and remove the tmpfile
Options changes
- the
resultoption "file" was renamed to "tmpfile" - the
formatoption "jpeg" is dropped, simply use "jpg" (there used to be both supported) - the
pathoption is no longer supported, see section below
Dropped path option and dirs constants
A feature used to allow to set an arbitrary file path. This has become tricky to maintain because all the edge cases and use-cases of file management so we have decided to drop it, making this library focusing more on solving snapshotting and not file system.
To migrate from this old feature, you have a few solutions:
- If you want to save the snapshotted image result to the CameraRoll, just use https://facebook.github.io/react-native/docs/cameraroll.html#savetocameraroll
- If you want to save it to an arbitrary file path, use something like https://github.com/itinance/react-native-fs
- For any more advanced needs, you can write your own (or find another) native module that would solve your use-case.