Skip to content

Commit 2f25b87

Browse files
authored
chore(docs): Updates design guidelines with transcript pattern and new chat button. (#672)
1 parent e1092d3 commit 2f25b87

16 files changed

Lines changed: 653 additions & 448 deletions

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

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ The following actions can be used for some of the most common interactions:
8888
1. **Feedback (good response):** Applies a positive rating to the message.
8989
1. **Feedback (bad response):** Applies a negative rating to the message.
9090
1. **Copy:** Copies the message content to the clipboard.
91+
1. **Download:** Downloads the chat message. [Learn more about downloading chat transcripts](#downloading-chat-transcripts).
9192
1. **Listen:** Reads the message content out loud.
9293

9394
You can also use [custom message actions](/patternfly-ai/chatbot/messages#custom-message-actions) as needed for your particular use case. When using custom actions, be sure to add a tooltip that describes the effect that the action will have. For more information, view [our tooltips guidelines](/ux-writing/tooltips).
@@ -340,6 +341,38 @@ If a message attachment fails, an error message should share the reason for fail
340341
![Error alert for failed attachment.](./img/attachment-error.svg)
341342
</div>
342343

344+
### Downloading chat transcripts
345+
346+
You can enable users to download chat transcripts, for their personal records or to share with others. When users choose to download a transcript, you can choose how you want to configure the behavior in your ChatBot.
347+
348+
For guidance, refer to our download transcripts demo, which opens a Markdown file for a conversation within a new tab.
349+
350+
Choose the download action location that best works for your ChatBot:
351+
352+
#### Download via conversation history drawer
353+
354+
If your ChatBot uses a conversation history drawer, you can provide a download option in the [actions menu linked to a previous conversation](/patternfly-ai/chatbot/ui#drawer-with-conversation-actions).
355+
356+
<div class="ws-docs-content-img">
357+
![Expanded menu for previous chat in the history window, which shows a download option.](./img/download-chat-history.svg)
358+
</div>
359+
360+
#### Download message response action
361+
362+
To allow users to download individual bot messages, the message actions can include a download option.
363+
364+
<div class="ws-docs-content-img">
365+
![Download action for a message from a bot.](./img/download-message-action.svg)
366+
</div>
367+
368+
#### Download control in header
369+
370+
If you don't use a conversation history drawer, you can place an option to download the transcript for the active chat within the header options menu.
371+
372+
<div class="ws-docs-content-img">
373+
![Download transcript action within the ChatBot header options menu.](./img/download-header.svg)
374+
</div>
375+
343376
## Variations
344377

345378
### Display modes
@@ -400,4 +433,4 @@ For guidance on writing ChatBot content, refer to our [conversation design guide
400433

401434
## Accessibility
402435

403-
Although accessibility has been integrated into the design of our ChatBot components, it is important to ensure that your implementation is inclusive of all users. For more guidance, refer to [our accessibility guidelines](/accessibility/about-accessibility).
436+
Although accessibility has been integrated into the design of our ChatBot components, it is important to ensure that your implementation is inclusive of all users. For more guidance, refer to [our accessibility guidelines](/accessibility/about-accessibility).

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

Lines changed: 61 additions & 59 deletions
Loading

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

Lines changed: 38 additions & 112 deletions
Loading

packages/module/patternfly-docs/content/extensions/chatbot/img/download-chat-history.svg

Lines changed: 57 additions & 0 deletions
Loading

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

Lines changed: 132 additions & 0 deletions
Loading

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

Lines changed: 22 additions & 0 deletions
Loading

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

Lines changed: 21 additions & 14 deletions
Loading

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

Lines changed: 39 additions & 40 deletions
Loading

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

Lines changed: 37 additions & 30 deletions
Loading

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

Lines changed: 17 additions & 12 deletions
Loading

0 commit comments

Comments
 (0)