Table of Contents

Class BOBInputDropdownTree<TItem, TValue>

Namespace
BlazOrbit.Components.Forms
Assembly
BlazOrbit.dll
public class BOBInputDropdownTree<TItem, TValue> : ComponentBase

Type Parameters

TItem
TValue
Inheritance
object
ComponentBase
BOBInputDropdownTree<TItem, TValue>

Constructors

BOBInputDropdownTree() 

public BOBInputDropdownTree()

Properties

AnimateExpand

AnimateExpand.

[Parameter]
public bool AnimateExpand { get; set; }

Property Value

bool

BackgroundColor

Background color. Accepts any valid CSS color value.

[Parameter]
public string? BackgroundColor { get; set; }

Property Value

string

ChildrenSelector

Returns the children of an item.

[Parameter]
public Func<TItem, IEnumerable<TItem>?>? ChildrenSelector { get; set; }

Property Value

Func<TItem, IEnumerable<TItem>>

CloseOnSelect

CloseOnSelect.

[Parameter]
public bool CloseOnSelect { get; set; }

Property Value

bool

Color

Text or foreground color. Accepts any valid CSS color value.

[Parameter]
public string? Color { get; set; }

Property Value

string

Disabled

When true, the component is non-interactive.

[Parameter]
public bool Disabled { get; set; }

Property Value

bool

DisplayMode

DisplayMode.

[Parameter]
public TreeDisplayMode DisplayMode { get; set; }

Property Value

TreeDisplayMode

DisplayTextSelector

Returns the visible text for an item. Defaults to item.ToString().

[Parameter]
public Func<TItem, string>? DisplayTextSelector { get; set; }

Property Value

Func<TItem, string>

ExpandAll

ExpandAll.

[Parameter]
public bool ExpandAll { get; set; }

Property Value

bool

ExpandedKeys

ExpandedKeys.

[Parameter]
public HashSet<string>? ExpandedKeys { get; set; }

Property Value

HashSet<string>

ExpandedKeysChanged

ExpandedKeysChanged.

[Parameter]
public EventCallback<HashSet<string>> ExpandedKeysChanged { get; set; }

Property Value

EventCallback<HashSet<string>>

FullWidth

When true, the component spans the full width of its container.

[Parameter]
public bool FullWidth { get; set; }

Property Value

bool

HasChildrenSelector

Returns whether an item has children without loading them. Enables lazy expansion via OnLoadChildren.

[Parameter]
public Func<TItem, bool>? HasChildrenSelector { get; set; }

Property Value

Func<TItem, bool>

HelperText

Helper text displayed below the component for additional context.

[Parameter]
public string? HelperText { get; set; }

Property Value

string

InheritanceSeparator

InheritanceSeparator.

[Parameter]
public string InheritanceSeparator { get; set; }

Property Value

string

IsLoading

When true, IsLoading is active.

[Parameter]
public bool IsLoading { get; set; }

Property Value

bool

IsMultiple 

public bool IsMultiple { get; }

Property Value

bool

Items

Root items the tree renders.

[Parameter]
[EditorRequired]
public IEnumerable<TItem>? Items { get; set; }

Property Value

IEnumerable<TItem>

KeySelector

Returns a stable key for an item. Required for keyboard navigation and lazy loading.

[Parameter]
public Func<TItem, string>? KeySelector { get; set; }

Property Value

Func<TItem, string>

Label

Floating label displayed above the component.

[Parameter]
public string? Label { get; set; }

Property Value

string

LoadingIndicatorVariant

Variant of the loading indicator shown when IsLoading is true.

[Parameter]
public BOBLoadingIndicatorVariant? LoadingIndicatorVariant { get; set; }

Property Value

BOBLoadingIndicatorVariant

NoOptionsTemplate

Custom template for rendering the NoOptions.

[Parameter]
public RenderFragment? NoOptionsTemplate { get; set; }

Property Value

RenderFragment

NodeTemplate

Custom template for rendering the Node.

[Parameter]
public RenderFragment<TreeSelectionNode<TItem>>? NodeTemplate { get; set; }

Property Value

RenderFragment<TreeSelectionNode<TItem>>

OnLoadChildren

Called the first time a node is expanded with no in-memory children. Result is cached on the tree.

[Parameter]
public Func<TItem, Task<IEnumerable<TItem>>>? OnLoadChildren { get; set; }

Property Value

Func<TItem, Task<IEnumerable<TItem>>>

Placeholder

Placeholder text shown when the component is empty.

[Parameter]
public string? Placeholder { get; set; }

Property Value

string

Placement

Placement.

[Parameter]
public DropdownPlacement Placement { get; set; }

Property Value

DropdownPlacement

ReadOnly

When true, the value cannot be changed.

[Parameter]
public bool ReadOnly { get; set; }

Property Value

bool

Required

When true, a value must be provided.

[Parameter]
public bool Required { get; set; }

Property Value

bool

SelectionCascade

SelectionCascade.

[Parameter]
public TreeSelectionCascade SelectionCascade { get; set; }

Property Value

TreeSelectionCascade

Shadow

Shadow style applied to the component.

[Parameter]
public ShadowStyle? Shadow { get; set; }

Property Value

ShadowStyle

ShowCheckboxes

When true, the Checkboxes is shown.

[Parameter]
public bool ShowCheckboxes { get; set; }

Property Value

bool

Size

Visual size of the component.

[Parameter]
public BOBSize Size { get; set; }

Property Value

BOBSize

Value

Current value of the component.

[Parameter]
public TValue? Value { get; set; }

Property Value

TValue

ValueChanged

Raised when the value changes.

[Parameter]
public EventCallback<TValue> ValueChanged { get; set; }

Property Value

EventCallback<TValue>

ValueExpression

ValueExpression.

[Parameter]
public Expression<Func<TValue>>? ValueExpression { get; set; }

Property Value

Expression<Func<TValue>>

Variant

Visual variant of the component.

[Parameter]
public BOBInputVariant Variant { get; set; }

Property Value

BOBInputVariant

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ClearSelection() 

public void ClearSelection()

CollapseAllNodes() 

public void CollapseAllNodes()

DisposeAsync() 

public ValueTask DisposeAsync()

Returns

ValueTask

ExpandAllNodes() 

public void ExpandAllNodes()

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()
Edit this page