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