docs(feedback): Document the new tags field #10137
Merged
Conversation
This file contains 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 ↗︎
|
Bundle ReportChanges will decrease total bundle size by 12 bytes ⬇️
|
vivianyentran
approved these changes
May 23, 2024
docs/platforms/javascript/common/user-feedback/configuration/index.mdx
Outdated
Show resolved
Hide resolved
…ndex.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
c298lee
approved these changes
May 30, 2024
| | `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. | | ||
| | `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. | | ||
| | `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. | | ||
| | `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. | |
There was a problem hiding this comment.
@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.
ryan953
added a commit
to getsentry/sentry-javascript
that referenced
this pull request
Jun 17, 2024
…am (#12197) We were missing the ability to set tags within feedback before, this corrects it. See getsentry/sentry-docs#10137 for the docs update. Now a developer can set `tags: {...}` anytime an options param is passed into feedback. This includes: - when we init the integration `feedbackIntegration({tags: {hello: 'world'}})` - when attachTo is called: `feedback.attachTo(element, {tags: {hello: 'world'}})` - when createWidget is called: `feedback.createWidget({tags: {hello: 'world'}})` - when createForm is called: `feedback.createForm({tags: {hello: 'world'}})` Users can also pass tags to `sendFeedback()` which is slightly nicer than having to set them on scope first. - `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the other `capture*()` methods. I also took the chance to re-use related types in more places. Checkout the first 2 commits on the branch to see those changes individually. Fixes getsentry/sentry#71254
|
The new |
|
Tags are included in https://github.com/getsentry/sentry-javascript/releases/tag/8.10.0 |
ryan953
added a commit
to getsentry/pokemon-market
that referenced
this pull request
Jun 26, 2024
Depends on getsentry/sentry-javascript#12197 Follows instructions from getsentry/sentry-docs#10137 --------- Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Documents a new field added in getsentry/sentry-javascript#12197
Related to getsentry/sentry#71254