feat(feedback): Add Feedback SDK instructions to README #9351
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
mydea
approved these changes
Oct 25, 2023
AbhiPrasad
approved these changes
Oct 25, 2023
Comment on lines
+18
to
+19
| During the alpha phase, the feedback integration will need to be imported from `@sentry-internal/feedback`. This will be | ||
| changed for the general release. |
There was a problem hiding this comment.
Suggested change
| During the alpha phase, the feedback integration will need to be imported from `@sentry-internal/feedback`. This will be | |
| changed for the general release. | |
| During the alpha phase, the feedback integration will need to be imported from `@sentry-internal/feedback`. This import will be | |
| changed for the general release. |
| @@ -11,28 +11,33 @@ This SDK is **considered experimental and in an alpha state**. It may experience | |||
|
|
|||
| ## Pre-requisites | |||
|
|
|||
| `@sentry/feedback` currently can only be used by browsers with [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM) support. | |||
| `@sentry-internal/feedback` currently can only be used by browsers with [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM) support. | |||
There was a problem hiding this comment.
I hate adding the ie11 note but people will def ask.
Suggested change
| `@sentry-internal/feedback` currently can only be used by browsers with [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM) support. | |
| `@sentry-internal/feedback` currently can only be used by browsers with [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM) support. This means it is not supported for IE11. Please see the [caniuse](https://caniuse.com/shadowdomv1) for the full browser compatability matrix. |
| Connect your own feedback UI to Sentry's You can use `feedback.flush()` to immediately send all currently captured feedback data. | ||
| When Feedback is currently in buffering mode, this will send up to the last 60 seconds of feedback data, | ||
| and also continue sending afterwards, similar to when an error happens & is recorded. | ||
| You can also bring your own widget and UI and simply pass a feedback object to the `sendFeedback()` function. |
There was a problem hiding this comment.
Might be nice for us to think about a way to make the widget work without js in the future via direct form submit, but def something for after GA (we can prob just open a feature request issue and see how many thumbs ups we get).
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.
No description provided.