Whether you are setting up a new widget or modifying an existing one, a form with all possible configurations (screenshot below) will greet you. In this article, we will understand these configurations in detail.
Embedder widgets are available in 3 flavours.
Floating
Pop-up
Inline
All the 3 flavours have a few exclusive configurations and few common ones. The form is structured in this way.
Common for all widget types
Configuration | Purpose | Additional info |
|---|---|---|
Name | ||
Description | ||
Allow search | ||
Search box placeholder | ||
Widget labels | ||
Default widget page | ||
Search | ||
Load page directly | ||
Search pages by | ||
Search pages by query matching | ||
Display page titles as links that open in new tab | ||
Show additional button in footer | ||
Visibility rules | Defines which pages should display or should not display the widget based on url patterns. |
Look & feel for ‘Floating panel’ and ‘Pop-up’
Configuration | Purpose | Additional info |
|---|---|---|
Widget launcher | ||
Widget launcher text | ||
Widget launcher size | ||
Widget launcher background color | ||
Widget launcher button text color | ||
Header background color | ||
Header text color | ||
Footer background color | ||
Footer text color | ||
Footer button color | ||
Footer button text color |
Specific for ‘Floating panel’
Configuration | Purpose | Additional info |
|---|---|---|
Show widget expanded | ||
Allow full widget height | ||
Widget width % |
Specific for ‘Inline Embed’
Configuration | Purpose | Additional info |
|---|---|---|
Show header | ||
Show footer | ||
Show iframe border | ||
Dimensions in | ||
Widget height | ||
Widget width |
Show widget expanded - If enabled, the widget would be shown in expanded mode at the time of page load. Useful if you want to grab attention of the audience.
Search input placeholder - This text is displayed as placeholder for the search input box.
Show default page content on widget - This is an optional Confluence page selector. If selected, that page will become the home page for the widget & will always load as its landing page.
Show default launcher - If turned off this makes the entire widget inactive.
Widget width - By default set to 30% but you can configure upto 80%. This will dictate width of the widget in context of the page it is being displayed in.
Widget full height - If turned on, the widget height can cover up to the entire area available to it.
Widget launcher label - Text on the launcher button.
Widget launcher button size - Small, Medium or Large. Defines the size of the launcher button.
Widget launcher button background color - Background color of the launcher button.
Widget launcher button text color - Text color of the launcher button.
Header background color - Widget's header background color.
Header text color - Text color of the widget's header.
Footer background color - Widget's footer background color.
Footer text color - Text color of the widget's footer.