Skip to content

Commit 9a769a1

Browse files
antonisclaude
andcommitted
docs(apple): Add shake-to-report section and note iOS-only support
Add a "Shake to Report" section to the user feedback setup page and update the `useShakeGesture` config description to note it's iOS-only. Ref: getsentry/sentry-cocoa#7579 Co-Authored-By: Claude <noreply@anthropic.com>
1 parent d50dbde commit 9a769a1

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

docs/platforms/apple/common/user-feedback/configuration/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following options can be configured for the integration in `SentryUserFeedba
1818
| Option | Type | Default | Description |
1919
| ------------------------ | --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
2020
| `animations` | `Bool` | `true` | Whether or not to show animations, like for presenting and dismissing the form. |
21-
| `useShakeGesture` | `Bool` | `false` | Use a shake gesture to display the form. |
21+
| `useShakeGesture` | `Bool` | `false` | Use a shake gesture to display the form. Only supported on iOS; this is a no-op on macOS, tvOS, watchOS, and visionOS. |
2222
| `showFormForScreenshots` | `Bool` | `false` | Any time a user takes a screenshot, bring up the form with the screenshot attached. |
2323
| `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. |
2424

docs/platforms/apple/common/user-feedback/index.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,18 @@ struct SwiftUIApp: App {
161161
}
162162
```
163163

164+
### Shake to Report
165+
166+
You can enable shake-to-report so that shaking the device opens the User Feedback form. This is only supported on iOS.
167+
168+
```swift
169+
SentrySDK.start { options in
170+
options.configureUserFeedback { config in
171+
config.useShakeGesture = true
172+
}
173+
}
174+
```
175+
164176
### Session Replay
165177

166178
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.

0 commit comments

Comments
 (0)