Skip to content

Commit

Permalink
feat: documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
haideralsh committed Dec 5, 2024
1 parent 6537b5a commit 7c87ca8
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/TopBar/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 7c87ca8

Please sign in to comment.