Customize Report Fields

Bug Report Fields

The image below shows the first view that your users see when reporting a bug after invoking the SDK.

Email Address

By default, your users are required to enter a valid email address to submit a bug or feedback. To allow users to submit bugs and feedback without an email, use the following method.

import { BugReporting, InvocationOption } from '@luciq/react-native';
BugReporting.setOptions([InvocationOption.emailFieldHidden]);

You can also remove the email field from the UI completely using the following API.

import { BugReporting, InvocationOption } from '@luciq/react-native';
BugReporting.setOptions([InvocationOption.emailFieldHidden]);

Comment

By default, your app users can submit bugs and feedback without entering a description. To require users to leave a comment before they are able to send bugs or feedback, use the following method.

import { BugReporting, InvocationOption } from '@luciq/react-native';
BugReporting.setOptions([InvocationOption.commentFieldRequired]);

You can also set a minimum number of characters as a requirement for the comments field using the API below. If the reportTypes parameter is omitted, the limit will apply to all report types.

import { BugReporting, ReportType } from '@luciq/react-native';
// All report types
BugReporting.setCommentMinimumCharacterCount(20);
// Specific report types
BugReporting.setCommentMinimumCharacterCount(20, [
  ReportType.bug,
  ReportType.feedback,
  ReportType.question,
]);

Attachments

Your users can submit two types of attachments with any report: default Luciq attachments (files that they can select from their device) and custom extra attachments (additional files that you can attach using code).

Luciq Attachments

When your app users invoke Luciq, the SDK automatically captures a screenshot of their current view. This is the default attachment that is sent with any report. Your users can annotate this screenshot by drawing on, magnifying, or blurring specific parts.

In addition, there are other attachment types that your users can choose to send with each report. All attachment types can be enabled or disabled.

The attachment options are:

• Extra screenshots

• Images from photo library

• Screen recording

All attachment options are enabled by default if they are available in your current plan.

You can customize the attachment options that are available for your users to send by passing a boolean value for each type in the following API call.

import { BugReporting } from '@luciq/react-native';
// Arguments: screenshot, extraScreenshot, galleryImage, screenRecording
BugReporting.setEnabledAttachmentTypes(true, true, true, true);

Extra Attachments

You can also attach up to three custom files to reports, each up to 5MB.

Use the following method to add a new file attachment.

import Luciq from '@luciq/react-native';
// iOS: the fileName argument is ignored; the file's original name is used
// Android: the fileName argument is used as the attachment's display name
Luciq.addFileAttachment(filePath, fileName);

A new copy of the file at filePath will be attached with each bug and feedback submitted. Extra files are only copied when reports are sent, so you can safely call this API whenever files are available on disk, and the copies attached to your reports will always contain the latest changes at the time of sending.

If more than three files are attached, the API overrides the first file. The file also has to be available locally at the provided path when the report is being sent.

User Consent

To use checkboxes, you need a minimum Luciq Android SDK version of v12.3.0.

To use actionable user consents, you need a minimum of Luciq Android SDK version of v13.2.0.

You can use the below API to add a checkbox to your bug reporting form. These checkboxes could be used to:

• Ask for the user's consent without the SDK reacting to the user's answer.

• Ask for the user's consent and have the SDK drop specific data based on the user's answer.

This will help you define:

• Description: Text that appears on the end-user's device.

• Key: Title that appears on the dashboard.

• State: Whether the user input is mandatory or not.

• Default Value: Whether the checkbox is checked by default or unchecked by default.

• Action Type [Optional]: If you want the SDK to drop specific data based on the user’s answer to the checkbox, add one value from the below options.

  • Options:

    • dropAutoCapturedMedia: Drops all auto-captured media, without dropping the attachments that the user attached manually

    • dropLogs: Drops all captured logs, whether they were captured automatically or added by the company itself

    • noChat: Doesn't open a new chat for this specific report and disables the chat functionality on your dashboard for this report.

    • noAutomaticBugReporting: Excludes the report from Automatic Duplicate Grouping (ADG). When the end-user does not give consent, the report is treated as ungrouped and its description is not sent to the LLM used for grouping.

import { BugReporting, userConsentActionType } from '@luciq/react-native';
BugReporting.addUserConsent(
  'consent_key',
  'Share device logs to help us debug your report.',
  false, // mandatory
  true,  // checked by default
  userConsentActionType.dropLogs, // optional
);