Skip to content

Commit c059ed4

Browse files
antonisclaude
andauthored
docs(apple): Add shake-to-report section and note iOS-only support (#16791)
## DESCRIBE YOUR PR Document the now-functional `useShakeGesture` option for Apple/Cocoa user feedback, based on [sentry-cocoa#7579](getsentry/sentry-cocoa#7579). - Add "Shake to Report" section to the user feedback setup page with a Swift example - Update `useShakeGesture` config description to note it's iOS-only (no-op on macOS, tvOS, watchOS, visionOS) ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): - [ ] Other deadline: - [x] None: Not urgent, can wait up to 1 week+ ⚠️ Should be merged after getsentry/sentry-cocoa#7579 is released ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 221c187 commit c059ed4

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 and iPadOS; 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)