Blazorise Dropdown API

Explore the Blazorise Dropdown API reference for parameters, events, methods, and related types.

For examples and usage guidance, see the Dropdown documentation.

API

Parameters

Dropdown

Parameter Description TypeDefault
AriaDescribedBy

Specifies the aria-describedby attribute value for the dropdown root element.

Remarks

When set, this value is rendered as-is on the dropdown root element.

string
AriaInvalid

Specifies the aria-invalid attribute value for the dropdown root element.

Remarks

When set, this value is rendered as-is on the dropdown root element.

string
AriaLabelledBy

Specifies the aria-labelledby attribute value for the dropdown root element.

Remarks

When set, this value is rendered as-is on the dropdown root element.

string
AriaRequired

Specifies the aria-required attribute value for the dropdown root element.

Remarks

When set, this value is rendered as-is on the dropdown root element.

string
ChildContent

Specifies the content to be rendered inside this Dropdown.

RenderFragmentnull
Direction

Dropdown-menu slide direction.

Possible values:Default, Down, Up, End, Start

DirectionDirection.Default
Disabled

If true, dropdown would not react to button click.

boolfalse
DropdownMenuTargetId

Provides an alternative, or custom anchor element id for the dropdown menu.

This is useful when you want the dropdown menu to be anchored from a different element than the toggle.

string
EndAligned

If true, a dropdown menu will be aligned to the end.

boolfalse
HoverCloseDelay

Delay in milliseconds before hiding a hover-opened dropdown after the mouse leaves it.

intDefaultHoverCloseDelay
PositionStrategy

Specifies the positioning strategy of the dropdown menu as a 'floating' element.

Possible values:Absolute, Fixed

DropdownPositionStrategyDropdownPositionStrategy.Fixed
Submenu

Forces the dropdown to use submenu classes and behavior.

boolfalse
Trigger

Defines which pointer interactions can open or close this dropdown.

Possible values:None, Click, Hover, All

DropdownTriggerdefault(DropdownTrigger)
Visible

If true, a dropdown menu will be visible.

boolfalse

DropdownMenu

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this Container.

RenderFragmentnull
MaxMenuHeight

Sets the maximum height of the dropdown menu.

string

DropdownItem

Parameter Description TypeDefault
Active

Indicate the currently active item.

boolfalse
Checked

Tracks the Checked state whenever the DropdownItem is in checkbox mode.

boolfalse
ChildContent

Specifies the content to be rendered inside this DropdownItem.

RenderFragmentnull
CloseParentDropdowns

Specifies whether clicking this item should close the entire dropdown hierarchy or only the current dropdown.

booltrue
Disabled

Indicate the currently disabled item.

boolfalse
ShowCheckbox

The dropdown renders a checkbox.

boolfalse
TabIndex

Specifies the tabindex value for keyboard navigation.

int?null
Value

Holds the item value.

objectnull

DropdownToggle

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this DropdownToggle.

RenderFragmentnull
Color

Specifies the dropdown color.

ColorColor.Default
Disabled

Makes the toggle element look inactive.

boolfalse
Intent

Specifies the dropdown intent.

Intentnull
Outline

Button outline.

boolfalse
Size

Specifies the dropdown size.

Size?null
Split

Indicates that a toggle should act as a split button.

boolfalse
TabIndex

If defined, indicates that its element can be focused and can participates in sequential keyboard navigation.

int?null
ToggleIconVisible

Specifies a value indicating whether the dropdown toggle icon is visible.

Remarks

Default: True

bool?null

Events

Dropdown

Event Description Type
VisibleChanged

Occurs after the dropdown menu visibility has changed.

EventCallback<bool>

DropdownItem

Event Description Type
CheckedChanged

Occurs after the Checked state is changed, whenever the DropdownItem is in checkbox mode.

EventCallback<bool>
Clicked

Notifies when the item is clicked.

EventCallback<object>

DropdownToggle

Event Description Type
Clicked

Notifies when the toggle button is clicked.

EventCallback<MouseEventArgs>

Methods

Dropdown

Method DescriptionReturnParameters
Hide Hide the dropdown menu. Taskbool hideAll
Show Show the dropdown menu. Task
Toggle Toggle the visibility of the dropdown menu. Taskstring dropdownToggleElementId

DropdownToggle

Method DescriptionReturnParameters
Close Forces the parent dropdown to close the dropdown-menu. TaskCloseReason closeReason
Focus Sets focus on the input element, if it can be focused. Taskbool scrollToElement
IsSafeToClose Returns true of the parent dropdown-menu is safe to be closed. Task<bool>string elementId, CloseReason closeReason, bool isChildClicked
On this page