Widget
A widget is a small program that you can integrate on any website or the HelpSpace Docs pages. The goal is to offer the user an easy way to get in touch with you. Alternatively, it can search the Docs pages from the widget, for example, to search for solutions.
Create Widget
Go to Settings → Widgets an 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 in the lower right corner.
With the bubble icon, you toggle the dialog (show/hide). Check the Docs content and the Contact form.
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. |
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
Set the language of the widget. The default language is English.
You can set the widget language to Auto detect if you have multiple languages. HelpSpace checks the browser localization. If the localization is not configured in your HelpSpace workspace then the fallback language will be displayed. Fallback is English.
Add new widget languages in Translation (see below).
Translation
Select the language you want to add.
Translated languages will have text on the right: <------- (translated)
Partially translated languages will have text on the right: <------- (partially translated)
Embed Options
Copy the code snippet and paste it to your website inside the <head> ... </head> tag.
Click on the button Save to store the configuration.
Delete Widget
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