Add help hints
Put a small "?" next to the fields and buttons people get wrong, with AI or by hand.
A help hint is a small ? icon beside an element. Hovering or tapping it shows a short explanation, or a button that plays a Guide Pro demo of the task. Use hints for tricky form fields, unclear settings, or anything that generates the same support question every week.
Before you start: 3Guide is installed in your app. Hints are on by default, so there's nothing to add to your snippet. To turn them off for the whole site, switch off Show help hints on your site in Settings.
Upgrading from an older snippet?
The data-help-hints attribute no longer does anything. You can leave it in or remove it. The Settings switch is what counts.
Create hints
Choose either way. You can mix them.
- Open Content → Help Hints in the dashboard.
- Use Generate Help Hints with AI: choose a page from your knowledge base, or enter its URL.
- Review the hints it writes for that page's elements, and edit or delete any you don't want.
This works best once you've built a knowledge base, because the AI needs to know what's on the page.
Check them live
Reload the page in your app. The ? icons appear next to the elements you chose. Hints are cached in the browser for up to 24 hours, so if an edit doesn't show, try a private window.
Match your brand
Set the hint colours and the default demo-button label on the Guidance script. Values saved in the dashboard take priority over these.
| Attribute | What it sets |
|---|---|
data-hint-icon-color | The ? icon |
data-hint-button-color | The demo button's background |
data-hint-button-text-color | The demo button's text |
data-hint-button-label | The demo button's default label, e.g. Watch how |
If your app loads new content without a page change and hints don't appear on it, call window.guideai.refreshHelpHints().
The Help Hints page in the dashboard shows the total number of hints, how many pages are covered, and the average per page.
Hint or guide?
Use a hint when one sentence answers the question and the user should stay in control. Use a guide when the answer is a sequence of steps.