fix(feedback): update docs with SwiftUI notes #14227
Open
+87
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 860.79kB (4.08%) ⬆️. This is within the configured threshold ✅ Detailed changes
ℹ️ *Bundle size includes cached data from a previous commit Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
noahsmartin
approved these changes
Jul 3, 2025
coolguyzone
reviewed
Jul 7, 2025
| @@ -57,7 +57,7 @@ The following options can be configured for the integration in `SentryUserFeedba | |||
| | Option | Type | Default | Description | | |||
| | ---------------- | ------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |||
| | `location` | `[NSDirectionalRectEdge]` | `[.bottom, .trailing]` | The location of the widget on the screen. | | |||
| | `autoInject` | `Bool` | `true` | Injects the Feedback widget into the application when the integration is added. Set `autoInject: false` if you want to call `feedback.attachTo()` or `feedback.openDialog()` directly, or only want to show the widget on certain views. | | |||
| | `autoInject` | `Bool` | `true` | Injects the Feedback widget into the application when the integration is added. Set `autoInject: false` if you want to call `SentrySDK.feedback.showWidget()` directly, e.g. to show the widget on certain views. | | |||
There was a problem hiding this comment.
The SentrySDK.feedback.showWidget() seems to be breaking the formatting on this page, I wonder if there's a way to reformat this table so that things fit?
coolguyzone
reviewed
Jul 7, 2025
| @@ -45,6 +45,92 @@ To start using the User Feedback widget in your Cocoa application, provide a fee | |||
|
|
|||
| This setup will insert the widget into your app's view hierarchy. By default, it appears in the bottom trailing corner of the screen, but you can fully customize its appearance and behavior. | |||
|
|
|||
| #### SwiftUI | |||
|
|
|||
| SwiftUI apps cannot currently use automatic injection of the widget upon SDK start. Several options exist to display the feedback form: | |||
There was a problem hiding this comment.
Suggested change
| SwiftUI apps cannot currently use automatic injection of the widget upon SDK start. Several options exist to display the feedback form: | |
| SwiftUI apps don’t currently support automatic widget injection when the SDK starts. Several options exist to display the feedback form: |
coolguyzone
reviewed
Jul 7, 2025
|
|
||
| ##### Use your own button | ||
|
|
||
| Place a `UIButton` somewhere in your app, then provide the reference to the feedback configuration in the options provided on SDK start: |
There was a problem hiding this comment.
Add a UIButton to your app, then provide the reference to the feedback configuration in the SDK start options:
coolguyzone
reviewed
Jul 7, 2025
|
|
||
| ##### Manually display the widget from a connected `UIWindowSceneDelegate` | ||
|
|
||
| You must set up a `UIApplicationDelegateAdaptor`, connect a `UIScene` to your app, and manually call `SentrySDK.feedback.showWidget()`: |
There was a problem hiding this comment.
Suggested change
| You must set up a `UIApplicationDelegateAdaptor`, connect a `UIScene` to your app, and manually call `SentrySDK.feedback.showWidget()`: | |
| You can set up a `UIApplicationDelegateAdaptor`, connect a `UIScene` to your app, and manually call `SentrySDK.feedback.showWidget()`: |
coolguyzone
requested changes
Jul 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Updates the docs for Apple User Feedback to at notes about current limitations of using the feature with SwiftUI, related to getsentry/sentry-cocoa#5053.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: