Self Help Widget
The self-help widget is an embedded help panel that gives users instant access to support content without leaving your application. It appears as a floating button that expands into a searchable resource center when clicked.
What the Widget Includes
The self-help widget can surface several types of content:
- Knowledge base articles -- Help articles created in the BreakGround dashboard. When clicked, the article body renders in a modal overlay inside the widget — users never leave the page.
- Flows -- Interactive walkthroughs and tours that users can launch on demand.
- External links -- Links to external documentation, support portals, or community forums.
- KB article links -- References to articles in your external knowledge base. The SDK fetches the article content at click time and renders it in the same in-widget modal.
Users can browse content by category or use the built-in search to find what they need.
Configuration
- Navigate to Content > Self Help in the dashboard.
- Enable the self-help widget toggle.
- Select which content types to include (articles, flows, external links).
- Organize content into categories and set the display order.
- Configure the widget position and default state (open or closed on page load).
Customization
Customize the widget appearance to match your application:
| Setting | Description |
|---|---|
| Position | Place the widget button in any corner of the viewport (bottom-right, bottom-left, top-right, top-left). |
| Theme | Set primary and secondary colors, font family, and border radius to match your brand. |
| Icon | Use the default help icon, select from the built-in icon library, or upload a custom image. |
| Labels | Customize all visible text labels. Supports localization for multi-language applications. |
| Default State | Choose whether the widget panel opens automatically on page load or remains collapsed until the user clicks. |
KB Article Items
The kb_article item type links a widget entry to an article in your knowledge base by its ID. When a user clicks the item:
- The SDK fetches the article body from the BreakGround API using the tenant key.
- The article title and formatted body render inside a modal overlay within the widget panel.
- The user can scroll the article and close the modal to return to the widget.
Configure KB article items from the Content > Self Help editor by selecting KB Article as the item type and entering the article ID.
Search Functionality
The widget includes full-text search across all included content. Published articles and flow titles are automatically indexed. Search results are ranked by relevance and grouped by content type. Users see results as they type, with highlighted matching terms.