Class HeadlessDisclosure

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

Constructors

HeadlessDisclosure()

Constructor.

Declaration
public HeadlessDisclosure()

Properties

ChildContent

The UI content.

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

HasRendered

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

IsEnabled

Declaration
[Parameter]
public bool IsEnabled { get; set; }
Property Value
Type Description
bool

Show

Whether the transition should run on initial mount.

Declaration
[Parameter]
public bool Show { get; set; }
Property Value
Type Description
bool

State

The current

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

Methods

Close()

Closes the current HeadlessDisclosure

Declaration
public Task Close()
Returns
Type Description
Task

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.

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.

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

Open()

Opens the current HeadlessDisclosure

Declaration
public Task Open()
Returns
Type Description
Task

RegisterButton(HeadlessDisclosureButton)

Declaration
public Task RegisterButton(HeadlessDisclosureButton button)
Parameters
Type Name Description
HeadlessDisclosureButton button
Returns
Type Description
Task

RegisterPanel(HeadlessDisclosurePanel)

Declaration
public Task RegisterPanel(HeadlessDisclosurePanel item)
Parameters
Type Name Description
HeadlessDisclosurePanel item
Returns
Type Description
Task

Toggle()

Toggles the current HeadlessDisclosure

Declaration
public Task Toggle()
Returns
Type Description
Task

UnregisterButton(HeadlessDisclosureButton)

Method called by a HeadlessDisclosurePanel to unregister itself with the current HeadlessDisclosure.

Declaration
public Task UnregisterButton(HeadlessDisclosureButton button)
Parameters
Type Name Description
HeadlessDisclosureButton button
Returns
Type Description
Task

UnregisterPanel(HeadlessDisclosurePanel)

Method called by a HeadlessDisclosurePanel to unregister itself with the current HeadlessDisclosure.

Declaration
public Task UnregisterPanel(HeadlessDisclosurePanel item)
Parameters
Type Name Description
HeadlessDisclosurePanel item
Returns
Type Description
Task