Repro Steps show you all of the interactions a user makes with your app up until a bug or crash is reported, grouped by app view. For each view that a user visits, all of the steps that they commit within those views are captured and displayed as a log, grouped by view.
To enable Repro Steps, you simply need to add
InstabugNavigatorObserver to the
navigatorObservers as shown below:
runApp(MaterialApp( navigatorObservers: [InstabugNavigatorObserver()], ));
For the following gestures, only the gesture is logged and displayed:
- Force touch
- Double tap
- Enabling/disabling a switch
- Changing the value of a slider
- Editing a text field.
Whenever one of the following lifecycle events occurs, it will be captured and shown on the timeline:
- Application is moved to the background
- Application is moved to the foreground
- Application becomes active
- Application becomes inactive
- Memory warning
Depending on the event, you'll find further details displayed as part of the log statement.
- Tap, double tap, and force touch: the SDK always tries to first capture the text rendered inside the UI that the user is interacting with, then we fall back to capturing the icon only with the buttons and navigation items, then, we fall back to the accessibility labels.
- Switch: both the accessibility label as well as whether the user enabled or disabled the switch are logged.
- Slider: both the accessibility label as well as the value that the user moves the slider to it are captured.
- Text fields: first, the SDK tried to capture the placeholder, then we fall back to the accessibility label.
Here are some examples of how steps look like:
Tapped on the button "Send"
Double tapped on UI that contains "Instructions"
Started editing “Password“
Enabled the switch “Push Notifications“
Moved the slider “Text Size“ to 10%
App went to the background
App became active
A disclaimer will be shown at the bottom of the report. It helps your users view all the screenshots taken for the Repro Steps before sending a report and can delete them as well.
By default, Repro Steps are enabled with screenshots for bug reporting and enabled without screenshots for crash reporting.
Instabug.setReproStepsConfig( bug: ReproStepsMode.enabled, crash: ReproStepsMode.enabledWithNoScreenshots, );
To configure Repro Steps, use the
Instabug.setReproStepsConfig() method. You can configure the desired mode for bug reports and crash reports separately using the bug and crash parameters or configure both using all parameters, which overrides both bug and crash.
Instabug.setReproStepsConfig( all: ReproStepsMode.enabled, );
//Enable Repro Steps with screenshots ReproStepsMode.enabled //Enable Repro Steps without screenshots ReproStepsMode.enabledWithNoScreenshots //Disable Repro Steps ReproStepsMode.disabled
|Enable with screenshot for both Bug Reporting and Crash Reporting.|
When the all value is present, it overrides both the bug and crash arguments.
|Enable with no screenshots for Crash Reporting. (Bug Reporting still retains the default value enabled)|
|Enable with screenshot for Bug Reporting. (Crash Reporting still retains the default value enabled without screenshots)|
|Completely disable for both Bug Reporting and Crash Reporting.|
Screenshots are always disabled with Crash Reporting.
For Crash Reporting, the screenshots are always disabled as the data is silently collected without any interaction from the user. This decision is part of our ongoing commitment to end-users' privacy.
Updated 7 days ago