Files
directus/docs/reference/app/components/v-menu.md
Nitwel c2e7c85bbd Update documentation of app (#4222)
* move component docs to documentation

* update app docs tables for components

* update docs

* Add components to docs sidebar

* fix generated tables

* fix tables

* rename transitions

* update tables

* update nested components

* update tables

* update tables

* update tables

* update v-table table

* add basic documentation to each component

* remove all stories of storybook

* add missing documentation

* undate tables

* update tables

* update docs sidebar

* update app docs

* remove unused references

* add general readme

* update docs

* make reference titiles smaller

* add reference tag

* improve docs

* update order of tabs in sidebar

* remove all readmes and stories from interfaces/displays

* Cleanup menu

* Remove storybook

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-02-24 17:48:19 -05:00

43 lines
2.2 KiB
Markdown

# Menu
Renders a dropdown menu. Can be attached to an activator element or free floating.
**NOTE**
Due to the fact that a menu is rendered through a portal, dialogs don't work great when rendered from within a menu.
## Reference
#### Props
| Prop | Description | Default | Type |
| ------------------------ | ----------------------------------------------------------------- | ----------- | ----------- |
| `placement` | Where to position the popper. | `'bottom'` | `Placement` |
| `value` | Value to control menu active state | `undefined` | `Boolean` |
| `close-on-click` | Close the menu when clicking outside of the menu | `true` | `Boolean` |
| `close-on-content-click` | Close the menu when clicking the content of the menu | `true` | `Boolean` |
| `attached` | Attach the menu to an input | `false` | `Boolean` |
| `show-arrow` | Show an arrow pointer | `false` | `Boolean` |
| `disabled` | Menu does not appear | `false` | `Boolean` |
| `trigger` | Activate the menu on a trigger. One of `manual`, `click`, `hover` | `null` | `String` |
| `delay` | Time in ms before menu activates after trigger | `0` | `Number` |
#### CSS Variables
| Variable | Default |
| -------------------- | ------- |
| `--v-menu-min-width` | `100px` |
#### Events
| Event | Description | Value |
| ------- | ---------------------------- | --------- |
| `input` | Used to model the value prop | `Boolean` |
#### Slots
| Slot | Description | Data |
| ----------- | ------------------------------------------------- | ---- |
| `activator` | The activator for the menu | |
| _default_ | Elements that should be displayed inside the menu | |