xref: /expo/docs/pages/tutorial/screenshot.mdx (revision bc56d325)
1---
2title: Take screenshot
3---
4
5import { SnackInline, Terminal } from '~/ui/components/Snippet';
6import Video from '~/components/plugins/Video';
7import { A } from '~/ui/components/Text';
8
9In this chapter, we will learn how to take a screenshot using a third-party library and save it on the device's media library.
10We'll use the following libraries [`react-native-view-shot`](https://github.com/gre/react-native-view-shot) that allows taking a screenshot,
11and <A href="/versions/latest/sdk/media-library/" openInNewTab>`expo-media-library`</A> that allows accessing a device's media library to save an image.
12
13> So far, we have been using some third-party libraries such as `react-native-gesture-handler`, `react-native-reanimated`, and now `react-native-view-shot`.
14> We can find hundreds of other third-party libraries on [React Native Directory](https://reactnative.directory/).
15
16## Step 1: Install libraries
17
18To install both libraries, run the following commands:
19
20<Terminal cmd={['$ npx expo install react-native-view-shot expo-media-library']} />
21
22## Step 2: Prompt for permissions
23
24When creating an app that requires access to potentially sensitive information, such as access to the media library, we must first request the user's permission.
25
26`expo-media-library` provides a `usePermissions()` hook that gives the permission `status`, and a `requestPermission()` method to ask for access to the media library when permission is not granted.
27
28Initially, when the app loads for the first time and the permission status is neither granted nor denied, the value of the `status` is `null`. When asked for permission, a user can either grant the permission or deny it. We can add a condition to check if it is `null`, and if it is, trigger the `requestPermission()` method.
29
30Add the following code snippet inside the `<App>` component:
31
32{/* prettier-ignore */}
33```jsx App.js
34/* @info Import expo-media-library. */import * as MediaLibrary from 'expo-media-library';/* @end */
35
36// ...rest of the code remains same
37
38export default function App() {
39  /* @info Add this statement to import the permissions status and requestPermission() method from the hook. */const [status, requestPermission] = MediaLibrary.usePermissions();/* @end */
40  // ...rest of the code remains same
41
42  /* @info Add an if statement to check the status of permission. The requestPermission() method will trigger a dialog box for the user to grant or deny the permission. */
43  if (status === null) {
44    requestPermission();/* @end */
45  }
46
47  // ...rest of the code remains same
48}
49```
50
51Once the permission is given, the value of the `status` changes to `granted`.
52
53## Step 3: Picking a library to take screenshots
54
55To allow the user to take a screenshot within the app, we'll use [`react-native-view-shot`](https://github.com/gre/react-native-view-shot). It allows capturing a `<View>` as an image.
56
57Let's import it into **App.js** file:
58
59```jsx App.js
60import { captureRef } from 'react-native-view-shot';
61```
62
63## Step 4: Create a ref to save the current view
64
65The `react-native-view-shot` library provides a method called `captureRef()` that captures a screenshot of a `<View>` in the app and returns the URI of the screenshot image file.
66
67To capture a `<View>`, wrap the `<ImageViewer>` and `<EmojiSticker>` components inside a `<View>` and then pass a reference to it. Using the `useRef()` hook from React, let's create an `imageRef` variable inside `<App>`.
68
69{/* prettier-ignore */}
70```jsx App.js
71import { useState, /* @info Import the useRef hook from React. */useRef/* @end */ } from 'react';
72
73export default function App() {
74  /* @info Create an imageRef variable. */ const imageRef = useRef();/* @end */
75
76  // ...rest of the code remains same
77
78  return (
79    <GestureHandlerRootView style={styles.container}>
80      <View style={styles.imageContainer}>
81        /* @info Add a View component to wrap the ImageViewer and EmojiSticker inside it. */<View ref={imageRef} collapsable={false}>/* @end */
82          <ImageViewer placeholderImageSource={PlaceholderImage} selectedImage={selectedImage} />
83          {pickedEmoji !== null ? (
84            <EmojiSticker imageSize={40} stickerSource={pickedEmoji} />
85          ) : null}
86        /* @info */</View>/* @end */
87      </View>
88      /* ...rest of the code remains same */
89    </GestureHandlerRootView>
90  );
91}
92```
93
94The `collapsable` prop is set to `false` in the above snippet because this `<View>` component is used to take a screenshot of the background image and the emoji sticker.
95The rest of the contents of the app screen (such as buttons) are not part of the screenshot.
96
97## Step 5: Capture a screenshot and save it
98
99Now we can capture a screenshot of the view by calling the `captureRef()` method from `react-native-view-shot` inside the `onSaveImageAsync()` function.
100`captureRef()` accepts an optional argument where we can pass the `width` and `height` of the area we'd like to capture a screenshot for.
101We can read more about available options in [the library's documentation](https://github.com/gre/react-native-view-shot#capturerefview-options-lower-level-imperative-api).
102
103The `captureRef()` method returns a promise that fulfills with the URI of the captured screenshot.
104We will pass this URI as a parameter to <A href="/versions/latest/sdk/media-library/#medialibrarysavetolibraryasynclocaluri" openInNewTab>`MediaLibrary.saveToLibraryAsync()`</A>,
105which will save the screenshot to the device's media library.
106
107Update the `onSaveImageAsync()` function with the following code:
108
109<SnackInline
110label="Take a screenshot"
111templateId="tutorial/07-screenshot/App"
112dependencies={['expo-image-picker', '@expo/vector-icons/FontAwesome', '@expo/vector-icons', 'expo-status-bar', '@expo/vector-icons/MaterialIcons', 'react-native-gesture-handler', 'react-native-reanimated', 'react-native-view-shot', 'expo-media-library']}
113files={{
114  'assets/images/background-image.png': 'https://snack-code-uploads.s3.us-west-1.amazonaws.com/~asset/503001f14bb7b8fe48a4e318ad07e910',
115  'assets/images/emoji1.png': 'https://snack-code-uploads.s3.us-west-1.amazonaws.com/~asset/be9751678c0b3f9c6bf55f60de815d30',
116  'assets/images/emoji2.png': 'https://snack-code-uploads.s3.us-west-1.amazonaws.com/~asset/7c0d14b79e134d528c5e0801699d6ccf',
117  'assets/images/emoji3.png': 'https://snack-code-uploads.s3.us-west-1.amazonaws.com/~asset/d713e2de164764c2ab3db0ab4e40c577',
118  'assets/images/emoji4.png': 'https://snack-code-uploads.s3.us-west-1.amazonaws.com/~asset/ac2163b98a973cb50bfb716cc4438f9a',
119  'assets/images/emoji5.png': 'https://snack-code-uploads.s3.us-west-1.amazonaws.com/~asset/9cc0e2ff664bae3af766b9750331c3ad',
120  'assets/images/emoji6.png': 'https://snack-code-uploads.s3.us-west-1.amazonaws.com/~asset/ce614cf0928157b3f7daa3cb8e7bd486',
121  'components/ImageViewer.js': 'tutorial/02-image-picker/ImageViewer.js',
122  'components/Button.js': 'tutorial/03-button-options/Button.js',
123  'components/CircleButton.js': 'tutorial/03-button-options/CircleButton.js',
124  'components/IconButton.js': 'tutorial/03-button-options/IconButton.js',
125  'components/EmojiPicker.js': 'tutorial/04-modal/EmojiPicker.js',
126  'components/EmojiList.js': 'tutorial/05-emoji-list/EmojiList.js',
127  'components/EmojiSticker.js': 'tutorial/06-gestures/CompleteEmojiSticker.js',
128}}>
129
130{/* prettier-ignore */}
131```jsx
132export default function App() {
133  /* @info Replace the comment with the code to capture the screenshot and save the image. */
134  const onSaveImageAsync = async () => {
135    try {
136      const localUri = await captureRef(imageRef, {
137        height: 440,
138        quality: 1,
139      });
140
141      await MediaLibrary.saveToLibraryAsync(localUri);
142      if (localUri) {
143        alert("Saved!");
144      }
145    } catch (e) {
146      console.log(e);
147    }
148  };
149  /* @end */
150  // ...rest of the code remains same
151}
152```
153
154</SnackInline>
155
156Now, choose a photo and add a sticker. Then tap the “Save” button. We should see the following result:
157
158<Video file="tutorial/saving-screenshot.mp4" />
159
160## Next steps
161
162The `react-native-view-shot` and `expo-media-library` work only on Android and iOS, but we'd like our app to work on web as well.
163
164In the next chapter, let's learn how to [handle the differences between mobile and web platforms](/tutorial/platform-differences).
165