Class HeadlessListboxOptions<TValue>

Inheritance

object

ComponentBase

HeadlessListboxOptions<TValue>

Namespace: Neon.Tailwind

Assembly: Neon.Tailwind.dll

Syntax

public class HeadlessListboxOptions<TValue> : ComponentBase

Type Parameters

Name	Description
TValue

Properties

AdditionalAttributes

Declaration

[Parameter(CaptureUnmatchedValues = true)]
public IReadOnlyDictionary<string, object> AdditionalAttributes { get; set; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>

CascadedListbox

Declaration

[CascadingParameter]
public HeadlessListbox<TValue> CascadedListbox { get; set; }

Property Value

Type	Description
HeadlessListbox<TValue>

ChildContent

Declaration

[Parameter]
public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
RenderFragment

Id

Declaration

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

Property Value

Type	Description
string

Listbox

Declaration

protected HeadlessListbox<TValue> Listbox { get; set; }

Property Value

Type	Description
HeadlessListbox<TValue>

Static

Declaration

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

Property Value

Type	Description
bool

TagName

Declaration

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

Property Value

Type	Description
string

Methods

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask	A task that represents the asynchronous dispose operation.

FocusAsync()

Declaration

public ValueTask FocusAsync()

Returns

Type	Description
ValueTask

HandleKeyDown(KeyboardEventArgs)

Declaration

public Task HandleKeyDown(KeyboardEventArgs eventArgs)

Parameters

Type	Name	Description
KeyboardEventArgs	eventArgs

Returns

Type	Description
Task

OnAfterRenderAsync(bool)

Method invoked after each time the component has been rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs.

This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated.

Note that the component does not automatically re-render after the completion of any returned Task, because that would cause an infinite render loop.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
bool	firstRender	Set to true if this is the first time OnAfterRender(bool) has been invoked on this component instance; otherwise false.

Returns

Type	Description
Task	A Task representing any asynchronous operation.

Overrides

ComponentBase.OnAfterRenderAsync(bool)

Remarks

The OnAfterRender(bool) and OnAfterRenderAsync(bool) lifecycle methods are useful for performing interop, or interacting with values received from @ref. Use the firstRender parameter to ensure that initialization work is only performed once.

OnInitialized()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.

Declaration

protected override void OnInitialized()

Overrides

ComponentBase.OnInitialized()

SetParametersAsync(ParameterView)

Sets parameters supplied by the component's parent in the render tree.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task	A Task that completes when the component has finished updating and rendering itself.

Overrides

ComponentBase.SetParametersAsync(ParameterView)

Remarks

Parameters are passed when SetParametersAsync(ParameterView) is called. It is not required that the caller supply a parameter value for all of the parameters that are logically understood by the component.

The default implementation of SetParametersAsync(ParameterView) will set the value of each property decorated with ParameterAttribute or CascadingParameterAttribute that has a corresponding value in the ParameterView. Parameters that do not have a corresponding value will be unchanged.

Operators

implicit operator ElementReference(HeadlessListboxOptions<TValue>)

Declaration

public static implicit operator ElementReference(HeadlessListboxOptions<TValue> element)

Parameters

Type	Name	Description
HeadlessListboxOptions<TValue>	element

Returns

Type	Description
ElementReference