Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] use captureRef from react-native-view-shot #6956

Merged
merged 1 commit into from Feb 3, 2020
Merged

[docs] use captureRef from react-native-view-shot #6956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions ...rsions/v36.0.0/sdk/take-snapshot-async.md → ...es/versions/unversioned/sdk/captureRef.md
View file
Open in desktop
@@ -1,17 +1,17 @@
---
title: takeSnapshotAsync
sourceCodeUrl: 'https://github.com/expo/expo/tree/sdk-36/packages/expo/src/takeSnapshotAsync'
title: captureRef
sourceCodeUrl: 'https://github.com/gre/react-native-view-shot'
---

Given a view, `takeSnapshotAsync` 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.
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](../gl-view/#takesnapshotasync) instead.

#### Platform Compatibility

| Android Device | Android Emulator | iOS Device | iOS Simulator | Web |
| -------------- | ---------------- | ---------- | ------------- | --- |
| ✅ | ✅ | ✅ | ✅ | ✅ |
| ✅ | ✅ | ✅ | ✅ | ❌ |

## Installation

Expand All @@ -20,10 +20,10 @@ This API is pre-installed in [managed](../../introduction/managed-vs-bare/#manag
## API

```js
import { takeSnapshotAsync } from 'expo';
import { captureRef } from 'react-native-view-shot';
```

### `takeSnapshotAsync(view, options)`
### `captureRef(view, options)`

Snapshots the given view.

Expand Down Expand Up @@ -60,7 +60,7 @@ const pixelRatio = PixelRatio.get(); // The pixel ratio of the device
// pixels * pixelratio = targetPixelCount, so pixels = targetPixelCount / pixelRatio
const pixels = targetPixelCount / pixelRatio;

const result = await takeSnapshotAsync(this.imageContainer, {
const result = await captureRef(this.imageContainer, {
result: 'tmpfile',
height: pixels,
width: pixels,
Expand Down
18 changes: 9 additions & 9 deletions ...ns/unversioned/sdk/take-snapshot-async.md → .../pages/versions/v36.0.0/sdk/captureRef.md
View file
Open in desktop
@@ -1,17 +1,17 @@
---
title: takeSnapshotAsync
sourceCodeUrl: "https://github.com/expo/expo/tree/sdk-36/packages/expo/src/takeSnapshotAsync"
title: captureRef
sourceCodeUrl: 'https://github.com/gre/react-native-view-shot'
---

Given a view, `takeSnapshotAsync` 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.
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](../gl-view/#takesnapshotasync) instead.

#### Platform Compatibility

| Android Device | Android Emulator | iOS Device | iOS Simulator | Web |
| ------ | ---------- | ------ | ------ | ------ |
| ✅ | ✅ | ✅ | ✅ | ✅ |
| Android Device | Android Emulator | iOS Device | iOS Simulator | Web |
| -------------- | ---------------- | ---------- | ------------- | --- |
| ✅ | ✅ | ✅ | ✅ | ❌ |

## Installation

Expand All @@ -20,10 +20,10 @@ This API is pre-installed in [managed](../../introduction/managed-vs-bare/#manag
## API

```js
import { takeSnapshotAsync } from 'expo';
import { captureRef } from 'react-native-view-shot';
```

### `takeSnapshotAsync(view, options)`
### `captureRef(view, options)`

Snapshots the given view.

Expand Down Expand Up @@ -60,7 +60,7 @@ const pixelRatio = PixelRatio.get(); // The pixel ratio of the device
// pixels * pixelratio = targetPixelCount, so pixels = targetPixelCount / pixelRatio
const pixels = targetPixelCount / pixelRatio;

const result = await takeSnapshotAsync(this.imageContainer, {
const result = await captureRef(this.imageContainer, {
result: 'tmpfile',
height: pixels,
width: pixels,
Expand Down