@sentry/react-native/dist/js/feedback/FeedbackWidget.types.d.ts

Official Sentry SDK for react-native

import type { FeedbackFormData } from '@sentry/core';
import type { ImageStyle, TextStyle, ViewStyle } from 'react-native';
/**
 * The props for the feedback form
 */
export interface FeedbackWidgetProps extends FeedbackGeneralConfiguration, FeedbackTextConfiguration, FeedbackCallbacks, ImagePickerConfiguration {
    styles?: FeedbackWidgetStyles;
}
/**
 * General feedback configuration
 */
export interface FeedbackGeneralConfiguration {
    /**
     * Show the Sentry branding
     *
     * @default true
     */
    showBranding?: boolean;
    /**
     * Should the email field be required?
     */
    isEmailRequired?: boolean;
    /**
     * Should the email field be validated?
     */
    shouldValidateEmail?: boolean;
    /**
     * Should the name field be required?
     */
    isNameRequired?: boolean;
    /**
     * Should the email input field be visible? Note: email will still be collected if set via `Sentry.setUser()`
     */
    showEmail?: boolean;
    /**
     * Should the name input field be visible? Note: name will still be collected if set via `Sentry.setUser()`
     */
    showName?: boolean;
    /**
     * This flag determines whether the "Add Screenshot" button is displayed
     * @default false
     */
    enableScreenshot?: boolean;
    /**
     * Fill in email/name input fields with Sentry user context if it exists.
     * The value of the email/name keys represent the properties of your user context.
     */
    useSentryUser?: {
        email: string;
        name: string;
    };
}
/**
 * All of the different text labels that can be customized
 */
export interface FeedbackTextConfiguration {
    /**
     * The label for the Feedback form cancel button that closes dialog
     */
    cancelButtonLabel?: string;
    /**
     * The label for the Feedback form submit button that sends feedback
     */
    submitButtonLabel?: string;
    /**
     * The title of the Feedback form
     */
    formTitle?: string;
    /**
     * Label for the email input
     */
    emailLabel?: string;
    /**
     * Placeholder text for Feedback email input
     */
    emailPlaceholder?: string;
    /**
     * Label for the message input
     */
    messageLabel?: string;
    /**
     * Placeholder text for Feedback message input
     */
    messagePlaceholder?: string;
    /**
     * Label for the name input
     */
    nameLabel?: string;
    /**
     * Message after feedback was sent successfully
     */
    successMessageText?: string;
    /**
     * Placeholder text for Feedback name input
     */
    namePlaceholder?: string;
    /**
     * Text which indicates that a field is required
     */
    isRequiredLabel?: string;
    /**
     * The label for the button that adds a screenshot and renders the image editor
     */
    addScreenshotButtonLabel?: string;
    /**
     * The label for the button that removes a screenshot and hides the image editor
     */
    removeScreenshotButtonLabel?: string;
    /**
     * The title of the error dialog
     */
    errorTitle?: string;
    /**
     * The error message when the form is invalid
     */
    formError?: string;
    /**
     * The error message when the email is invalid
     */
    emailError?: string;
    /**
     * Message when there is a generic error
     */
    genericError?: string;
}
/**
 * The public callbacks available for the feedback integration
 */
export interface FeedbackCallbacks {
    /**
     * Callback when form is opened
     */
    onFormOpen?: () => void;
    /**
     * Callback when form is closed and not submitted
     */
    onFormClose?: () => void;
    /**
     * Callback when a screenshot is added
     */
    onAddScreenshot?: (addScreenshot: (uri: string) => void) => void;
    /**
     * Callback when feedback is successfully submitted
     *
     * After this you'll see a SuccessMessage on the screen for a moment.
     */
    onSubmitSuccess?: (data: FeedbackFormData) => void;
    /**
     * Callback when feedback is unsuccessfully submitted
     */
    onSubmitError?: (error: Error) => void;
    /**
     * Callback when the feedback form is submitted successfully, and the SuccessMessage is complete, or dismissed
     */
    onFormSubmitted?: () => void;
}
/**
 * Image Picker configuration interface compatible with:
 * - `react-native-image-picker`: 7.2, 8.0
 * - `expo-image-picker`: 16.0`
 */
export interface ImagePickerConfiguration {
    imagePicker?: ImagePicker;
}
interface ImagePickerResponse {
    assets?: ImagePickerAsset[];
}
interface ImagePickerAsset {
    fileName?: string;
    uri?: string;
    base64?: string;
}
interface ExpoImageLibraryOptions {
    mediaTypes?: 'images'[];
    base64?: boolean;
}
interface ReactNativeImageLibraryOptions {
    mediaType: 'photo';
    includeBase64?: boolean;
}
export interface ImagePicker {
    launchImageLibraryAsync?: (options?: ExpoImageLibraryOptions) => Promise<ImagePickerResponse>;
    launchImageLibrary?: (options: ReactNativeImageLibraryOptions) => Promise<ImagePickerResponse>;
}
/**
 * The styles for the feedback form
 */
export interface FeedbackWidgetStyles {
    container?: ViewStyle;
    title?: TextStyle;
    label?: TextStyle;
    input?: TextStyle;
    textArea?: TextStyle;
    submitButton?: ViewStyle;
    submitText?: TextStyle;
    cancelButton?: ViewStyle;
    cancelText?: TextStyle;
    screenshotButton?: ViewStyle;
    screenshotContainer?: ViewStyle;
    screenshotThumbnail?: ImageStyle;
    screenshotText?: TextStyle;
    titleContainer?: ViewStyle;
    sentryLogo?: ImageStyle;
}
/**
 * The state of the feedback form
 */
export interface FeedbackWidgetState {
    isVisible: boolean;
    name: string;
    email: string;
    description: string;
    filename?: string;
    attachment?: string | Uint8Array;
    attachmentUri?: string;
}
export {};
//# sourceMappingURL=FeedbackWidget.types.d.ts.map