Flutter

All PlayStep methods are static, safe to call before the config has loaded, and never throw into your app.

PlayStep.init

Starts the SDK. It returns quickly; the config loads in the background and the last good config is used offline.

await PlayStep.init(
  appKey: 'ps_pub_prod_your_key',
  locale: 'pt-BR',
  onEvent: (event) => analytics.log('playstep_${event['type']}', event),
);

Capture mode

With a capture token, the SDK shows a small panel instead of guides. After Start capturing, each screen you open (reported by PlayStep.navigatorObserver or PlayStep.page) is read from the widget tree and sent to PlayStep: titles, the labels of buttons and fields, and how to find each widget again. What anyone typed is never read. Use it in a debug or profile build, never in a release you ship:

flutter run --dart-define=PLAYSTEP_CAPTURE=cap_your_token

Steps created this way find their widgets without a GuideAnchor, by ValueKey, text, semantics label or tooltip. A GuideAnchor with the step's anchor id always wins.

PlayStep.builder

Draws guides above every route and dialog. Use it as your app's builder:

MaterialApp(builder: PlayStep.builder, home: const HomeScreen());

PlayStep.navigatorObserver

Reports route names as screen views for page_view triggers:

MaterialApp(navigatorObservers: [PlayStep.navigatorObserver], home: const HomeScreen());

GuideAnchor

Marks a widget as an anchor. Taps on it complete tap_anchor steps.

GuideAnchor(
  id: 'new-invoice-btn',
  child: FilledButton(onPressed: createInvoice, child: const Text('New invoice')),
)

PlayStep.identify

PlayStep.identify(user.id, {'plan': 'pro'});

The id is hashed on the device before it is sent.

PlayStep.track

PlayStep.track('invoice_page_opened');

PlayStep.start

IconButton(icon: const Icon(Icons.help_outline), onPressed: () => PlayStep.start('create-first-invoice'));

PlayStep.complete

await saveClient();
PlayStep.complete('fill-client');

PlayStep.page

Reports a screen view yourself, for screens without named routes:

PlayStep.page('/invoices/new');

PlayStep.openLauncher

PlayStep.openLauncher();

PlayStep.reset

Forgets the user and their progress on this device. Call it on sign-out.

await PlayStep.reset();

Back button and keyboard

Android back and desktop Esc close an open guide card, like a dialog. Focus moves to the card for screen readers, and steps are announced.

playstep_embeds

Plays YouTube and Vimeo clips inline, in a web view, when the user taps them.

await PlayStep.init(appKey: 'ps_pub_prod_your_key');
PlayStepEmbeds.register();

PlayStepEmbeds.embedUri returns the privacy-friendly embed URL for a YouTube or Vimeo link:

final uri = PlayStepEmbeds.embedUri('https://youtu.be/aqz-KE-bpKQ');