Skip to content

Commit 03cb751

Browse files
Merge pull request #836 from edonehoo/iss811-1
docs(design-guidelines): Adds new AI icons and updates guidance.
2 parents b830b8c + dad302f commit 03cb751

40 files changed

Lines changed: 2636 additions & 1806 deletions

package-lock.json

Lines changed: 54 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ source: design-guidelines
88

99
import "./images.css"
1010

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+
1113
## Elements
1214

1315
<div class="ws-docs-content-img">
@@ -39,6 +41,16 @@ import "./images.css"
3941
1. **Quick responses:** Programmable, clickable actions that allow users to quickly answer questions from the ChatBot.
4042
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.
4143

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+
<div class="ws-docs-content-img">
51+
![Gallery of different color options for the avatar.](./img/avatar-options.svg)
52+
</div>
53+
4254
#### Welcome message
4355

4456
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
7183
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.
7284

7385
<div class="ws-docs-content-img">
74-
![A single source card is show below a chatbot message.](./img/source-card-summary.svg)
86+
![A single source card is shown below a chatbot message.](./img/source-card-summary.svg)
7587
</div>
7688

7789
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&mdash;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
248260
![Toggle with notification badge.](./img/chatbot-toggle-notification.svg)
249261
</div>
250262

251-
If necessary for brand consistency, you can customize the toggle shape and icon.
252-
253-
<div class="ws-docs-content-img">
254-
![Different toggle shapes and icons.](./img/toggle-customizations.svg)
255-
</div>
256-
257263
#### Masthead toggle
258264

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:
260266

261267
<div class="ws-docs-content-img">
262268
![ChatBot toggle in a masthead.](./img/masthead-toggle.svg)
263269
</div>
264270

265-
The exception to this is if you have a specific icon that aligns with your product or ChatBot branding.
266-
267271
When there is an unread message from the ChatBot, a notification count should be displayed, and the badge should be styled as unread.
268272

269273
<div class="ws-docs-content-img">
@@ -272,7 +276,7 @@ When there is an unread message from the ChatBot, a notification count should be
272276

273277
### Launching a ChatBot from page content
274278

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.
276280

277281
<div class="ws-docs-content-img">
278282
![Menu item for an AI action that launches a ChatBot.](./img/ai-action-inpage.svg)

packages/module/patternfly-docs/content/extensions/chatbot/img/ai-action-inpage.svg

Lines changed: 56 additions & 51 deletions
Loading

packages/module/patternfly-docs/content/extensions/chatbot/img/ai-action-message.svg

Lines changed: 37 additions & 31 deletions
Loading

packages/module/patternfly-docs/content/extensions/chatbot/img/attached-file.svg

Lines changed: 7 additions & 7 deletions
Loading

packages/module/patternfly-docs/content/extensions/chatbot/img/attachment-menu.svg

Lines changed: 88 additions & 81 deletions
Loading

packages/module/patternfly-docs/content/extensions/chatbot/img/attachment-unsent.svg

Lines changed: 23 additions & 35 deletions
Loading

packages/module/patternfly-docs/content/extensions/chatbot/img/avatar-options.svg

Lines changed: 423 additions & 0 deletions
Loading

packages/module/patternfly-docs/content/extensions/chatbot/img/chatbot-elements.svg

Lines changed: 77 additions & 70 deletions
Loading

packages/module/patternfly-docs/content/extensions/chatbot/img/chatbot-quickstarts-tile.svg

Lines changed: 36 additions & 32 deletions
Loading

0 commit comments

Comments
 (0)