You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ source: design-guidelines
8
8
9
9
import "./images.css"
10
10
11
+
**Note:** These guidelines are specific to ChatBot. Before implementing AI-enabled features, review PatternFly's [AI design language guidelines](/ai/design-language), which cover foundational requirements for AI disclosure, iconography, and color that apply across all Red Hat products.
12
+
11
13
## Elements
12
14
13
15
<divclass="ws-docs-content-img">
@@ -39,6 +41,16 @@ import "./images.css"
39
41
1.**Quick responses:** Programmable, clickable actions that allow users to quickly answer questions from the ChatBot.
40
42
1.**Message actions:** Actions that allow users to interact with a bot message. These typically include providing feedback, copying, sharing, or reading aloud, but [custom message actions](/extensions/chatbot/messages#custom-message-actions) are also supported. More details for the feedback actions can be found in the [message feedback](#message-feedback) section.
41
43
44
+
#### ChatBot avatars
45
+
46
+
There are different color options available for the bot and user avatars within the ChatBot. If desired, you can select a specific color for your ChatBot, but users are not able to change the color of the bot avatar.
47
+
48
+
The default option used is a black icon on a plain background.
49
+
50
+
<divclass="ws-docs-content-img">
51
+

52
+
</div>
53
+
42
54
#### Welcome message
43
55
44
56
At the start of a new chat, you should welcome your users to the ChatBot with a greeting.
@@ -71,7 +83,7 @@ To share relevant resources with users, like documentation containing the answer
71
83
Instead of a short preview of the linked source's content, you can choose to summarize the contents and use that summary as your description. This is helpful for in-depth resources where the context is not clear from the beginning snippet. You can also choose to elevate a quote from the resource that is most relevant to the user's question.
72
84
73
85
<divclass="ws-docs-content-img">
74
-

86
+

75
87
</div>
76
88
77
89
While we generally recommend staying within 2 lines for your source description, you can choose to provide a "show more" button that allows users to expand and view a longer description. When using expandable descriptions, it is recommended to end the description at the end of the sentence. Use your best UX judgment here—extremely lengthy descriptions can quickly fill out the chat window and obstruct previous conversation details.
@@ -248,22 +260,14 @@ When there is an unread message from the ChatBot, a notification badge should be
248
260

249
261
</div>
250
262
251
-
If necessary for brand consistency, you can customize the toggle shape and icon.
252
-
253
-
<divclass="ws-docs-content-img">
254
-

255
-
</div>
256
-
257
263
#### Masthead toggle
258
264
259
-
When the ChatBot toggle is a masthead utility, use the fa-comments icon:
265
+
You can also add a ChatBot toggle as an action in the masthead:
260
266
261
267
<divclass="ws-docs-content-img">
262
268

263
269
</div>
264
270
265
-
The exception to this is if you have a specific icon that aligns with your product or ChatBot branding.
266
-
267
271
When there is an unread message from the ChatBot, a notification count should be displayed, and the badge should be styled as unread.
268
272
269
273
<divclass="ws-docs-content-img">
@@ -272,7 +276,7 @@ When there is an unread message from the ChatBot, a notification count should be
272
276
273
277
### Launching a ChatBot from page content
274
278
275
-
If a UI element within the page content is an AI/ChatBot-supported feature, the ChatBot should be launched when users select the clearly-identified action. These kinds of actions should display your ChatBot's logo beside a label that clearly communicates the intention of the AI action.
279
+
If a UI element within the page content is an AI/ChatBot-supported feature, the ChatBot should be launched when users select the clearly-identified action. These kinds of actions should use the appropriate [AI icon and text label](/ai/design-language#iconography) that clearly communicates the intention of the action.
276
280
277
281
<divclass="ws-docs-content-img">
278
282

0 commit comments