@sentry-internal/feedback

Sentry Integration for Feedback

This SDK is considered experimental and in a beta state. It may experience breaking changes, and may be discontinued at any time. Please reach out on GitHub if you have any feedback/concerns.

To view Feedback in Sentry, your Sentry organization must be an early adopter.

Pre-requisites

@sentry-internal/feedback currently can only be used by browsers with Shadow DOM support.

Installation

During the alpha phase, the feedback integration will need to be imported from @sentry-internal/feedback. This will be changed for the general release.

npm add @sentry-internal/feedback

Setup

To set up the integration, add the following to your Sentry initialization. This will inject a feedback button to the bottom right corner of your application. Users can then click it to open up a feedback form where they can submit feedback.

Several options are supported and passable via the integration constructor. See the configuration section below for more details.

import * as Sentry from '@sentry/browser';
// or from a framework specific SDK, e.g.
// import * as Sentry from '@sentry/react';
import { Feedback } from '@sentry-internal/feedback';

Sentry.init({
  dsn: '__DSN__',
  integrations: [
    new Feedback({
      // Additional SDK configuration goes in here, for example:
      // See below for all available options
    })
  ],
  // ...
});

Configuration

General Integration Configuration

The following options can be configured as options to the integration, in new Feedback({}):

key	type	default	description
autoInject	boolean	true	Injects the Feedback widget into the application when the integration is added. This is useful to turn off if you bring your own button, or only want to show the widget on certain views.
showBranding	boolean	true	Displays the Sentry logo inside of the dialog
colorScheme	"system" | "light" | "dark"	"system"	The color theme to use. "system" will follow your OS colorscheme.

User/form Related Configuration

key	type	default	description
showName	boolean	true	Displays the name field on the feedback form, however will still capture the name (if available) from Sentry SDK context.
showEmail	boolean	true	Displays the email field on the feedback form, however will still capture the email (if available) from Sentry SDK context.
isNameRequired	boolean	false	Requires the name field on the feedback form to be filled in.
isEmailRequired	boolean	false	Requires the email field on the feedback form to be filled in.
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.

By default the Feedback integration will attempt to fill in the name/email fields if you have set a user context via Sentry.setUser. By default it expects the email and name fields to be email and username. Below is an example configuration with non-default user fields.

Sentry.setUser({
    email: '[e-mail]',
    fullName: 'Jane Doe',
});


new Feedback({
    useSentryUser({
        email: 'email',
        name: 'fullName',
    }),
})

Text Customization

Most text that you see in the default Feedback widget can be customized.

key	default	description
buttonLabel	Report a Bug	The label of the widget button.
submitButtonLabel	Send Bug Report	The label of the submit button used in the feedback form dialog.
cancelButtonLabel	Cancel	The label of the cancel button used in the feedback form dialog.
formTitle	Report a Bug	The title at the top of the feedback form dialog.
nameLabel	Name	The label of the name input field.
namePlaceholder	Your Name	The placeholder for the name input field.
emailLabel	Email	The label of the email input field.
emailPlaceholder	[e-mail]	The placeholder for the email input field.
messageLabel	Description	The label for the feedback description input field.
messagePlaceholder	What's the bug? What did you expect?	The placeholder for the feedback description input field.
successMessageText	Thank you for your report!	The message to be displayed after a succesful feedback submission.

Example of customization

new Feedback({
  buttonLabel: 'Feedback',
  submitButtonLabel: 'Send Feedback',
  formTitle: 'Send Feedback',
});

Theme Customization

Colors can be customized via the Feedback constructor or by defining CSS variables on the widget button. If you use the default widget button, it will have an id="sentry-feedback, meaning you can use the #sentry-feedback selector to define CSS variables to override.

