You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/feedback/README.md
+4-3Lines changed: 4 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,8 @@ The following options can be configured as options to the integration, in `new F
65
65
| --------- | ------- | ------- | ----------- |
66
66
|`showName`|`boolean`|`true`| Displays the name field on the feedback form, however will still capture the name (if available) from Sentry SDK context. |
67
67
|`showEmail`|`boolean`|`true`| Displays the email field on the feedback form, however will still capture the email (if available) from Sentry SDK context. |
68
-
|`isAnonymous`|`boolean`|`false`| Hides both name and email fields and does not use Sentry SDK's user context. |
68
+
|`isNameRequired`|`boolean`|`false`| Requires the name field on the feedback form to be filled in. |
69
+
|`isEmailRequired`|`boolean`|`false`| Requires the email field on the feedback form to be filled in. |
69
70
|`useSentryUser`|`Record<string, string>`|`{ email: 'email', name: 'username'}`| Map of the `email` and `name` fields to the corresponding Sentry SDK user fields that were called with `Sentry.setUser`. |
70
71
71
72
By default the Feedback integration will attempt to fill in the name/email fields if you have set a user context via [`Sentry.setUser`](https://docs.sentry.io/platforms/javascript/enriching-events/identify-user/). By default it expects the email and name fields to be `email` and `username`. Below is an example configuration with non-default user fields.
@@ -133,7 +134,7 @@ Colors can be customized via the Feedback constructor or by defining CSS variabl
133
134
|`submitForegroundHover`|`--submit-foreground-hover`|`#ffffff`|`#ffffff`| Foreground color for the submit button when hovering |
134
135
|`cancelBackground`|`--cancel-background`|`transparent`|`transparent`| Background color for the cancel button |
135
136
|`cancelBackgroundHover`|`--cancel-background-hover`|`var(--background-hover)`|`var(--background-hover)`| Background color when hovering over the cancel button |
136
-
|`cancelBorder`|`--cancel-border`|`var(--border)`|`var(--border)`| Border style for the cancel button |
137
+
|`cancelBorder`|`--cancel-border`|`var(--border)`|`var(--border)`| Border style for the cancel button |
137
138
|`cancelOutlineFocus`|`--cancel-outline-focus`|`var(--input-outline-focus)`|`var(--input-outline-focus)`| Outline color for the cancel button, in the focused state |
138
139
|`cancelForeground`|`--cancel-foreground`|`var(--foreground)`|`var(--foreground)`| Foreground color for the cancel button |
139
140
|`cancelForegroundHover`|`--cancel-foreground-hover`|`var(--foreground)`|`var(--foreground)`| Foreground color for the cancel button when hovering |
Note: The following instructions are to be followed in the Sentry product.
272
273
273
-
If you have Sentry's default issue alert ("Alert me on every new issue") turned on for the project you are setting up User Feedback on, no action is required to have alerting on each user feedback report.
274
+
If you have Sentry's default issue alert ("Alert me on every new issue") turned on for the project you are setting up User Feedback on, no action is required to have alerting on each user feedback report.
274
275
275
276
If you don't have Sentry's default issue alert turned on, follow these steps:
0 commit comments