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