Viewer onboarding slide
The Viewer onboarding slide appears the first time a Viewer opens a player and shows gesture hints before playback.
It is a player-level screen, not content inside a Story or Moment. In the SDK, this screen is called the first-time slide. You control it with the firstTimeSlide property on the player style.
Separate slides for Stories and Moments
The SDK tracks seen state separately per player type on the device:
- Stories: A Viewer can see the Stories slide once.
- Moments: A Viewer can see the Moments slide once.
- Dismissal: Dismissing one slide does not mark the other as seen.
- Videos: The Videos player does not show an onboarding slide.
Default onboarding slide
If you do not change player style, the base style includes firstTimeSlide with show set to true. The default copy and gestures differ per player.
| Element | Stories default | Moments default |
|---|---|---|
| Main title | Navigating Stories | Navigating Moments |
| Subtitle | Browse story content using these gestures | Browse moments content using these gestures |
| Dismiss button (CTA) | Tap to start | Tap to start |
| Background | System default | System default |
Custom onboarding slide
Override firstTimeSlide properties to brand the slide, tune gesture hints, or turn the slide off with show.
You can change the title, subtitle, background, dismiss button, and instruction rows. iOS and Android also support extra custom instruction rows through customs.
Platform support
| Platform | Stories slide | Moments slide | Custom instruction rows (customs) |
|---|---|---|---|
| iOS | Supported | Supported | Supported |
| Android | Supported | Supported | Supported |
| React Native | Supported | Supported | Not exposed; customize built-in instruction text only |
Platform guides and API reference
Use the Stories style type for Stories and the Moments style type for Moments.
Stories how-to guides: iOS | Android | React Native
Stories style types: iOS | Android | React Native
Moments style types: iOS | Android | React Native
Updated 2 months ago
