From f54ee2ef9fb36c5cf7a1c224a0b815dba378105e Mon Sep 17 00:00:00 2001 From: Marie Lucca Date: Fri, 25 Oct 2024 17:10:41 -0400 Subject: [PATCH] docs(ActionList): add a11y guidance around inline descriptions --- content/components/action-list.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/content/components/action-list.mdx b/content/components/action-list.mdx index 2f2fbcaf9..c9b64965a 100644 --- a/content/components/action-list.mdx +++ b/content/components/action-list.mdx @@ -337,6 +337,11 @@ The tooltip and optional dialog should be triggered by a button element that wra +### Inline descriptions + +All `ActionList.Description` are rendered inline (next to the label) by default. For the cases where the description is too long to fit within one line, the content will wrap to a new line. In some cases, it may be desired to have the description be truncated with an ellipsis. This can be achieved by setting the `truncate` prop on the `ActionList.Description` component. Please note that truncating an inline description is only acceptable if the full, non-truncated text can be seen in a subsequent page or screen. It is at the consumer's discretion to use this feature accessibily. + + ### Known accessibility issues (GitHub staff only)