Widget: Launch
How reporters open the report flow: a floating button, your own link, a keyboard shortcut, or a gesture.
Widget → Launch controls how reporters open the report flow. A live preview on the right shows your changes. On the left, How reporters open it lists the options. Turn on as many as you like.
Floating button
Always visible in a corner of the page (or the screen, on mobile).
| Setting | Options |
|---|---|
| Style (web) | Pill or Edge tab |
| Position | Top left, top right, bottom left, bottom right |
| Shows | Icon + text, Text, or Icon |
| Text | Your label. Defaults to "Report an issue" |
| Icon | Pick from the icon set |
| Colour, Text colour, Icon colour | The button's colours |
Your own link or button
On the web, call SnagRelay.open() from any element. Handy in a help menu, a footer, or
your own error message:
<a href="#" onclick="SnagRelay.open(); return false">Report a problem</a>In React Native, use it on a settings, help, or profile screen:
<Button title="Report a problem" onPress={() => SnagRelay.open()} />Keyboard shortcut (web)
Handy for your team and testers. Turn it on, then click the shortcut to record a new one.
The default is Alt+Shift+B. A shortcut needs at least one modifier (Ctrl/⌘, Alt).
Gestures (mobile)
Report without leaving the screen. In a TestFlight or release build, shaking the
device opens the report flow. In local development, shake is claimed by the React Native
/ Expo developer menu — pick Report a Snag there, or tap the button. Pass
shakeToOpen={true} if you want shake to open the widget in __DEV__ as well (both
will fire). See React Native SDK.
No way to open it?
If you turn off the button and the shortcut (or gestures), reporters can only open the widget from your own link or button. The dashboard warns you when that's the case.
Next: Capture.