WebChat Common Styling and Behavior (Bot framework v4)
Druid provides you with a straightforward configuration of the webchat snippet for bots using bot framework v4. Clicking the Customize webchat (bot details, Theme section) opens the Customize Your Webchat UI editor, which allows extensive customization of the webchat styling and behavior parameters.
This section describes the parameters grouped per category and where applicable per subcategory (accessible from the Editor's left menu(s)).
Search
If you know the name of a specific style option, this function will help you to search through.
General
Subcategory |
Parameter |
Description |
---|---|---|
Authentication | Login/Logout |
Allows authenticated DRUID Portal users to chat as authenticated users (log in the chat widget)or as anonymous (Log out if previously logged authenticated in the chat widget). Note: This is option is available only in the DRUID Portal chat widget; it is not available in chat widgets hosted in custom pages.
|
Common |
Disable webchat (isDisabled) |
When enabled this property disables the webchat bubble from where the snippet is embedded. |
queryParams (queryParams) |
?param1=value¶m2=value The params are sent within the conversation context and are mapped with entity QueryParams. Create string fields in the QueryParams entity with the param names to address the conversation slots and use them in your flows: QueryParams.params1, QueryParams.params2 Note: For directline (web channel), Druid version 1.59 or higher automatically collects the following information related to the device used by the user to chat with the chatbot. For more information, see System Entities, [[QueryParams]] system entity.
|
|
Background Traffic Enabled (backgroundTrafficEnabled) |
When set to true, the webchat control sends telemetry information to the Druid ChatBot Platform. Telemetry information includes the time stamp when a message was sent or received. |
|
authorizationUrl |
This is the path name of the base url used for authorization. |
|
authorizationBaseUrl |
Use it when you want to set a base url used for authorization. |
|
Calls withCredentials (withCredentials) |
The XMLHttpRequest.withCredentials property is a Boolean value that indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. For more information, see Mozilla documentation. |
|
Authorization call withCredentials (withCredentials_authorization) |
||
Enable Notifications (notificationsEnabled) |
Sends a sound notification when a new message is received in the chat. |
|
Other Services Endpoint Index (otherServicesEndpointIndex) |
Used for on premise installation. 0= returns default endpoint, 1...n=other configurations (for ex: intranet DruidApi). |
|
heartBeatUrl |
Heartbeat endpoint , on every message sent by the user, a keep alive user's session is sent to the heartBeatUrl (ex: Druid myaccount). |
|
Cookies |
conversationTokenEnabled (conversationTokenEnabled) |
Saves the conversation token in browser cookie to remember the user when returning in webchat. |
DruidCookiesExpirationInDays (DruidCookiesExpirationInDays) | Allows setting up the cookie expiry in days or fractional in minutes. | |
conversationToken_namePrefix (conversationToken_namePrefix) |
Saves the conversation token in browser cookie to remember the user when returning in webchat, adding a prefix to the conversation token. |
|
DruidWebChatIsOpenedEnabled (DruidWebChatIsOpenedEnabled) |
Automatically keeps expands the webchat control. |
|
DruidWebChatIsOpened_namePrefix (DruidWebChatIsOpened_namePrefix) |
Automatically expands the webchat control. It is useful to set up a prefix if multiple chatbot snippets are hosted in a single web page, in order to distinguish them. |
|
DruidCookieConsent (DruidCookieConsentEnabled) |
Enable it whenever you need to retrieve from users their consent regarding the cookies. |
|
cookieDomain (cookieDomain) |
Domain' attribute signifies the domain for which the cookie is valid and can be submitted with every request for this domain or its subdomains. If this attribute is not specified, then the hostname of the originating server is used as the default value. |
Layout
Subcategory |
Parameter |
Description |
---|---|---|
Common |
Auto Expand (autoExpandEnabled) |
When enabled, it keeps the chatbot snippet expanded. |
Show default Close Button (closeButtonEnabled) |
When enabled, it adds a specific icon for closing chatbot snippet. |
|
Show "Powered by Druid" (showPoweredBy) | When enabled, include the text 'Powered by DRUID' at the bottom of the webchat. | |
Chat Height (height) |
The height of the collapsed web chat widget. |
|
Chat Width (width) |
The width of the collapsed web chat widget. |
|
Chat Minimum Width (minWidth) |
The min width of the collapsed web chat widget. |
|
Position (left/right) (position) |
The web chat’s position relative to the bottom of the page. Values: left, right. |
|
Float (floatRight) |
The distance between the widget and the browser's right border, expressed in percentage of the screen width. |
|
Bottom (bottom) |
The distance between the widget and bottom of the screen. |
|
Top (top) |
The distance between the widget and top of the screen. |
|
ChatBox |
Border Radius (chatBoxBorderRadius) |
The border-radius property defines the radius of the chatbot snippet top corners. |
Bottom Radius (chatBoxBottomRadius) |
The border-radius property defines the radius of the chatbot snippet bottom corners. |
|
Border Color (chatBoxBorderColor) |
The border color property is used to set the border color of the chatbot snippet. |
|
Link Color (transcriptLinkColor) |
Sets a color to the hyperlinks displayed in the chatbot. Default color is blue |
|
Border Size (chatBoxBorderSize) |
The border size property defines the thickness of the chatbot snippet border. |
|
Auto Scroll (autoScrollSnapOnPage) |
By default the parameter is set to "true", meaning that the focus is set on the first message sent by the bot and users need to scroll down in the snippet to see subsequent messages. Set the value "false" to set the snippet focus on the last message sent by the bot and not on the first one. Note: This parameter is available in DRUID 5.4 and higher.
|
|
Header |
Text Color (headerTextColor) |
Sets the color of the header text. |
Hover Text Color (headerTextColorOnHover) |
Sets the color for hover of the header buttons. |
|
Bottom Border Radius (headerBottomBorderRadius) |
The bottom border-radius property defines the radius of the chatbot snippet bottom header corners. |
|
Outer Padding (headerOuterPadding) |
The header outer padding property defines the outer padding of the header. |
|
Background Color (headerBackground) |
Sets the background color for the header. |
Color & Paddings
Subcategory |
Parameter |
Description |
---|---|---|
Color & Paddings |
Chat Title (chatTitle) |
Sets the webchat title. |
Accent (accent) |
Sets the color accent for the chatbot snippet. |
|
Background Color (backgroundColor) |
Sets the background color for the chatbot snippet. |
|
Padding Regular (paddingRegular) |
Sets the padding for chatbot messages. |
|
Subtle (subtle) |
Sets the color for subtles in the chatbot snippet (username, botname, timestamp, attach file) |
Fonts
Subcategory |
Parameter |
Description |
---|---|---|
Fonts |
Font Size Small (fontSizeSmall) |
Sets the font size for username, botname and timestamp for each message sent and received by the bot. |
Monospace Font (monospaceFont) |
A monospaced font, also called a fixed-pitch, fixed-width, or non-proportional font, is a font whose letters and characters each occupy the same amount of horizontal space. This font is used for error messages displayed in the chat. |
|
Primary Font (primaryFont) |
Sets the primary font type used in both messages sent by the user and bot. |
|
Root Font Size (rootFontSize) |
Sets the font-size of the root element for each element in the chatbot snippet. |
|
Transcript Font Size (transcriptFontSize) |
Set the font size of the transcript. |
|
Header Font Size (headerFontSize) |
Sets the font-size for each element in the chatbot snippet header. |
|
SendBox Font Size (sendBoxFontSize) |
Sets the font-sizes in the text box for the text written by the user. |
|
Line Height - in REM (lineHeight) |
Sets the line height of the messages in the chatbot snippet. Possible values (normal, number, length, initial, inherit) |
|
Message Activity Word Break (messageActivityWordBreak) |
This property specifies how words should break when reaching the end of a line. Possible values (normal, break-all, break-word, keep all) |
Buttons
Subcategory |
Parameter |
Description |
---|---|---|
Layout |
Padding (buttonsPadding) |
Sets the buttons padding in the conversational flow (e.g. hero card , choices, thumbnail). |
Border Radius (buttonsBorderRadius) |
Sets the border radius of the buttons from the conversational flow (e.g. hero card , choices, thumbnail). |
|
Text Color (buttonsTextColor) |
Sets the text color from the buttons in the conversational flow (e.g. hero card , choices, thumbnail). |
|
Border Color (buttonsBorderColor) |
Sets the border color of the buttons from the conversational flow (e.g. hero card , choices, thumbnail). |
|
Background Color (buttonsBackgroundColor) |
Sets the background color of the buttons in the conversational flow (e.g. hero card , choices, thumbnail). |
|
Hover Background Color (buttonsBackgroundColorOnHover) |
Sets the background color of the hover when going over the buttons in the conversational flow (e.g. hero card , choices, thumbnail). |
|
Hover Text Color (buttonsTextColorOnHover) |
Sets the text color that appears on hover on buttons in the conversational flow (e.g. hero card , choices, thumbnail). |
|
Hover Border Color (buttonsBorderColorOnHover) |
Sets the text color of the buttons border that appear when hover on buttons in the conversational flow (e.g. hero card , choices, thumbnail). |
|
Icons |
Context menu icon (v2_contextMenu_icon) |
Sets the icon for the context menu. Only .svg file format (svg code) is supported. Copy
Context menu icon example
|
Minimize icon (v2_minimize_icon) |
Sets the minimize icon for the context menu. Only .svg file format (svg code) is supported. |
|
Expand chat icon (v2_containerElement_expand_icon) |
The icon shown when the chatbot snippet is collapsed. Users click on it to expand and open the web chat. Only .svg file format (svg code) is supported. |
|
Collapse chat icon (v2_containerElement_collapse_icon) |
Note: Using this feature requires setting the common parameters Show default Close Button (closeButtonEnabled) (section Layout > Common) and Show Close Button (showCloseButton) (section Layout > Header) to true.
The icon shown at the bottom of the chat snippet when it is expanded. Users click on it to collapse the web chat snippet. Only .svg file format (svg code) is supported. The default collapse web chat icon is shown in the figure below. |
Chat Bubble
Subcategory |
Parameter |
Description |
Bot Chat Bubble |
Background (bubbleBackground) |
Sets the background color of the messages sent by the bot. |
Text Color (bubbleTextColor) |
Sets the text color of the messages sent by the bot. |
|
Border Color (bubbleBorderColor) |
Sets the border color of the messages sent by the bot. |
|
Border Radius (bubbleBorderRadius) |
Sets the border radius of the messages sent by the bot. |
|
Border Style (bubbleBorderStyle) |
Sets the border style of the messages sent by the bot. |
|
Border Width (bubbleBorderWidth) |
Sets the border width of the messages sent by the bot. |
|
Nub Size (bubbleNubSize) |
Sets the numb size of the messages sent by the bot. |
|
Nub Offset (bubbleNubOffset) |
Sets the numb direction (top, bottom) of the messages sent by the bot. |
|
User Chat Bubble |
Background (bubbleFromUserBackground) |
Sets the background color of the messages sent by the user. |
Text Color (bubbleFromUserTextColor) |
Sets the text color of the messages sent by the user. |
|
Border Color (bubbleFromUserBorderColor) |
Sets the border color of the messages sent by the user. |
|
Border Radius (bubbleFromUserBorderRadius) |
Sets the border radius of the messages sent by the user. |
|
Border Style (bubbleFromUserBorderStyle) |
Sets the border style of the messages sent by the user. |
|
Border Width (bubbleFromUserBorderWidth) |
Sets the border width of the messages sent by the user. |
|
Nub Size (bubbleFromUserNubSize) |
Sets the numb size of the messages sent by the user. |
|
Nub Offset (bubbleFromUserNubOffset) |
Sets the numb direction (top, bottom) of the messages sent by the user. |
|
Layout |
Image Height (bubbleImageHeight) |
Sets the height of the text boxes sent by the bot and user. |
Max Width (bubbleMaxWidth) |
Sets the max width of the text boxes sent by the bot and user. |
|
Min Height (bubbleMinHeight) |
Sets the min height of the text boxes sent by the bot and user. |
|
Min Width (bubbleMinWidth) |
Sets the min width of the text boxes sent by the bot and user. |
|
Avatar Settings |
Avatar Border Radius (avatarBorderRadius) |
Sets the border radius of the chatbot avatar. |
Avatar Size (avatarSize) |
Sets the size of the chatbot avatar. |
|
Bot Avatar |
Background Color (botAvatarBackgroundColor) |
Sets the background color of the chatbot avatar. |
Image (botAvatarImage) |
Fill in the url of your bot avatar (png, jpg, etc.). |
|
User Avatar |
Background Color (userAvatarBackgroundColor) |
Sets the background color of the users avatar. |
Image (userAvatarImage) |
Fill in the url of your user avatar. Expected format should be png, jpg. |
Connectivity UI
Subcategory |
Parameter |
Description |
---|---|---|
Slow Connection Timeout |
Slow Connection After (slowConnectionAfter) |
Sets after how much time expressed in milliseconds the slow connectivity message to appear. Default value is 15 seconds. |
Send Box
Subcategory |
Parameter |
Description |
---|---|---|
Layout |
Height (sendBoxHeight) |
Sets the height of the entire send box. |
Max Height (sendBoxMaxHeight) |
Sets the max height of the input when the sendbox input is multilined. |
|
Padding Left and Right (DruidSendBoxPaddingLeftRight) |
Sets the left padding of the entire send box. |
|
Padding Top (DruidSendBoxPaddingTop) |
Sets the top padding of the entire send box. |
|
Padding Left and Right (DruidSendBoxPaddingLeftRight) |
Sets the same padding to both left and right side of the entire send box. |
|
Padding Bottom (DruidSendBoxPaddingBottom) |
Sets the bottom padding of the entire send box. |
|
Inner padding (DruidSendBoxTextBoxPadding) |
Sets the inner padding for the inner box "Type your message". |
|
Inner padding Left and Right (DruidSendBoxInnerPaddingLeftRight) |
Sets the same padding to both left and right side of the inner box "Type your message". |
|
Inner padding Top and Bottom (DruidSendBoxInnerPaddingTopBottom) |
Sets the top and bottom padding of the inner box "Type your message". |
|
Hide Send Box (hideDruidSendBox) |
When this property is checked , it will hide the entire send box. |
|
Hide Upload Button (hideUploadButton) |
When this property is checked , it will hide the upload file button from the send box unless the flow step if of the File Upload. |
|
Enable replying to messages (replyToMessageEnabled) |
If enabled, it allows helpdesk agents engaged in a conversation with a user to reply any user message in the Active conversation section. Note: This parameter is available in DRUID 8.13 and higher.
|
|
Text Wrap (sendBoxTextWrap) |
When this property is checked , it allows the user's text to be continued to the next line when the side of the typing box is reached. |
|
Colors |
Text Color (sendBoxTextColor) |
Sets the color of the users text message as you type. |
Background Color (sendBoxBackground) |
Sets the background color of the entire send box. |
|
Disabled Text Color (sendBoxDisabledTextColor) |
When you enable on a flow step the property "Block User Input", setting this text color will change the color of the 'Type your message here' from the send box when the input from the user is disabled. |
|
Placeholder Color (sendBoxPlaceholderColor) |
Sets the text color of the placeholder from the send box. Right now the message displayed is "Type your message" |
|
Button Colors |
Default (sendBoxButtonColor) |
Sets the color of the send box buttons such as contextual menu, attach file and send icon. |
On Disabled (sendBoxButtonColorOnDisabled) |
Sets the color of the buttons from the send box when they are disabled. |
|
On Focus (sendBoxButtonColorOnFocus) |
Sets the color of the buttons from the send box when they are on focus. |
|
On Hover (sendBoxButtonColorOnHover) |
Sets the hover color of the buttons from the send box such as contextual menu, attach file and send icon. |
|
Microphone Button Color On Dictate (microphoneButtonColorOnDictate) |
The color of the microphone button (from the sendbox) when dictate (listening) is active. |
Suggested Actions
Subcategory |
Parameter |
Description |
Colors |
Background Color (suggestedActionBackground) |
Changes the button background display color for the flow steps of type choice. |
Color (suggestedActionTextColor) |
Changes the hover background color for the flow steps of type choice. |
|
Text Color (Disabled) (suggestedActionDisabledTextColor) |
Sets the text color of the choice buttons when this flow step has the property "Block user Input" active. |
|
Background Color (Disabled) (suggestedActionDisabledBackground) |
Sets the background color of the choice buttons when this flow step has the property "Block user Input" active. |
|
Border |
Border (suggestedActionBorderColor) |
Sets the border color of the choice buttons when they appear in conversation. |
Radius (suggestedActionBorderRadius) |
Sets the border radius of the choice buttons when they appear in conversation. |
|
Style (suggestedActionBorderStyle) |
Sets the border style of the choice buttons that appear in the conversation. E.g., You may set the border line for all choice buttons to be dotted. |
|
Width (suggestedActionBorderWidth) |
Sets the width of the border for each choice button that appears in conversation. |
|
Border (Disabled) |
Border (suggestedActionDisabledBorderColor) |
Sets the border color of the choice buttons when on the flow step the property "Block User Input" is enabled. |
Color (suggestedActionDisabledBackground) |
Sets the background color of the choice buttons when on the flow step the property "Block User Input" is enabled. |
|
Style (suggestedActionDisabledBorderStyle) |
Sets the border style of the choice buttons that appear in the conversation when on the flow step the property "Block User Input", is enabled. E.g., You may set the borderline for all choice buttons to be dotted when block user input is available. |
|
Width (suggestedActionDisabledBorderWidth) |
Sets the width of the border for each choice button that appears in conversation, when on the flow step the property "Block User Input" is enabled. |
|
Layout |
Height (suggestedActionHeight) |
Sets the height of the choice buttons. |
Layout (suggestedActionLayout) |
Sets the layout of the choice buttons. Posible values are flow, carousel, stacked. |
|
Carousel Flipper |
Box Width (suggestedActionsCarouselFlipperBoxWidth) |
Sets the width of the container in which the choice buttons appear, and the suggestedActionLayout is set to carousel. |
Size (suggestedActionsCarouselFlipperSize) |
Sets the size of the container in which the choice buttons appear, and the suggestedActionLayout is set to carousel. |
|
Container |
Max Height (suggestedActionsStackedHeight) |
Sets the height of the container, which has the property suggestedActionLayout set to stacked. |
Timestamp and Status
Subcategory |
Parameter |
Description |
---|---|---|
Timestamp |
Group Timestamp (groupTimestamp) |
When this option is disabled the time stamp that appears under each status message sent by the bot or by the user, will be hidden. The default value is set to true. |
Send Timeout (sendTimeout) |
Set it in milliseconds and it will trigger after how much time you receive the send failed status of the message. For example, you can receive this message when you lose your internet connection or service is down, etc. |
|
Send Timeout for Attachments (sendTimeoutForAttachments) |
Set it in milliseconds and it will trigger after how much time you receive the send failed status on the flow steps where is required a file upload. For example, you can receive this message when you loose your internet connection or service is down, etc. |
|
Color (timestampColor) |
Sets the color of the time stamp text. |
|
Format (timestampFormat) |
Sets the format of the time stamp. Possible values can be relative or absolute (the full time of the message is displayed). |
|
Custom Timestamp Format (customTimestampFormat) | Sets the format of the timestamp. E.g., DD.MM.YYYY HH:mm. | |
Status |
Status Read Color (activityStatusReadColor) |
Below each message sent and read by the user or by the bot and in line with the time stamp, an activity status message appears like a bubble. Setting the color for this option will change the color of the bubble status message. |
Status Bot Name (activityStatusBotName) |
Sets the name under the messages sent by the bot. Default value is the bot name. |
|
Show Bot Name (activityStatusShowBotName) |
If you check this option, under the messages sent by the bot will also appear the bot name. If this option is unchecked, only the timestamp will appear under the messages sent by the bot. |
|
Status User Name (activityStatusUserName) |
Sets the username under the messages sent by the user. Default value is "User". |
|
Show User Name (activityStatusShowUserName) |
If you check this option, under the messages sent by the user will also appear the username. If this option is unchecked, only the timestamp will appear under the messages sent by the user. |
|
Show Actions for Bot Messages (botActivitiesActionsEnabled) |
Enables interactive actions, such as copy bot message, thumbs-up and thumbs-down feedback, on bot messages in web chat. Note: This parameter is available in DRUID 8.10 and higher.
|
Toast UI
Subcategory |
Parameter |
Description |
---|---|---|
Toaster Layout |
Hide Toaster (hideToaster) |
If you check this option, all alert messages sent by default by the chatbot such as inactivity status or connectivity issues in the chatbot will be hidden. |
Height (toasterHeight) |
Sets the height of the toaster box message. |
|
Max Height (toasterMaxHeight) |
Sets the max height of the toaster box message. |
|
Toaster Styling |
Font Size (toastFontSize) |
Sets the font size of the messages that appear at different statuses on the toaster. |
Icon Width (toastIconWidth) |
Sets the icon width for each status that appears on the toaste (alert, exclamation mark, etc). |
|
Separator Color (toastSeparatorColor) |
Sets the color of the separator between consecutive toast messages. |
|
Text Padding (toastTextPadding) |
Sets the padding of the text that appears in the toast. |
|
Error |
Color (toastErrorColor) |
When the error message is raised by the chatbot, you can customize the color of the text error message. |
Background Color (toastErrorBackgroundColor) |
When the error message is raised by the chatbot, you can customize the background color on which the error message appears. |
|
Info |
Color (toastInfoColor) |
When the info message is raised by the chatbot, you can customize the color of the text info message. |
Background Color (toastInfoBackgroundColor) |
When the info message is raised by the chatbot, you can customize the background color on which the info message appears. |
|
Success |
Color (toastSuccessColor) |
When the success message is raised by the chatbot, you can customize the color of the text success message. |
Background Color (toastSuccessBackgroundColor) |
When the success message is raised by the chatbot, you can customize the background color on which the success message appears. |
|
Warn |
Color (toastWarnColor) |
When the warn message is raised by the chatbot, you can customize the color of the warn success message. |
Background Color (toastWarnBackgroundColor) |
When the warn message is raised by the chatbot, you can customize the background color on which the warn message appears. |
Transcript Overlay Buttons
Subcategory |
Parameter |
Description |
---|---|---|
Button: Default |
Color (transcriptOverlayButtonColor) |
The text color of the buttons that appear at overlay (e.g. more messages). |
Background Color (transcriptOverlayButtonBackground) |
The background color of the buttons that appear at overlay (e.g. more messages). |
|
Button: On Focus |
Color (transcriptOverlayButtonColorOnFocus) |
The text color of the buttons that appear on focus. |
Background Color (transcriptOverlayButtonBackgroundOnFocus) |
The background color of the buttons that appear on focus. |
|
Button: On Hover |
Color (transcriptOverlayButtonColorOnHover) |
The text color of the buttons that appear on hover. |
Background Color (transcriptOverlayButtonBackgroundOnHover) |
The background color of the buttons that appear on hover. |
|
Button: Scroll to end |
Behavior (scrollToEndButtonBehavior) |
Sets the behavior of the scroll to end button. For example from here you can disable the scroll to end button. |
Button Font Size (scrollToEndButtonFontSize) |
Sets the font size of the scroll to end button. |
Miscellaneous
Subcategory |
Parameter |
Description |
---|---|---|
Miscellaneous |
Rich Card Wrap Title (richCardWrapTitle) |
Used for cards (e.g. hero, thumbnail) where is set long text in Title area and it needs to be wrapped. |
Disable Typing Animation | Disables the dots displayed when a helpdesk agent is typing in the chat. | |
Show typing name | During Live Chat sessions, replaces the standard typing indicator dots with the agent's name. |
Custom Styling
Subcategory |
Parameter |
Description |
---|---|---|
Druid StyleSet (customDruidStyleSet) |
css file |
Include here your custom CSS. |
Advanced Options
This section provides you with advanced chat settings. For advanced settings, use the default template from the editor. If you need help settings up chat advanced parameters, get in touch with Druid Support.