Understanding Lighthouse

Lighthouse makes it plain sailing for your users to help themselves without ever leaving your app or website. Here's the various states and actions users will see within your widget.

General Overview

  1. Navigation bar
  2. Contact form/live chat button
  3. Article suggestions
  4. Instant search bar
  5. Widget toggle
  6. Categories & articles

The navigation bar helps users control where they are within your widget. We'll use your uploaded logo to the left and your brand name to the right from Settings > Brand

You can customize which logo is displayed using the  Widget API.

Contact form/live chat button

The contact button helps users who can't find an answer from your knowledge base get in touch with your team. Depending on the integrations you've installed, we'll either show the user a contact form to fill out or a live chat window.

Our  DriftIntercomSmooch and Gorgias integrations work with the contact button. We'll be adding more soon.

Article suggestions

Lighthouse offers the ability to provide smart contextual help. You can set up articles to be suggested depending on the page your users are currently on. 

To start creating suggestions, use the suggestions config value to either suggest specific articles, articles within a category, or all articles with a certain tag.

The search you know and love is included within the Lighthouse widget. As soon as a user start typing, they'll see article suggestions appear.

Widget toggle

Lighthouse can either expand to provide information or hide away ready to be helpful. By default Lighthouse will appear in a closed state, although you can trigger behaviour using the Widget API methods.

When in a closed state, the Lighthouse icon will show. Depending on your primary color, it'll either show a light version or a dark version.

You can force either the light or dark version by using the color_mode config value in the Widget API

Categories & articles

Just like on your knowledge base, users will be able to browse categories and articles to find information. 

Your custom icons will show on category cards as well as any custom meta information you've added to categories and articles. Custom ordering will also stay intact.

What did you think of this doc?