Skip to content

Commit e9fba21

Browse files
ryan953michellewzhang
ryan953
and
michellewzhang
authored
feat(feedback): Document more custom labels in the Feedback SDK (#14793)
<img width="1079" height="292" alt="SCR-20250905-jzdo" src="https://github.com/user-attachments/assets/a30df932-7f1e-4de3-b4a5-b76538159398" /> Released the new labels for translation in in https://github.com/getsentry/sentry-javascript/releases/tag/10.10.0 Relates to https://linear.app/getsentry/issue/JS-895/allow-custom-texts-to-feedback-integration-screenshot-tool-buttons --------- Co-authored-by: Michelle Zhang <[email protected]>
1 parent 9a1b285 commit e9fba21

File tree

1 file changed

+21
-18
lines changed
  • docs/platforms/javascript/common/user-feedback/configuration

1 file changed

+21
-18
lines changed

‎docs/platforms/javascript/common/user-feedback/configuration/index.mdx‎

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -80,24 +80,27 @@ Most text that you see in the default Feedback widget can be customized.
8080

8181
The following options can be configured for the integration in `feedbackIntegration({})`:
8282

83-
| Key | Default | Description |
84-
| ----------------------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
85-
| `triggerLabel` | `"Report a Bug"` | The label of the injected button that opens up the feedback form when clicked. |
86-
| `triggerAriaLabel` | `triggerLabel` \|\| `"Report a Bug"` | The aria label of the injected button that opens up the feedback form when clicked. Available starting in SDK v8.20.0. |
87-
| `formTitle` | `"Report a Bug"` | The title at the top of the feedback form. |
88-
| `submitButtonLabel` | `"Send Bug Report"` | The label of the submit button used in the feedback form. |
89-
| `cancelButtonLabel` | `"Cancel"` | The label of cancel buttons used in the feedback form. |
90-
| `confirmButtonLabel` | `"Confirm"` | The label of confirm buttons used in the feedback form. |
91-
| `addScreenshotButtonLabel` | `"Add a screenshot"` | The label of the button to add a screenshot to the form. |
92-
| `removeScreenshotButtonLabel` | `"Remove screenshot"` | The label of the button to remove the screenshot from the form. |
93-
| `nameLabel` | `"Name"` | The label of the name input field. |
94-
| `namePlaceholder` | `"Your Name"` | The placeholder for the name input field. |
95-
| `emailLabel` | `"Email"` | The label of the email input field. |
96-
| `emailPlaceholder` | `"[email protected]"` | The placeholder for the email input field. |
97-
| `isRequiredLabel` | `"(required)"` | The label shown next to an input field that is required. |
98-
| `messageLabel` | `"Description"` | The label for the feedback description input field. |
99-
| `messagePlaceholder` | `"What's the bug? What did you expect?"` | The placeholder for the feedback description input field. |
100-
| `successMessageText` | `"Thank you for your report!"` | The message displayed after a successful feedback submission. |
83+
| Key | Default | Description |
84+
| ----------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
85+
| `triggerLabel` | `"Report a Bug"` | The label of the injected button that opens up the feedback form when clicked. |
86+
| `triggerAriaLabel` | `triggerLabel` \|\| `"Report a Bug"` | The aria label of the injected button that opens up the feedback form when clicked. Available starting in SDK v8.20.0. |
87+
| `formTitle` | `"Report a Bug"` | The title at the top of the feedback form. |
88+
| `submitButtonLabel` | `"Send Bug Report"` | The label of the submit button used in the feedback form. |
89+
| `cancelButtonLabel` | `"Cancel"` | The label of cancel buttons used in the feedback form. |
90+
| `confirmButtonLabel` | `"Confirm"` | The label of confirm buttons used in the feedback form. |
91+
| `addScreenshotButtonLabel` | `"Add a screenshot"` | The label of the button to add a screenshot to the form. |
92+
| `removeScreenshotButtonLabel` | `"Remove screenshot"` | The label of the button to remove the screenshot from the form. |
93+
| `nameLabel` | `"Name"` | The label of the name input field. |
94+
| `namePlaceholder` | `"Your Name"` | The placeholder for the name input field. |
95+
| `emailLabel` | `"Email"` | The label of the email input field. |
96+
| `emailPlaceholder` | `"[email protected]"` | The placeholder for the email input field. |
97+
| `isRequiredLabel` | `"(required)"` | The label shown next to an input field that is required. |
98+
| `messageLabel` | `"Description"` | The label for the feedback description input field. |
99+
| `messagePlaceholder` | `"What's the bug? What did you expect?"` | The placeholder for the feedback description input field. |
100+
| `successMessageText` | `"Thank you for your report!"` | The message displayed after a successful feedback submission. |
101+
| `highlightToolText` | `"Highlight"` | The label for the button that highlights portions of the screenshot. Available starting in SDK v10.10.0. |
102+
| `hideToolText` | `"Hide"` | The label for the button that hides portions of the screenshot. Available starting in SDK v10.10.0. |
103+
| `removeHighlightText` | `"Remove"` | The label for the button that removes a highlighted/hidden section of the screenshot. Available starting in SDK v10.10.0. |
101104

102105
Example of customization:
103106

0 commit comments

Comments
 (0)