Class BOBInputDropdown<TValue>
- Namespace
- BlazOrbit.Components.Forms
- Assembly
- BlazOrbit.dll
[GenerateComponentInfo]
public class BOBInputDropdown<TValue> : ComponentBase, IDropdownContainer
Type Parameters
TValue
- Inheritance
-
objectComponentBaseBOBInputDropdown<TValue>
- Implements
Constructors
BOBInputDropdown()
public BOBInputDropdown()
Properties
BackgroundColor
Background color of the dropdown. Accepts any valid CSS color value, PaletteColor or BOBColor.
[Parameter]
public string? BackgroundColor { get; set; }
Property Value
- string
ChildContent
Content rendered inside the dropdown, typically <BOBOption> items.
[Parameter]
public RenderFragment? ChildContent { get; set; }
Property Value
- RenderFragment
CloseOnSelect
When true, the menu closes after selecting an option.
[Parameter]
public bool CloseOnSelect { get; set; }
Property Value
- bool
Color
Text color of the dropdown. Accepts any valid CSS color value, PaletteColor or BOBColor.
[Parameter]
public string? Color { get; set; }
Property Value
- string
Density
Vertical density (gap) of the input.
[Parameter]
public BOBDensity Density { get; set; }
Property Value
DeselectAllText
Label of the "Deselect All" button.
[Parameter]
public string DeselectAllText { get; set; }
Property Value
- string
Disabled
When true, the dropdown is non-interactive.
[Parameter]
public bool Disabled { get; set; }
Property Value
- bool
FullWidth
When true, the dropdown spans the full width of its container.
[Parameter]
public bool FullWidth { get; set; }
Property Value
- bool
HelperText
Helper text displayed below the input for additional context.
[Parameter]
public string? HelperText { get; set; }
Property Value
- string
IsLoading
When true, the dropdown shows a loading indicator.
[Parameter]
public bool IsLoading { get; set; }
Property Value
- bool
Label
Floating label displayed above the input when a value is selected or focused.
[Parameter]
public string? Label { get; set; }
Property Value
- string
LoadingIndicatorVariant
[Parameter]
public BOBProgressIconVariant? LoadingIndicatorVariant { get; set; }
Property Value
NoOptionsTemplate
Custom template rendered when the dropdown has no options.
[Parameter]
public RenderFragment? NoOptionsTemplate { get; set; }
Property Value
- RenderFragment
NoResultsTemplate
Custom template rendered when a search yields no results.
[Parameter]
public RenderFragment<NoResultsContext>? NoResultsTemplate { get; set; }
Property Value
- RenderFragment<NoResultsContext>
Placeholder
Placeholder text shown when no option is selected.
[Parameter]
public string? Placeholder { get; set; }
Property Value
- string
Placement
Preferred placement of the dropdown menu relative to the input.
[Parameter]
public DropdownPlacement Placement { get; set; }
Property Value
ReadOnly
When true, the value cannot be changed.
[Parameter]
public bool ReadOnly { get; set; }
Property Value
- bool
Required
When true, a value must be selected.
[Parameter]
public bool Required { get; set; }
Property Value
- bool
SearchMode
Algorithm used to filter options while searching.
[Parameter]
public SearchMode SearchMode { get; set; }
Property Value
SearchPlaceholder
Placeholder text for the search box.
[Parameter]
public string SearchPlaceholder { get; set; }
Property Value
- string
Searchable
When true, a search box is rendered at the top of the menu.
[Parameter]
public bool Searchable { get; set; }
Property Value
- bool
SelectAllText
Label of the "Select All" button.
[Parameter]
public string SelectAllText { get; set; }
Property Value
- string
Shadow
Shadow style applied to the input container.
[Parameter]
public ShadowStyle? Shadow { get; set; }
Property Value
ShowSelectAll
When true and in multi-select mode, shows buttons to select or deselect all options.
[Parameter]
public bool ShowSelectAll { get; set; }
Property Value
- bool
Size
Visual size of the dropdown.
[Parameter]
public BOBSize Size { get; set; }
Property Value
Value
Current value of the dropdown.
[Parameter]
public TValue? Value { get; set; }
Property Value
- TValue
ValueChanged
Raised when the selected value changes.
[Parameter]
public EventCallback<TValue> ValueChanged { get; set; }
Property Value
- EventCallback<TValue>
ValueExpression
Expression used to identify the bound value for validation.
[Parameter]
public Expression<Func<TValue>>? ValueExpression { get; set; }
Property Value
- Expression<Func<TValue>>
Variant
Visual variant of the input field.
[Parameter]
public BOBInputVariant Variant { get; set; }
Property Value
Methods
BuildRenderTree(RenderTreeBuilder)
Renders the component to the supplied Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builderRenderTreeBuilder
DisposeAsync()
public ValueTask DisposeAsync()
Returns
- ValueTask
OnParametersSet()
Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.
protected override void OnParametersSet()