Widget configuration & installation

You are currently viewing a topic category type with description subcategory display type.

Widget Settings section

The Widget Settings section is the first section in Settings > Widget (yes, these are confusingly similar). These settings determine how the widget will be opened or launched in your website/application.

The settings are basically divided into two options here:

  • An automatic circular "?" icon -- no coding required!
  • Attach the widget to an element of your choice (such as a menu option, top navigation link, hyperlink, icon, image, etc.) by element ID

See details below for setting up either option.

If you make changes to these settings, it may take up to an hour to see them in your browser due to caching. You can bypass the caching by doing a hard refresh.

Automatic icon

With the automatic icon option, you don't need to adjust anything else on the website you're adding the code to. The script will automatically create the icon and place it based on the location setting you select.

To use this configuration, select any of the Page Position options other than Attach to Element (e.g. Bottom Right, Top Center, etc.). If you want to move the icon, you simply select a different display location from the dropdown:

Widget Settings when an icon display position is selected

  1. Button Page Position: use this dropdown to select the display location for the icon.
  2. Button Text Color: sets the color of the "?" on the icon. Use a hex color.
  3. Button Background Color: sets the color of the icon button. Use a hex color.
  4. Be sure to Save any changes you made here.

Here's what a widget icon will look like if it's configured with:

  • Button Page Position: Bottom Right
  • Button Text Color: White
  • Button Background Color: Orange

Screenshot showing a website with the widget help icon hovering in the lower rightWidget using the "Bottom Right" display settings 

Attach to element

Rather than having us automatically create an icon, you can launch the widget by attaching it to an element of your choice--this can be a menu option, an icon, a hyperlink, etc.

For example, in this screenshot, the "Widget Help" link in the upper right will open the widget:

Screenshot showing a "Widget Help" top navigation linkWidget Help top navigation link will launch the widget using Attach To Element

To use this option, select Attach to Element from the Button Page Position dropdown:

Screenshot showing the Widget Settings with Page Position selected as Attach To Element and an Element ID of ko-launchWidget Settings when Attach To Element is selected

  1. In the Button Page Position dropdown, select Attach to Element. Attach To Element is the only Button Page Position option which will let you attach the widget to an element of your choice; all other options will use the icon.
  2. Once Attach To Element is selected, you'll see an Element ID field. Set the Element ID to match the html ID attribute of the element you want the widget attached to in your website or application. When someone clicks on this element, the widget will open. If your developers are creating an element from scratch, we recommend using ko-launch or another obviously KnowledgeOwl-related element ID. You can use any Element ID you choose except for ko-widget; we prevent that ID from being used, and you'll see an error message if you try to use it.
  3. Be sure to Save any changes you made here.

For example, if we used "ko-launch" as our Element ID, we might add this HTML element to a top navigation option in our other website:

<li><a class="header-link" id="ko-launch" href="javascript:void(0);">Widget Help</a></li>

That code might be included in the top navigation, producing something like this:

Screenshot showing a "Widget Help" top navigation linkWidget Help top navigation link will launch the widget using Attach To Element

Widget Admin Settings

Widget Customize Text section

Widget Contact Form section

Custom Widget Styles

Custom Widget Javascript

Add spam protection to Widget 2.0 Contact Tab

Open widget to a specific article or category

Use Widget 2.0 for Contextual Help: Recommend on Pages

Hide one of the Widget 2.0 tabs

Widget 2.0 installation