From 91d345f5f22a325389e3d0d0aa83cf459c1d003a Mon Sep 17 00:00:00 2001 From: Rebecca Alpert Date: Fri, 13 Dec 2024 12:15:49 -0500 Subject: [PATCH] Update packages/module/patternfly-docs/content/extensions/chatbot/examples/Messages/Messages.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../chatbot/examples/Messages/Messages.md | 15 +++++++++++++-- .../extensions/chatbot/examples/demos/Chatbot.md | 4 ++-- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/examples/Messages/Messages.md b/packages/module/patternfly-docs/content/extensions/chatbot/examples/Messages/Messages.md index 0f28761d..7033369a 100644 --- a/packages/module/patternfly-docs/content/extensions/chatbot/examples/Messages/Messages.md +++ b/packages/module/patternfly-docs/content/extensions/chatbot/examples/Messages/Messages.md @@ -63,7 +63,7 @@ You can further customize the avatar by applying an additional class or passing ``` -### Messages actions +### Message actions You can add actions to a message, to allow users to interact with the message content. These actions can include: @@ -79,7 +79,18 @@ You can add actions to a message, to allow users to interact with the message co ### Custom message actions -Beyond the standard message actions (positive, negative, copy, share, or listen), you can add custom actions to a bot message by passing an `actions` object to the `` component. This object can contain the following customizations: `ariaLabel`, `clickedAriaLabel`, `onClick`, `className`, `isDisabled`, `tooltipContent`, `tooltipContent`, `tooltipProps`, and `icon`. `clickedAriaLabel` and `clickedTooltipContent` are applied only when a button is clicked. If `clickedAriaLabel` or `clickedTooltipContent` are omitted, they will default to the `ariaLabel` or `tooltipContent` supplied. +Beyond the standard message actions (good response, bad response, copy, share, or listen), you can add custom actions to a bot message by passing an `actions` object to the `` component. This object can contain the following customizations: + +- `ariaLabel` +- `onClick` +- `className` +- `isDisabled` +- `tooltipContent` +- `tooltipContent` +- `tooltipProps` +- `icon` + +You can apply a `clickedAriaLabel` and `clickedTooltipContent` once a button is clicked. If either of these props are omitted, their values will default to the `ariaLabel` or `tooltipContent` supplied. ```js file="./MessageWithCustomResponseActions.tsx" diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/examples/demos/Chatbot.md b/packages/module/patternfly-docs/content/extensions/chatbot/examples/demos/Chatbot.md index 4db1d10c..81a8ee63 100644 --- a/packages/module/patternfly-docs/content/extensions/chatbot/examples/demos/Chatbot.md +++ b/packages/module/patternfly-docs/content/extensions/chatbot/examples/demos/Chatbot.md @@ -66,7 +66,7 @@ This demo displays a basic ChatBot, which includes: 4. [`` and ``](/patternfly-ai/chatbot/ui#content-and-message-box) with: - A `` -- An initial [user ``](/patternfly-ai/chatbot/messages#user-messages) and an initial bot message with [message actions.](/patternfly-ai/chatbot/messages#messages-actions) +- An initial [user ``](/patternfly-ai/chatbot/messages#user-messages) and an initial bot message with [message actions.](/patternfly-ai/chatbot/messages#message-actions) - Logic for enabling auto-scrolling to the most recent message whenever a new message is sent or received using a `scrollToBottomRef` 5. A [``](/patternfly-ai/chatbot/ui#footer) with a [``](/patternfly-ai/chatbot/ui#footnote-with-popover) and a `` that contains the abilities of: @@ -92,7 +92,7 @@ This demo displays an embedded ChatBot. Embedded ChatBots are meant to be placed 3. A [``](/patternfly-ai/chatbot/ui#header) with all built sub-components laid out, including a `` 4. [`` and ``](/patternfly-ai/chatbot/ui#content-and-message-box) with: - A `` - - An initial [user ``](/patternfly-ai/chatbot/messages#user-messages) and an initial bot message with [message actions.](/patternfly-ai/chatbot/messages/#messages-actions) + - An initial [user ``](/patternfly-ai/chatbot/messages#user-messages) and an initial bot message with [message actions.](/patternfly-ai/chatbot/messages/#message-actions) - Logic for enabling auto-scrolling to the most recent message whenever a new message is sent or received using a `scrollToBottomRef` 5. A [``](/patternfly-ai/chatbot/ui#footer) with a [``](/patternfly-ai/chatbot/ui#footnote-with-popover) and a `` that contains the abilities of: - [Speech to text.](/patternfly-ai/chatbot/ui#message-bar-with-speech-recognition-and-file-attachment)