<DropdownListButton>
Component
<DropdownListButton>
is a <ToggleButton>
component with a <Dropdown>
of <List>
.
Here the demo:
<DropdownListButton>
Component<DropdownListButton>
is a <ToggleButton>
component with a <Dropdown>
of <List>
.
Here the demo:
<DropdownListButton>
ComponentThere are 2 ways to install <DropdownListButton>
component into your react app project:
<DropdownListButton>
Component<DropdownListButton>
Componentexpanded
PropertyExpands/Collapses the <Dropdown>
of <DropdownListButton>
.
The possible values are:
undefined
true
false
Here the preview:
<DropdownListButton expanded={true}>Â
defaultExpanded
PropertyDefines the initial expanded
state when the <DropdownListButton>
is first loaded.
The possible values are:
undefined
true
false
onExpandedChange
PropertySets a callback function to be called when the user closes the <DropdownListButton>
.
The callback function parameters:
event: ExpandedChangeEvent
orientation
PropertySets the orientation and the direction of the <DropdownListButton>
.
The possible values are:
undefined
'inline-start'
'inline-end'
'block-start'
'block-end'
Here the preview:
listOrientation
PropertySets the orientation of the internal <List>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton listOrientation='inline' />
is equivalent to:<DropdownListButton listComponent={
<List orientation='inline' />
} />
Here the preview:
dropdownOrientation
PropertySets the orientation of the internal <Dropdown>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton dropdownOrientation='inline' />
is equivalent to:<DropdownListButton dropdownComponent={
<Dropdown orientation='inline' />
} />
Here the preview:
lazy
PropertyDetermines whenever the <DropdownListButton>
's children
should be rendered or not when the <DropdownListButton expanded={false}>
.
The possible values are:
undefined
false
true
onClick
PropertyExecutes a JavaScript's callback function when the <DropdownListButton>
is clicked.
Determines how the <Dropdown>
of <DropdownListButton>
should be floating on the <ToggleButton>
of <DropdownListButton>
.
floatingOn
PropertyDetermines the target DOM reference where the <Dropdown>
of <DropdownListButton>
should be floating on.
If not set (undefined
), the <Dropdown>
floating on the <ToggleButton>
of <DropdownListButton>
.
Here the preview:
floatingPlacement
PropertyDetermines the location where the <Dropdown>
of <DropdownListButton>
should be floating on the <ToggleButton>
of <DropdownListButton>
.
Here the preview:
floatingPlacement='top'
floatingStrategy
PropertyDetermines the technical strategy how the <Dropdown>
of <DropdownListButton>
can float.
In most cases, you should not worry about the detail mechanism how the <Dropdown>
of <DropdownListButton>
can float.
The possible values are:
undefined
'absolute'
'fixed'
floatingAutoFlip
PropertyAutomatically flips the floatingPlacement
to opposite direction when the <Dropdown>
of <DropdownListButton>
is about to be clipped.
The possible values are:
undefined
true
false
Here the preview:
floatingAutoShift
PropertyAutomatically shifts the floatingPlacement
to nearest safe position when the <Dropdown>
of <DropdownListButton>
is about to be clipped.
The possible values are:
undefined
true
false
Here the preview:
floatingOffset
PropertyThe distance (in pixel) between the <Dropdown>
of <DropdownListButton>
and the <ToggleButton>
of <DropdownListButton>
.
The possible values are:
undefined
0
Here the preview:
<DropdownListButton floatingOffset={0}>
floatingShift
PropertyThe distance (in pixel) between the <Dropdown>
of <DropdownListButton>
and the default floatingPlacement
location.
The possible values are:
undefined
0
Here the preview:
<DropdownListButton floatingShift={0}>
onFloatingUpdate
PropertySets a callback function to be called when the <Dropdown>
of <DropdownListButton>
updates the position relative to the <ToggleButton>
of <DropdownListButton>
.
The callback function parameters:
event: FloatingPosition
The alternative appearances of the <DropdownListButton>
layout without changing the <DropdownListButton>
's functionality.
size
PropertyDefines the alternative size of the <DropdownListButton>
.
The possible values are:
undefined
'sm'
'md'
'lg'
Here the preview:
theme
PropertyDefines the contextual theme of the <DropdownListButton>
.
The possible values are:
undefined
'primary'
'secondary'
'success'
'info'
'warning'
'danger'
'light'
'dark'
Here the preview:
gradient
PropertyActivates a 3D mode of the <DropdownListButton>
.
The possible values are:
undefined
'inherit'
true
false
Here the preview:
outlined
PropertyActivates an outlined mode (background-less, contrast foreground, and contrast border) of the <DropdownListButton>
.
The possible values are:
undefined
'inherit'
true
false
Here the preview:
mild
PropertyActivates a mild mode (mild background, contrast foreground, and contrast border) of the <DropdownListButton>
.
The possible values are:
undefined
'inherit'
true
false
Here the preview:
The conditions of the <DropdownListButton>
behavior or functionality.
enabled
PropertyDefines the enabled/disabled state of the <DropdownListButton>
.
The possible values are:
undefined
true
false
Here the preview:
inheritEnabled
PropertyInfluences the <DropdownListButton>
's disabled state by <ancestor enabled={false}>
.
The possible values are:
undefined
true
false
Here the preview:
Overwrites the internal (sub) components used as the composition of <DropdownListButton>
component.
buttonComponent
PropertyOverwrites the internal <Button>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton buttonComponent={
<MyCustomButton />
} />
buttonRef
PropertyGets the DOM reference of the internal <Button>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton buttonRef={fooButtonRef} />
is equivalent to:<DropdownListButton buttonComponent={
<Button elmRef={fooButtonRef} />
} />
buttonOrientation
PropertySets the orientation of the internal <Button>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton buttonOrientation='inline' />
is equivalent to:<DropdownListButton buttonComponent={
<Button orientation='inline' />
} />
buttonChildren
PropertyDefines the nested element of the internal <Button>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton buttonChildren={
<span>Hello World</span>
} />
is equivalent to:<DropdownListButton buttonComponent={
<Button>
<span>Hello World</span>
</Button>
} />
toggleButtonComponent
PropertyOverwrites the internal <ToggleButton>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton toggleButtonComponent={
<MyCustomToggleButton />
} />
dropdownComponent
PropertyOverwrites the internal <Dropdown>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton dropdownComponent={
<MyCustomDropdown />
} />
dropdownRef
PropertyGets the DOM reference of the internal <Dropdown>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton dropdownRef={fooDropdownRef} />
is equivalent to:<DropdownListButton dropdownComponent={
<Dropdown elmRef={fooDropdownRef} />
} />
listComponent
PropertyOverwrites the internal <List>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton listComponent={
<MyCustomList />
} />
listRef
PropertyGets the DOM reference of the internal <List>
component used as the composition of <DropdownListButton>
component.
<DropdownListButton listRef={fooListRef} />
is equivalent to:<DropdownListButton listComponent={
<List elmRef={fooListRef} />
} />
Because <DropdownListButton>
is made from <DropdownButton>
, so all properties from <DropdownButton>
are inherited.