Class BOBDrawer

Namespace

BlazOrbit.Components.Layout

Assembly

BlazOrbit.dll

[GenerateComponentInfo]
public class BOBDrawer : BOBComponentBase, IHasElevation

Inheritance

object

ComponentBase

BOBComponentBase

BOBDrawer

Implements

IHasElevation

Inherited Members

BOBComponentBase.BuildComponentCssVariables(Dictionary<string, string>)

BOBComponentBase.BuildComponentDataAttributes(Dictionary<string, object>)

BOBComponentBase.OnInitialized()

BOBComponentBase.OnParametersSet()

BOBComponentBase.AdditionalAttributes

BOBComponentBase.ComputedAttributes

BOBComponentBase.IsDisposed

Constructors

BOBDrawer()

public BOBDrawer()

Properties

ChildContent

Content rendered inside the component.

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

Property Value

RenderFragment

Closable

Closable.

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

Property Value

bool

CloseOnEscape

CloseOnEscape.

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

Property Value

bool

CloseOnOverlayClick

CloseOnOverlayClick.

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

Property Value

bool

Elevation

Material Design elevation level (0–24) applied to the drawer surface. Sets a derived shadow and lifts the surface in dark mode via a tint overlay. null (default) keeps the component-default shadow defined in CSS.

[Parameter]
public int? Elevation { get; set; }

Property Value

int?

Footer

Footer.

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

Property Value

RenderFragment

Header

Header.

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

Property Value

RenderFragment

Open

Open.

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

Property Value

bool

OpenChanged

OpenChanged.

[Parameter]
public EventCallback<bool> OpenChanged { get; set; }

Property Value

EventCallback<bool>

Position

Position.

[Parameter]
public DrawerPosition Position { get; set; }

Property Value

DrawerPosition

Size

Visual size of the component.

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

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

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

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

DisposeAsync()

public override ValueTask DisposeAsync()

Returns

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 Microsoft.AspNetCore.Components.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 System.Threading.Tasks.Task, because that would cause an infinite render loop.

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Set to true if this is the first time Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender(bool) has been invoked on this component instance; otherwise false.

Returns

Task

A System.Threading.Tasks.Task representing any asynchronous operation.

Remarks

The Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender(bool) and Microsoft.AspNetCore.Components.ComponentBase.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.