| Name |
Type |
Default value |
Description |
|---|
| AriaDescription |
string? |
null |
The description of the drop menu for the benefit of screen readers, rendered as the aria-describedby of the button. |
| AriaHidden |
bool |
false |
If true, adds an aria-hidden attribute instructing screen readers to ignore the button of the drop menu. |
| AutoClose |
bool |
false |
Closes the callout as soon as a click lands anywhere inside it, which is what an action list is expected to do: picking an item completes the interaction. It is off by default, since a callout hosting a form or a filter panel is meant to stay open while it is being used. |
| AutoFocus |
bool |
false |
Moves the focus into the callout as soon as it opens, to its first focusable element, or to the callout itself when it holds none. |
| Background |
BitColorKind? |
null |
The color kind of the background of the callout of the drop menu. |
| Body |
RenderFragment? |
null |
Alias of the ChildContent. |
| Border |
BitColorKind? |
null |
The color kind of the border of the callout of the drop menu. |
| ChevronDownIcon |
BitIconInfo? |
null |
The icon for the chevron down part of the drop menu using custom CSS classes for external icon libraries. Takes precedence over ChevronDownIconName when both are set. |
| ChevronDownIconName |
string? |
null |
The icon name for the chevron down part of the drop menu from the built-in Fluent UI icons. For external icon libraries, use ChevronDownIcon instead. |
| ChildContent |
RenderFragment? |
null |
The content of the callout of the drop menu. |
| Classes |
BitDropMenuClassStyles? |
null |
Custom CSS classes for different parts of the drop menu. |
| Color |
BitColor? |
null |
The general color of the button of the drop menu. |
| DefaultIsOpen |
bool? |
null |
The initial opening state of the callout in the uncontrolled mode, which is when the IsOpen parameter is not set. |
| DropDirection |
BitDropDirection |
BitDropDirection.TopAndBottom |
Determines the allowed drop directions of the callout of the drop menu. |
| FullWidth |
bool |
false |
Expands the drop menu width to 100% of the available width. |
| HoverCloseDelay |
int |
150 |
The delay in milliseconds before the callout closes once the pointer leaves the drop menu in the OpenOnHover mode. It bridges the gap between the button and the callout, so moving the pointer from one to the other does not close what the pointer is on its way to. |
| HoverOpenDelay |
int |
0 |
The delay in milliseconds before the callout opens once the pointer enters the drop menu in the OpenOnHover mode, so that passing over the button on the way somewhere else does not open it. |
| Icon |
BitIconInfo? |
null |
The icon to display inside the header using custom CSS classes for external icon libraries. Takes precedence over IconName when both are set. |
| IconName |
string? |
null |
The name of the icon to display inside the header from the built-in Fluent UI icons. For external icon libraries, use Icon instead. |
| IsLoading |
bool |
false |
Determines whether the drop menu is in the loading state. It replaces the icon of the button with a spinner and disables the button, so the callout can no longer be opened by the user or by the Open and Toggle methods, and a callout that is already open is closed. |
| IsOpen |
bool |
false |
Determines the opening state of the callout of the drop menu. |
| MatchWidth |
bool |
false |
Expands the callout of the drop menu to at least the width of the button of the drop menu. It is applied after the callout is measured, so it takes precedence over Width. |
| MaxHeight |
string? |
null |
The maximum height of the callout of the drop menu as a CSS value (e.g. "20rem"), beyond which its content scrolls. It takes over from the automatic cap that otherwise keeps the callout within the room the viewport leaves, so it should stay within what the shortest screen the drop menu is used on can show. |
| MaxWidth |
string? |
null |
The maximum width of the callout of the drop menu as a CSS value (e.g. "20rem"), beyond which its content wraps. |
| MinWidth |
string? |
null |
The minimum width of the callout of the drop menu as a CSS value (e.g. "20rem"), so that a narrow content does not end up in a cramped callout. |
| NoChevron |
bool |
false |
Removes the chevron-down icon from the button of the drop menu. |
| NoShadow |
bool |
false |
Removes the box-shadow from the callout of the drop menu. |
| OnClick |
EventCallback |
|
The callback is called when the drop menu is clicked. |
| OnDismiss |
EventCallback |
|
The callback is called when the drop menu is dismissed. |
| OnOpen |
EventCallback |
|
The callback is called when the callout of the drop menu is opened. |
| OpenOnHover |
bool |
false |
Opens the callout when the pointer enters the drop menu and closes it when the pointer leaves it, which is what a navigation menu is usually expected to do. The button keeps toggling the callout on a click, so the keyboard and the touch screens - where hovering does not exist and this mode turns itself off - are left with a way to reach it. |
| PanelPosition |
BitPanelPosition? |
null |
The position of the responsive panel to show on the screen. |
| Responsive |
bool |
false |
Renders the drop menu in responsive mode on small screens. |
| ScrollContainerId |
string? |
null |
The id of the element which needs to be scrollable in the content of the callout of the drop menu. |
| Size |
BitSize? |
null |
The size of the button of the drop menu. |
| Styles |
BitDropMenuClassStyles? |
null |
Custom CSS styles for different parts of the drop menu. |
| Template |
RenderFragment? |
null |
The custom content to render inside the header of the drop menu. |
| Text |
string? |
null |
The text to show inside the header of the drop menu. |
| Title |
string? |
null |
The tooltip to show when the mouse is placed on the button of the drop menu. |
| Transparent |
bool |
false |
Makes the background of the header of the drop menu transparent. |
| TrapFocus |
bool |
false |
Keeps the keyboard inside the callout while it is open: the focus moves into it as it opens, Tab and Shift+Tab cycle within it instead of running on into the page behind it, and the callout reports itself as a modal dialog to the screen readers. It implies AutoFocus. |
| Variant |
BitVariant? |
null |
The visual variant of the button of the drop menu: filled (the default look), outlined, or text only. It decides how the Color is painted onto the button, so the two are set together. |
| Width |
string? |
null |
The width of the callout of the drop menu as a CSS value (e.g. "20rem"). By default the callout is only as wide as its content needs. MatchWidth takes precedence over it. |
| Name |
Type |
Default value |
Description |
|---|
| AriaLabel |
string? |
null |
Gets or sets the accessible label for the component, used by assistive technologies. |
| Class |
string? |
null |
Gets or sets the CSS class name(s) to apply to the rendered element. |
| Dir |
BitDir? |
null |
Gets or sets the text directionality for the component's content. |
| ForceAnimation |
bool |
false |
Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested. |
| HtmlAttributes |
Dictionary<string, object> |
new Dictionary<string, object>() |
Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters. |
| Id |
string? |
null |
Gets or sets the unique identifier for the component's root element. |
| IsEnabled |
bool |
true |
Gets or sets a value indicating whether the component is enabled and can respond to user interaction. |
| Style |
string? |
null |
Gets or sets the CSS style string to apply to the rendered element. |
| TabIndex |
string? |
null |
Gets or sets the tab order index for the component when navigating with the keyboard. |
| Visibility |
BitVisibility |
BitVisibility.Visible |
Gets or sets the visibility state (visible, hidden, or collapsed) of the component. |