Beta SDK

User Feedback Widget

The User Feedback Widget offers many customization options, and if the available options are insufficient, you can use your own UI.

General

The following options can be configured for the integration in SentryUserFeedbackConfiguration:

User and Form

You can customize which form elements are shown, whether they are required, and even prefill some info, in SentryUserFeedbackFormConfiguration:

Example:

SentrySDK.start { options in 
    options.configureForm { form in
        form.isEmailRequired = true
        form.useSentryUser = false
    }
}

Text Customization

Most text that you see in the default Feedback widget can be customized via SentryUserFeedbackThemeConfiguration:

Example of customization:

SentrySDK.start { options in 
    options.configureUserFeedback { config in
        config.configureForm { form in
            form.isRequiredText = "*"
            form.title = "We want to hear from you!"
        }
    }
}

Theme Customization

Colors can be customized via the top-level config object, configuring for both light and dark themes.

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

SentrySDK.start { options in 
    options.configureUserFeedback { config in
        // configureTheme is used for light themes on iOS versions that support dark mode, and as the sole theme configuration for earlier iOS versions that don't support dark mode
        config.configureTheme { theme in 
            theme.background = .init(color: .yellow)
        }
        config.configureDarkTheme { theme in 
            theme.background = .init(color: .darkGray)
        }
    }
}

Additional UI Customization

These are additional CSS variables that can be overridden, similar to the theme customization above. They're not supported in the constructor.

Event Callbacks

Because it's sometimes useful to know when a user started interacting with the feedback form, we've made it possible for you to add custom logging, or start and stop background timers on the page that tell you when the user is done.

Set these callbacks in SentryUserFeedbackConfiguration:

| Key | Type | Default | Description | | onFormOpen | () -> Void | nil | Called when the feedback form is opened. | | onFormClose | () -> Void | nil | Called when the feedback form is closed. | | onSubmitSuccess | ([String: Any]) -> Void | nil | Called when feedback is successfully submitted via the prepared form. | | onSubmitError | (Error) -> Void | nil | Called when there is an error submitting feedback via the prepared form. |

Bring Your Own Button

You can use your own button instead of the default injected button to trigger the form being displayed, by calling SentrySDK.showUserFeedbackForm() from your button's action handler.

Bring Your Own Widget

You can also use your own UI components to gather feedback and pass the feedback data object to the SentrySDK.capture(feedback: SentryFeedback) function.

SentrySDK.capture(feedback: .init(
    message: "This is an example feedback", // required
    name: "Jane Doe", // optional
    email: "email@example.org", // optional
    source: .custom,
    screenshot: somePngImageData // optional
));