DropDownButtonProps
accessKey?
string
Specifies the accessKey
of the main button.
buttonClass?
string
Sets the className
of the main button.
children?
React.ReactNode
Determines the children nodes.
className?
string
Sets the className
of the DropDownButton component.
dir?
string
Sets the direction of the component.
disabled?
boolean
Determines whether the component is disabled (see example).
fillMode?
null | "solid" | "outline" | "flat" | "link"
(default: solid
)
Configures the fillMode
of the DropDownButton.
The available options are:
- solid
- outline
- flat
- link
- null—Does not set a fillMode
className
.
icon?
string
Defines an icon that will be rendered next to the main button text (see example).
iconClass?
string
Defines an icon with a custom CSS class that will be rendered next to the main button text (see example).
id?
string
Sets the id
property of the top div element of the component.
imageUrl?
string
Defines the location of an image that will be displayed next to the main button text (see example).
item?
null | React.ComponentType<{ item: any; itemIndex: number; }>
A React functional or class component which is used for rendering items (see example). The default rendering includes an icon, an image, and text.
itemRender?
(li: ReactElement<HTMLLIElement>, props: ButtonItemProps) => React.ReactNode | React.ComponentType<{ item: any; itemIndex: number; }>
Fires when a dropdown list button item is about to be rendered. Use it to override the default appearance of the list items.
if item
prop is not declared, itemRender
behaves like item
, for backward compatibility with versions before 4.2.0
items?
any[]
Specifies the list items (see example).
onBlur?
(event: DropDownButtonBlurEvent) => void
Fires when the component is blurred (see example).
onClose?
(event: DropDownButtonCloseEvent) => void
Fires when the popup which contains the items is closed (see example).
onFocus?
(event: DropDownButtonFocusEvent) => void
Fires when the component is focused (see example).
onItemClick?
(event: DropDownButtonItemClickEvent) => void
Fires when an item is clicked (see example).
onOpen?
(event: DropDownButtonOpenEvent) => void
Fires when the popup which contains the items is opened (see example).
opened?
boolean
Opens the popup of the DropDownButton if set to true
.
popupSettings?
Configures the popup (see example).
rounded?
null | "small" | "medium" | "large" | "full"
(default: medium
)
Configures the roundness
of the DropDownButton.
The available options are:
- small
- medium
- large
- full
- null—Does not set a rounded
className
.
shape?
null | "rectangle" | "square"
(default: rectangle
)
Configures the shape
of the DropDownButton.
The available options are:
- rectangle
- square
- null—Does not set a shape
className
.
size?
null | "small" | "medium" | "large"
(default: medium
)
Configures the size
of the DropDownButton.
The available options are:
- small
- medium
- large
- null—Does not set a size
className
.
style?
CSSProperties
Sets additional CSS styles to the component.
tabIndex?
number
Specifies the tabIndex
of the main button.
text?
React.ReactNode
Specifies the text of the main button (see example).
textField?
string
Configures the field that will be used for the text of the items
. textField
has to be used together with the items
prop (see example).
themeColor?
null | "base" | "primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "dark" | "light" | "inverse"
(default: base
)
Configures the themeColor
of the DropDownButton.
The available options are:
- base
- primary
- secondary
- tertiary
- info
- success
- warning
- dark
- light
- inverse
- null—Does not set a themeColor
className
.