Class SidebarShell

Namespace

The.Web.Shell

Assembly

Instagile.Web.Client.dll

public class SidebarShell : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IModalContext, IPageContext

Inheritance

object

ComponentBase

SidebarShell

Implements

IComponent

IHandleEvent

IHandleAfterRender

IModalContext

IPageContext

Inherited Members

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AppLogo

Displayed in the sidebar if present. Defaults to the Agile logo.

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

Property Value

string

AppTitle

Displayed in the sidebar if present. Defaults to Options.AppName.

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

Property Value

string

ChildContent

Slot for the page body (which should generally include a titlebar).

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

Property Value

RenderFragment

FooterText

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

Property Value

string

ProductionEnvironmentName

Override the environment that's considered default for theming.

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

Property Value

string

SidebarContent

Optional slot for content that goes in a sidebar, which is presented with customised link display.

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

Property Value

RenderFragment

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnInitialized()

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

protected override void OnInitialized()

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()

PushModal(string, RenderFragment)

Open a modal with respect to the current page.

public void PushModal(string title, RenderFragment content)

Parameters

title string

content RenderFragment

RegisterPage(string?, bool, ICommandHost?)

Registers a page's chrome with the shell, replacing the current registration. The page disposes the returned registration when it leaves the tree. Blazor initialises replacement components before it disposes the components they replace, so implementations must ignore the disposal of a registration that a newer one has already replaced.

public IDisposable RegisterPage(string? title, bool requiresVerticalConstraint, ICommandHost? commands)

Parameters

title string

Null if the title is still being loaded.

requiresVerticalConstraint bool

Force internal scrolling.

commands ICommandHost

Null if the page presents no commands.

Returns

IDisposable

SuppressChrome(bool)

If true, an external shell will display the page's title and commands, so the page itself should just present content.

public bool SuppressChrome(bool isRoot)

Parameters

isRoot bool

Returns

bool

TryPopModal(string)

Close the current modal, if it is really open.

public bool TryPopModal(string title)

Parameters

title string

Returns

bool

Remarks

If it isn't, that's a bug in the modal router, but we want it to be recoverable.