diff --git a/packages/components/src/dropdown-menu/README.md b/packages/components/src/dropdown-menu/README.md index 4d934a3ee92045..9346140bb27ef0 100644 --- a/packages/components/src/dropdown-menu/README.md +++ b/packages/components/src/dropdown-menu/README.md @@ -1,8 +1,60 @@ -# Dropdown Menu +# DropdownMenu -Dropdown Menu is a React component to render an expandable menu of buttons. It is similar in purpose to a `` element, with the distinction that it does not maintain a value. Instead, each option behaves as an action button. + +### Usage Render a Dropdown Menu with a set of controls: @@ -39,11 +91,11 @@ const MyDropdownMenu = () => ( ); ``` -## Props +### Props The component accepts the following props: -### icon +#### icon The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug to be shown in the collapsed menu button. @@ -53,14 +105,14 @@ The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug to See also: [https://developer.wordpress.org/resource/dashicons/](https://developer.wordpress.org/resource/dashicons/) -### label +#### label A human-readable label to present as accessibility text on the focused collapsed menu button. - Type: `String` - Required: Yes -### controls +#### controls An array of objects describing the options to be shown in the expanded menu.