From c42232e1503c876807390e9fe5618ed58f3075d0 Mon Sep 17 00:00:00 2001 From: Brian Krabach Date: Tue, 26 Nov 2024 17:29:10 +0000 Subject: [PATCH] updates docs for message metadata in UX --- workbench-app/docs/MESSAGE_METADATA.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/workbench-app/docs/MESSAGE_METADATA.md b/workbench-app/docs/MESSAGE_METADATA.md index b615a1de..c17b93fa 100644 --- a/workbench-app/docs/MESSAGE_METADATA.md +++ b/workbench-app/docs/MESSAGE_METADATA.md @@ -6,6 +6,8 @@ The app has built-in support for a few metadata child properties, which can be u - `attribution`: A string that will be displayed after the sender of the message. The intent is to allow the sender to indicate the source of the message, possibly coming from an internal part of its system. +- `href`: If provided, the app will display the message as a hyperlink. The value of this property will be used as the URL of the hyperlink and use the React Router navigation system to navigate to the URL when the user clicks on the message. Will be ignored for messages of type `chat`. + - `debug`: A dictionary that can contain additional information that can be used for debugging purposes. If included, it will cause the app to display a button that will allow the user to see the contents of the dictionary in a popup for further inspection. - `footer_items`: A list of strings that will be displayed in the footer of the message. The intent is to allow the sender to include additional information that is not part of the message body, but is still relevant to the message.