Dev Reference

Code snippets and API reference for developers.

Articles

Quick reference of commands in Userlane
Here you will find a quick reference list of all our supported Userlane commands. Click on any header for more information. Load the script // load Userlane (function(i,s,o,g,r,a,m){i['UserlaneCommandObject']=r;i[r]=i[r]||function(){...
openAssistant - trigger the Userlane Assistant
Show the Userlane Assistant when your users click an element using the 'openAsssitant' command. Usually, a user opens the Assistant by clicking the Assistant icon (avatar) that is visible in one corner of the screen. However, you might want...
hide - Hide Userlane on specific pages of your application
You might want to hide Userlane on specific pages of your app, e.g. the login page. Here are two ways you can do it. Option A - Manager task: Use Page segmentation You can hide the whole Userlane Assistant on a specific page using context-based s...
lang - Define your language detection
Userlane automatically detects the language of your application and of the user's browser to match a user's language preferences. If you want to make sure that Userlane always uses the same language as your application, you can explicitly d...
start, startOnce - Trigger a userlane in your code
Start a Guide with a custom trigger natively in your application. You can use the trigger command to start a Guide, e.g. within a specific button. You can find the trigger command for a specific Guide in the Userlane Dashboard. ⇨ Start this Guid...
onStart, onComplete, onExit - Event callbacks
Hook into Userlane Events to create custom reactions or implementations. The Userlane Javascript API provides some events that you can hook into. This allows you to get notified when a user does something within Userlane. There are three events th...