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 segmentation. This only works if the respective page has a specific URL content that is not part of the domain and that is only visible in the URL when being in this section (e.g. /login).
⇨ Start this Guide to learn how to create a page segment.
⇨ Start this Guide to learn how to hide the Assistant for a page segment.
Learn more info on context-based segmentation in this article.

Option B - Dev Task: Implement the hide command

Alternatively, you can hide Userlane programmatically on specific pages (e.g. the login page) using the hide command:

// hide Userlane
Userlane('hide');

If you want to show Userlane again after hiding it, you can use the initialize command: 

// initialize Command
Userlane('init', your_property_ID);

Good to know

  • For hiding the whole Assistant everywhere on your page because you have your own help button for it, please don’t use the hide command. Simply contact your Customer Support Manager and we can do that for you.

  • If you want to open the Assistant with a specific button, you can use the openAssistant command.

  • If you want to hide Userlane for specific user groups only you can use user-based segmentation

  • If you use links to share Guides, the hide command won’t work on the login page. The Guide will start on the login page if the login URL is added in the Userlane Dashboard under My Account - Applications. If you want this case to work as well, your developers have to remove the Userlane snippet from the login page.