consul

History

John Cowen 121bd2e0ab ui: PagedCollection component (#12404 ) * ui: PagedCollection component * ui: Use PagedCollection (#12436) * ui: Integrate PagedCollection into DisclosureMenu * Integrate PageCollection into DC, Nspace and Partition menus		2022-02-25 10:01:08 +00:00
..
action	ui: Transition App Chrome to use new Disclosure Menus (#12334 )	2022-02-21 12:22:59 +00:00
item	ui: aria-menu modifier (#12262 )	2022-02-09 09:47:45 +00:00
separator	ui: Transition App Chrome to use new Disclosure Menus (#12334 )	2022-02-21 12:22:59 +00:00
README.mdx	ui: aria-menu modifier (#12262 )	2022-02-09 09:47:45 +00:00
index.hbs	ui: PagedCollection component (#12404 )	2022-02-25 10:01:08 +00:00

README.mdx

# Menu

A component use for menu systems with the correct aria attributes applied.
Internally uses our `{{aria-menu}}` modifier for aria keyboarding.

Additionally it is made to work in tandem with the `<Disclosure />` component if
required (a relatively common usecase)

This component should not be used for top site navigation, but it should be used
for menus within the top site navigation for choosing options, for example
choosing a namespace or partition etc.

```hbs preview-template
<Menu as |menu|>
  <menu.Item>
    <menu.Action>Item 1</menu.Action>
  </menu.Item>
  <menu.Separator />
  <menu.Item>
    <menu.Action>Item 2</menu.Action>
  </menu.Item>
  <menu.Separator>
    Title
  </menu.Separator>
  <menu.Item>
    <menu.Action>Item 3</menu.Action>
  </menu.Item>
</Menu>
```

## Arguments

| Argument | Type | Default | Description |
| --- | --- | --- | --- |
| `disclosure` | `DisclosureInterface` | | An object with following the `<Disclosure />` components API. When used no other arguments are necessary |
| `onclose` | `function` | | A function to call when a menu close is requested |
| `event` | `Event` | | A potential event used to open the menu |

## Exported API

| Name | Type | Description |
| --- | --- | --- |
| `Item` | `GlimmerComponent` | A component for adding a menu item with aria attributes correctly applied |
| `Separator` | `GlimmerComponent` | A component to be used for separating sections in the menu with aria attributes correctly applied. When used as block component you can add some sort of testual title to the separator |
| `Action` | `GlimmerComponent` | A contextual '<Action />' component with aria attributes correctly applied |


## See

- [Template Source Code](./index.hbs)

---