ant-design/components/dropdown/index.en-US.md
Xiaohan Lee bb195ee95f Docs: update docs for Dropdown.Button (#7071)
* add "size" api document
2017-08-04 09:42:32 +08:00

2.8 KiB

category type title
Components Navigation Dropdown

A dropdown list.

When To Use

If there are too many operations to display, you can wrap them in a Dropdown. By clicking/hovering on the trigger, a dropdown menu should appear, which allows you to choose one option and execute relevant actions.

API

Dropdown

Property Description Type Default
trigger the trigger mode which can execute the drop-down action Array<'click'|'hover'> ['hover']
overlay the dropdown menu Menu -
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 Function(triggerNode) () => document.body
visible determine whether the dropdown menu is visible boolean -
onVisibleChange a callback function takes an argument: visible, can be executed when the visible state is changing Function(visible) -
placement placement of pop menu: bottomLeft bottomCenter bottomRight topLeft topCenter topRight String bottomLeft

You can get the menu list by antd.Menu, and set a callback function onSelect for it if you need. The menu items and the dividers are also available, by using Menu.Item and Menu.Divider respectively.

Warning: You must set a unique key for Menu.Item.

Remove the highlighted style after click menu item via <Menu selectedKey={[]}>.

Dropdown.Button

Property Description Type Default
type type of the button, the same as Button string 'default'
size size of the button, the same as Button string 'default'
onClick a callback function, the same as Button, which will be executed when you click the button on the left Function -
trigger the trigger mode which can execute the drop-down action Array<'click'|'hover'> ['hover']
overlay the dropdown menu Menu -
visible determine whether the dropdown menu is visible boolean -
onVisibleChange a callback function takes an argument: visible, can be executed when the visible state is changing Function -
placement placement of pop menu: bottomLeft bottomCenter bottomRight topLeft topCenter topRight String bottomLeft