key	css variable	light	dark	description
background	--background	#ffffff	#29232f	Background color of the widget actor and dialog
backgroundHover	--background-hover	#f6f6f7	#352f3b	Background color of widget actor when in a hover state
foreground	--foreground	#2b2233	#ebe6ef	Foreground color, e.g. text color
error	--error	#df3338	#f55459	Color used for error related components (e.g. text color when there was an error submitting feedback)
success	--success	#268d75	#2da98c	Color used for success-related components (e.g. text color when feedback is submitted successfully)
border	--border	1.5px solid rgba(41, 35, 47, 0.13)	1.5px solid rgba(235, 230, 239, 0.15)	The border style used for the widget actor and dialog
boxShadow	--box-shadow	0px 4px 24px 0px rgba(43, 34, 51, 0.12)	0px 4px 24px 0px rgba(43, 34, 51, 0.12)	The box shadow style used for the widget actor and dialog
submitBackground	--submit-background	rgba(88, 74, 192, 1)	rgba(88, 74, 192, 1)	Background color for the submit button
submitBackgroundHover	--submit-background-hover	rgba(108, 95, 199, 1)	rgba(108, 95, 199, 1)	Background color when hovering over the submit button
submitBorder	--submit-border	rgba(108, 95, 199, 1)	rgba(108, 95, 199, 1)	Border style for the submit button
submitOutlineFocus	--submit-outline-focus	rgba(108, 95, 199, 1)	rgba(108, 95, 199, 1)	Outline color for the submit button, in the focused state
submitForeground	--submit-foreground	#ffffff	#ffffff	Foreground color for the submit button
submitForegroundHover	--submit-foreground-hover	#ffffff	#ffffff	Foreground color for the submit button when hovering
cancelBackground	--cancel-background	transparent	transparent	Background color for the cancel button
cancelBackgroundHover	--cancel-background-hover	var(--background-hover)	var(--background-hover)	Background color when hovering over the cancel button
cancelBorder	--cancel-border	var(--border)	var(--border)	Border style for the cancel button
cancelOutlineFocus	--cancel-outline-focus	var(--input-outline-focus)	var(--input-outline-focus)	Outline color for the cancel button, in the focused state
cancelForeground	--cancel-foreground	var(--foreground)	var(--foreground)	Foreground color for the cancel button
cancelForegroundHover	--cancel-foreground-hover	var(--foreground)	var(--foreground)	Foreground color for the cancel button when hovering
inputBackground	--input-background	inherit	inherit	Background color for form inputs
inputForeground	--input-foreground	inherit	inherit	Foreground color for form inputs
inputBorder	--input-border	var(--border)	var(--border)	Border styles for form inputs
inputOutlineFocus	--input-outline-focus	rgba(108, 95, 199, 1)	rgba(108, 95, 199, 1)	Outline color for form inputs when focused

Here is an example of customizing only the background color for the light theme using the Feedback constructor configuration.

new Feedback({
    themeLight: {
        background: "#cccccc",
    },
})

Or the same example above but using the CSS variables method:

#sentry-feedback {
  --background: #cccccc;
}

Additional UI Customization

Similar to theme customization above, these are additional CSS variables that can be overridden. Note these are not supported in the constructor.

Variable	Default	Description
--bottom	1rem	By default the widget has a position of fixed, and is in the bottom right corner.
--right	1rem	By default the widget has a position of fixed, and is in the bottom right corner.
--top	auto	By default the widget has a position of fixed, and is in the bottom right corner.
--left	auto	By default the widget has a position of fixed, and is in the bottom right corner.
--z-index	100000	The z-index of the widget
--font-family	"'Helvetica Neue', Arial, sans-serif"	Default font-family to use
--font-size	14px	Font size

Event Callbacks

Sometimes it’s important to know when someone has started to interact with the feedback form, so you can add custom logging, or start/stop background timers on the page until the user is done.

Pass these callbacks when you initialize the Feedback integration:

new Feedback({
  onFormOpen: () => {},
  onFormClose: () => {},
  onSubmitSuccess: () => {},
  onSubmitError: () => {},
});

Further Customization

There are two more methods in the integration that can help customization.

Bring Your Own Button

You can skip the default widget button and use your own button. Call feedback.attachTo() to have the SDK attach a click listener to your own button. You can additionally supply the same customization options that the constructor accepts (e.g. for text labels and colors).

const feedback = new Feedback({
  // Disable injecting the default widget
  autoInject: false,
});

feedback.attachTo(document.querySelector('#your-button'), {
    formTitle: "Report a Bug!"
});

Alternatively you can call feedback.openDialog():

import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

function MyFeedbackButton() {
    const client = getCurrentHub().getClient<BrowserClient>();
    const feedback = client?.getIntegration(Feedback);

    // Don't render custom feedback button if Feedback integration not installed
    if (!feedback) {
        return null;
    }

    return (
        <button type="button" onClick={() => feedback.openDialog()}>
            Give me feedback
        </button>
    )
}

Bring Your Own Widget

You can also bring your own widget and UI and simply pass a feedback object to the sendFeedback() function. The sendFeedback function accepts two parameters:

• a feedback object with a required message property, and additionally, optional name and email properties
• an options object

sendFeedback({
  name: 'Jane Doe', // optional
  email: '[e-mail]', // optional
  message: 'This is an example feedback', // required
}, {
  includeReplay: true, // optional
})

Here is a simple example

<form id="my-feedback-form">
  <input name="name" />
  <input name="email" />
  <textarea name="message" placeholder="What's the issue?" />
</form>

import {BrowserClient, getCurrentHub} from '@sentry/react';
import {Feedback} from '@sentry-internal/feedback';

document.getElementById('my-feedback-form').addEventListener('submit', (event) => {
  const feedback = getCurrentHub().getClient<BrowserClient>()?.getIntegration(Feedback);
  const formData = new FormData(event.currentTarget);
  feedback.sendFeedback(formData);
  event.preventDefault();
});

Alerting on User Feedback Reports

Note: The following instructions are to be followed in the Sentry product.

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.

If you don't have Sentry's default issue alert turned on, follow these steps:

1. Navigate to Create New Alert Rule in Sentry (Click "Alerts" in the left-nav menu, "Create Alert" in the top right corner, ensure the "Issues" radio button is selected under the "Errors" category, and then click "Set Conditions")
2. In "Set conditions", add an "IF" filter for The issue's category is equal to "Feedback"
3. Add any other alert rules