docs/pages/versions/v54.0.0/sdk/captureRef.mdx
import { BookOpen02Icon } from '@expo/styleguide-icons/outline/BookOpen02Icon';
import { APIInstallSection } from '/components/plugins/InstallSection';
import { BoxLink } from '/ui/components/BoxLink';
Given a view, captureRef will essentially screenshot that view and return an image for you. This is very useful for things like signature pads, where the user draws something, and then you want to save an image from it.
If you're interested in taking snapshots from the GLView, we recommend you use GLView's takeSnapshotAsync instead.
Remember to take the device PixelRatio into account. When you work with pixel values in a UI, most of the time those units are "logical pixels" or "device-independent pixels". With images like PNG files, you often work with "physical pixels". You can get the PixelRatio of the device using the React Native API: PixelRatio.get()
For example, to save a 'FullHD' picture of 1080x1080, you would do something like this:
const targetPixelCount = 1080; // If you want full HD pictures
const pixelRatio = PixelRatio.get(); // The pixel ratio of the device
// pixels * pixelRatio = targetPixelCount, so pixels = targetPixelCount / pixelRatio
const pixels = targetPixelCount / pixelRatio;
const result = await captureRef(this.imageContainer, {
result: 'tmpfile',
height: pixels,
width: pixels,
quality: 1,
format: 'png',
});
<BoxLink title="Visit official documentation" description="Get full information on API and its usage." Icon={BookOpen02Icon} href="https://github.com/gre/react-native-view-shot" />