Skip to content

docs(apple): Add shake-to-report section and note iOS-only support #16791

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

Merged
antonis merged 4 commits into from
Mar 12, 2026
Merged

docs(apple): Add shake-to-report section and note iOS-only support #16791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a769a1
docs(apple): Add shake-to-report section and note iOS-only support
antonis Mar 5, 2026
95d1121
Merge branch 'master' into antonis/ios-feedback-shake
antonis Mar 10, 2026
db3a8a3
Add iPadOS
antonis Mar 10, 2026
d25ddf6
Merge branch 'master' into antonis/ios-feedback-shake
antonis Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/platforms/apple/common/user-feedback/configuration/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The following options can be configured for the integration in `SentryUserFeedba
| Option | Type | Default | Description |
| ------------------------ | --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `animations` | `Bool` | `true` | Whether or not to show animations, like for presenting and dismissing the form. |
| `useShakeGesture` | `Bool` | `false` | Use a shake gesture to display the form. |
| `useShakeGesture` | `Bool` | `false` | Use a shake gesture to display the form. Only supported on iOS and iPadOS; this is a no-op on macOS, tvOS, watchOS, and visionOS. |
| `showFormForScreenshots` | `Bool` | `false` | Any time a user takes a screenshot, bring up the form with the screenshot attached. |
| `tags` | `[String: Any]` | `nil` | Tags to set on the feedback event. This is a dictionary where keys are strings and values can be different data types such as `NSNumber`, `NSString`, etc. |

Expand Down
12 changes: 12 additions & 0 deletions docs/platforms/apple/common/user-feedback/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,18 @@ struct SwiftUIApp: App {
}
```

### Shake to Report

You can enable shake-to-report so that shaking the device opens the User Feedback form. This is only supported on iOS.

```swift
SentrySDK.start { options in
options.configureUserFeedback { config in
config.useShakeGesture = true
}
}
```

### Session Replay

The User Feedback widget integrates seamlessly with Session Replay. When the widget is opened, the Replay SDK buffers up to 30 seconds of the user's session. If feedback is submitted, this replay is sent along with the feedback, allowing you to view both the feedback and the user's actions leading up to the feedback submission.
Expand Down
Loading