README

WordPress · Aug 31, 2022 · 9c38277 · 9c38277
1 parent d1455f7
commit 9c38277
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/components/src/navigable-container/README.md b/packages/components/src/navigable-container/README.md
@@ -39,6 +39,8 @@ The orientation of the menu. It could be "vertical", "horizontal" or "both"
 
 A NavigableMenu allows movement up and down (or left and right) the component via the arrow keys. The `tab` key is not handled. The `orientation` prop is used to determine whether the arrow keys used are vertical, horizontal or both.
 
+The `NavigableMenu` by default has a `menu` role and therefore, in order to function as expected, the component expects its children elements to have one of the following roles: `'menuitem' | 'menuitemradio' | 'menuitemcheckbox'`.
+
 ### TabbableContainer
 
 A `TabbableContainer` will only be navigated using the `tab` key. Every intended tabstop must have a tabIndex `0`.