ant-design-vue/components/dropdown/index.en-US.md

46 lines
2.6 KiB
Markdown
Raw Normal View History

2018-01-29 10:57:20 +00:00
## API
### Dropdown
| Property | Description | Type | Default |
2019-09-28 12:45:07 +00:00
| --- | --- | --- | --- |
2018-01-29 10:57:20 +00:00
| disabled | whether the dropdown menu is disabled | boolean | - |
| getPopupContainer | to set the container of the dropdown menu. The default is to create a `div` element in `body`, you can reset it to the scrolling area and make a relative reposition. [example](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | Function(triggerNode) | `() => document.body` |
2019-09-10 10:57:08 +00:00
| overlay(slot-scope) | the dropdown menu | [Menu](/components/menu) | - |
| overlayClassName | Class name of the dropdown root element | string | - |
| overlayStyle | Style of the dropdown root element | object | - |
2018-01-29 10:57:20 +00:00
| placement | placement of pop menu: `bottomLeft` `bottomCenter` `bottomRight` `topLeft` `topCenter` `topRight` | String | `bottomLeft` |
2019-04-10 02:09:00 +00:00
| trigger | the trigger mode which executes the drop-down action, hover doesn't work on mobile device | Array<`click`\|`hover`\|`contextmenu`> | `['hover']` |
2018-01-29 10:57:20 +00:00
| visible(v-model) | whether the dropdown menu is visible | boolean | - |
### events
2019-09-28 12:45:07 +00:00
2018-01-29 10:57:20 +00:00
| Events Name | Description | Arguments |
| --- | --- | --- |
2019-09-28 12:45:07 +00:00
| visibleChange | a callback function takes an argument: `visible`, is executed when the visible state is changed | function(visible) |
2018-01-29 10:57:20 +00:00
2019-02-16 08:51:21 +00:00
You should use [Menu](/components/menu/) as `overlay`. The menu items and dividers are also available by using `Menu.Item` and `Menu.Divider`.
2018-01-29 10:57:20 +00:00
> Warning: You must set a unique `key` for `Menu.Item`.
>
> Menu of Dropdown is unselectable by default, you can make it selectable via `<Menu selectable>`.
### Dropdown.Button
| Property | Description | Type | Default |
2019-09-28 12:45:07 +00:00
| --- | --- | --- | --- |
2018-01-29 10:57:20 +00:00
| disabled | whether the dropdown menu is disabled | boolean | - |
2019-09-10 10:57:08 +00:00
| overlay(slot-scope) | the dropdown menu | [Menu](/components/menu) | - |
2018-01-29 10:57:20 +00:00
| placement | placement of pop menu: `bottomLeft` `bottomCenter` `bottomRight` `topLeft` `topCenter` `topRight` | String | `bottomLeft` |
2019-02-16 08:51:21 +00:00
| size | size of the button, the same as [Button](/components/button) | string | `default` |
2018-03-23 13:30:20 +00:00
| trigger | the trigger mode which executes the drop-down action | Array&lt;`click`\|`hover`\|`contextmenu`> | `['hover']` |
2019-02-16 08:51:21 +00:00
| type | type of the button, the same as [Button](/components/button) | string | `default` |
2018-01-29 10:57:20 +00:00
| visible | whether the dropdown menu is visible | boolean | - |
### Dropdown.Button events
2019-09-28 12:45:07 +00:00
2018-01-29 10:57:20 +00:00
| Events Name | Description | Arguments |
| --- | --- | --- |
2019-02-16 08:51:21 +00:00
| click | a callback function, the same as [Button](/components/button), which will be executed when you click the button on the left | Function |
2018-01-29 10:57:20 +00:00
| visibleChange | a callback function takes an argument: `visible`, is executed when the visible state is changed | Function |