JavaScript API

Methods used to interact with UserGuiding's JavaScript SDK. Includes user attribute tracking, guide triggering, subscribing to guide events.

Written by Met
Updated over a week ago

UserGuiding inside iframes

Written by Met
Updated over a week ago

How can I set user id for User Persisted Storage?

Setting user_id for User Persisted Storage

Written by Met
Updated over a week ago

Track custom user attributes

Learn how to track custom user attributes

Written by Met
Updated over a week ago

Does UserGuiding work with SPAs (Single Page Applications)?

Written by Met
Updated over a week ago

Offline Guide Support

Written by Alican
Updated over a week ago

Close active preview

How to end/finish current preview

Written by Met
Updated over a week ago

How to know UserGuiding code is loaded and JS API is ready?

Written by Met
Updated over a week ago

Subscribing to preview start event

onPreviewStart callback

Written by Met
Updated over a week ago

Subscribing to step preview event

onPreviewStep callback

Written by Met
Updated over a week ago

Subscribing to preview end event

onPreviewEnd callback

Written by Met
Updated over a week ago

Get list of completed guides

Written by Met
Updated over a week ago

Trigger a guide

You can invoke a guide programmatically

Written by Met
Updated over a week ago

Launch the assistant widget

Written by Met
Updated over a week ago