To navigate forward and backward, click on the arrow-buttons ← and → on the bottom or on your keyboard. Alternatively, click on the purple circles to go to the next step.
Widget
A widget is a compact program designed to be integrated into websites, web applications, or HelpSpace Docs sites. Its primary purpose is to provide users with a straightforward means to contact you, either through a contact form or by accessing a knowledge database.
Flexible Integration:
Versatile Placement: Widgets can be deployed on your central website, within your web app, or on Docs sites to ensure the knowledge base is accessible right where your users need it.
Access Methods: Users can interact with the content through a clickable widget bubble or a modal that appears when they click on a link.
Create Widget
Go to Settings → Widgets and click on the button Create Widget
Fields / Functions | Description |
|---|---|
Name | Name of the widget |
Description | An internal description of the widget |
Channel | Select the channel that you want to connect with the widget. |
Click on the button Create to build the widget. You see the Widget preview in the lower-right corner.
With the bubble icon, you toggle the dialog (show/hide).
Configure Widget
Widget Settings
Fields / Functions | Description |
|---|---|
Widget Name | Name of the widget |
Description | An internal description of the widget |
Channel | Select the channel that you want to connect with the widget. |
Searchable Docs Site | Select the Docs site that can be searchable. |
Show latest article on main screen | Displays the latest article from a certain Docs site and category. Perfect to show the latest news or updates. |
Hide Docs | Show/Hide the Docs in the Widget |
Hide Contact | Show/Hide the Contact in the Widget |
Widget Style
Fields / Functions | Description |
|---|---|
Header | If you mouse over the square, then the section in the widget dialog is framed in red. The dialog has to be displayed. |
Background | Header background-color |
Text | Header text color |
Icons | Icon color |
Logo | Select the logo on the top. The max height is 16 px. |
Widget Bubble | If you mouse over the square, then the widget bubble is framed in red. |
Background | Widget bubble background-color |
Content | If you mouse over the square, then the section in the widget dialog is framed in red. The dialog has to be displayed. |
Button Background | Content background-color |
Button Text | Content text color |
Localization
Setting the Widget Language
By default, the widget is set to English. However, you can configure the widget to automatically detect the language based on the user's browser settings.
1. Automatic Language Detection:
HelpSpace will check the browser's localization settings to determine the appropriate language.
If the detected language is not supported in your HelpSpace workspace, the widget will default to English.
2. Adding Additional Languages:
To support more languages, navigate to the “Translation” section (details provided below) and add the desired languages to your widget.
Translation
Adding a New Language
1. Select the Language:
Choose the language you wish to add from the list provided.
2. Understanding Translation Status:
Languages that are fully translated will display the label “<------- (translated)” to the right of the language name.
Languages that are partially translated will show “<------- (partially translated)” beside their names.
Embed Options
1. Copy the Code Snippet:
Select and copy the provided code snippet.
2. Paste the Code:
Insert the copied code into the
<head>...</head>section of your website's HTML.
Delete Widget
Check the bottom-line and click on the button Delete Widget to delete the widget permanently.
How to integrate the widget to my docs-site?
https://supportcenter.helpspace.com/article/216/how-to-add-a-widget-to-my-self-service-site
Technical Documentation
The widget has many configuration options that you can insert the script. Please check our technical documentation for more details.
