Class HeadlessMenu

Inheritance
object
ComponentBase
HeadlessMenu
Namespace: Neon.Tailwind
Assembly: Neon.Tailwind.dll
Syntax
public class HeadlessMenu : ComponentBase

Constructors

HeadlessMenu()

Constructor.

Declaration
public HeadlessMenu()

Properties

ActiveItemId

Declaration
public string ActiveItemId { get; }
Property Value
Type Description
string

AdditionalAttributes

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

ButtonElementId

Declaration
public string ButtonElementId { get; }
Property Value
Type Description
string

ChildContent

Declaration
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
RenderFragment

DebouceTimeout

Declaration
[Parameter]
public int DebouceTimeout { get; set; }
Property Value
Type Description
int

HasRendered

Declaration
public bool HasRendered { get; set; }
Property Value
Type Description
bool

ItemsElementId

Declaration
public string ItemsElementId { get; }
Property Value
Type Description
string

OnClose

Declaration
[Parameter]
public EventCallback OnClose { get; set; }
Property Value
Type Description
EventCallback

OnOpen

Declaration
[Parameter]
public EventCallback OnOpen { get; set; }
Property Value
Type Description
EventCallback

SearchQuery

Declaration
public string SearchQuery { get; }
Property Value
Type Description
string

State

Declaration
public MenuState State { get; protected set; }
Property Value
Type Description
MenuState

Methods

ButtonFocusAsync()

Declaration
public ValueTask ButtonFocusAsync()
Returns
Type Description
ValueTask

Close(bool)

Declaration
public Task Close(bool suppressFocus = false)
Parameters
Type Name Description
bool suppressFocus
Returns
Type Description
Task

Dispose()

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

Declaration
public void Dispose()

GoToItem(HeadlessMenuItem)

Declaration
public void GoToItem(HeadlessMenuItem item)
Parameters
Type Name Description
HeadlessMenuItem item

GoToItem(MenuFocus)

Declaration
public void GoToItem(MenuFocus focus)
Parameters
Type Name Description
MenuFocus focus

HandleClickOff()

Declaration
public Task HandleClickOff()
Returns
Type Description
Task

IsActiveItem(HeadlessMenuItem)

Declaration
public bool IsActiveItem(HeadlessMenuItem item)
Parameters
Type Name Description
HeadlessMenuItem item
Returns
Type Description
bool

MenuItemsFocusAsync()

Declaration
public ValueTask MenuItemsFocusAsync()
Returns
Type Description
ValueTask

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
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.

Open()

Declaration
public Task Open()
Returns
Type Description
Task

RegisterButton(HeadlessMenuButton)

Declaration
public void RegisterButton(HeadlessMenuButton button)
Parameters
Type Name Description
HeadlessMenuButton button

RegisterItem(HeadlessMenuItem)

Declaration
public void RegisterItem(HeadlessMenuItem item)
Parameters
Type Name Description
HeadlessMenuItem item

RegisterItems(HeadlessMenuItems)

Declaration
public void RegisterItems(HeadlessMenuItems items)
Parameters
Type Name Description
HeadlessMenuItems items

SearchAsync(string)

Declaration
public Task SearchAsync(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Task

Toggle()

Declaration
public Task Toggle()
Returns
Type Description
Task

UnregisterItem(HeadlessMenuItem)

Declaration
public void UnregisterItem(HeadlessMenuItem item)
Parameters
Type Name Description
HeadlessMenuItem item