All Collections
HelpBar
Using the HelpBar
Getting started with the HelpBar
Getting started with the HelpBar
Learn how to get HelpBar onto your app and configure it to help users out
Sonia Schiau avatar
Written by Sonia Schiau
Updated over a week ago

You can add the HelpBar to your product today to smooth out users' experience and allow them to deepen their knowledge at their pace. Here's how to set up your HelpBar to guarantee better product adoption.


Quick access


To use the HelpBar in your product, all you have to do is install Chameleon onto your app to access Chameleon's functionality and leverage our targeting capabilities. There are several methods you can pick from the Dashboard and once you do, you'll be all set to leverage the HelpBar.

βš™οΈ If you install Chameleon via JavaScript you'll be able to leverage HelpBar's ability to navigate without a page refresh. This is included in the code snippet you get from the Dashboard (the block of code that includes the Chameleon functionalities), and you'll just have to configure it to fit your app.


There are different types of content you can add to your HelpBar to enable users better on their journey. From the Dashboard, you can add your knowledge base and enable users to access them from the HelpBar.

πŸ‘‰ You can add more than just help docs to your HelpBar. Explore how you can further configure your SearchActions via our API.


Aside from general help resources that everyone can benefit from, you can also leverage your app content that is user or company-specific. Send your data to Chameleon (user properties, events) to create a Segment in Chameleon for your HelpBar.

πŸ‘‰ Learn more about sending data to Chameleon and what properties you can leverage from our User Data Overview

Depending on your Chameleon plan you can target your HelpBar results to one or more users, companies, or Segments. Here are some targeting limits to keep in mind while you start implementing HelpBar:

  • A Startup account is limited to 10 per SearchItem and in aggregate across all SearchItems.

  • A Growth/Enterprise account is limited to 30 per SearchItem and in aggregate across all SearchItems.

Aside from this, you can also target your content groups (e.g. Help docs, Blog) to one or several companies or Segments.

  • A Startup account is limited to 10 in use across all SearchGroups and in aggregate across all SearchGroups.

  • A Growth/Enterprise account is limited to 30 in use across all SearchGroups and in aggregate across all SearchGroups.

If your plan allows more than 1 HelpBar, each one can have several content groups and each can be targeted to one or more Segments.

  • A Free/Startup account is limited to 5 SearchGroups.

  • A Growth/Enterprise account is limited to 15 SearchGroups.


To ensure you've configured your HelpBar correctly, you can test it out before publishing it live in your product. There are a few ways you can test your HelpBar's content and SearchActions.

◾️ Publish it to your testing Environment -- you can first publish your HelpBar on your staging domains to test out how it works before publishing it to your production domains.

◾️ Be the user -- once you publish the HelpBar and it's live in your app, you'll have a decent time window to test out exactly how it behaves, before users get a chance to use it. You can try out any searches and see what results you get, and if the actions are correct.

If you spot something that's not working as expected, you can unpublish it and review your configuration before users get to experience it live in your product.

πŸ‘‰ For public searchable content, you can also perform a Bing search, in parallel with the HelpBar to see how your documentation shows up. The results and the order that you get in both places should match, or the difference should be subtle.


πŸ”» Does the HelpBar work with mobile frameworks?

Chameleon operates in web environments and will work within Cordova, or Electron apps as long as your app resembles a web environment.

πŸ”» Can I control its styling?

Yes, you can style your HelpBar to fit natively into your app and use custom icons or labels.


Learn more

Did this answer your question?