From 7c87ca86bc1f6ba046deb5035bd03291223ad6a7 Mon Sep 17 00:00:00 2001 From: Haider Alshamma Date: Thu, 5 Dec 2024 17:22:33 -0500 Subject: [PATCH] feat: documentation improvements --- src/TopBar/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/TopBar/README.md b/src/TopBar/README.md index 2a6616200..880f85e8b 100644 --- a/src/TopBar/README.md +++ b/src/TopBar/README.md @@ -1,6 +1,8 @@ # TopBar -The TopBar component provides users a consistent navigation experience across touch application page. It combines functionality from the `Header` and the `BrandedNavBar` components. +The TopBar component provides users a consistent navigation experience across touch application pages. +It combines functionality from the desktop `Header` and the `BrandedNavBar` components. +The component is meant to be used in applications where the primary input device is a touch screen. ## Basic Usage @@ -78,6 +80,7 @@ Individual menu items with icons and descriptions. Extends and accepts props for ## Accessibility - Menu sets the focus to the first in the menu when opened, returns the focus to the menu trigger when closed +- When the Menu is opened, the focus is trapped within the menu - Supports keyboard navigation - Includes proper ARIA labels for the menu