Table of Contents

Class Layout

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

Layout 组件

public class Layout : BootstrapModuleComponentBase, IComponent, IHandleAfterRender, IHandleEvent, IAsyncDisposable, IHandlerException
Inheritance
Layout
Implements
Inherited Members
Extension Methods

Constructors

Layout() 

public Layout()

Properties

AdditionalAssemblies

获得/设置 Gets or sets a collection of additional assemblies that should be searched for components that can match URIs.

[Parameter]
public IEnumerable<Assembly>? AdditionalAssemblies { get; set; }

Property Value

IEnumerable<Assembly>

AllowDragTab

获得/设置 是否允许拖动标签页 默认 true

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

Property Value

bool

CollapseBarTemplate

获得/设置 收起展开按钮模板

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

Property Value

RenderFragment

ExcludeUrls

获得/设置 排除地址支持通配符

[Parameter]
public IEnumerable<string>? ExcludeUrls { get; set; }

Property Value

IEnumerable<string>

获得/设置 Footer 模板

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

Property Value

RenderFragment

Header

获得/设置 Header 模板

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

Property Value

RenderFragment

IsAccordion

获得/设置 菜单手风琴效果

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

Property Value

bool

IsCollapsed

获得/设置 侧边栏状态

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

Property Value

bool

IsCollapsedChanged

获得/设置 侧边栏状态

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

Property Value

EventCallback<bool>

IsFixedFooter

获得/设置 是否固定 Footer 组件

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

Property Value

bool

IsFixedHeader

获得/设置 是否固定 Header 组件

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

Property Value

bool

IsFullSide

获得/设置 侧边栏是否占满整个左侧 默认为 false

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

Property Value

bool

IsOnlyRenderActiveTab

获得/设置 是否仅渲染 Active 标签

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

Property Value

bool

IsPage

获得/设置 是否为正页面布局 默认为 false

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

Property Value

bool

Main

获得/设置 Main 模板

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

Property Value

RenderFragment

MenuBarIcon

获得/设置 MenuBar 图标

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

Property Value

string

Menus

获得/设置 侧边栏菜单集合

[Parameter]
public IEnumerable<MenuItem>? Menus { get; set; }

Property Value

IEnumerable<MenuItem>

NotAuthorizeUrl

获得/设置 未授权导航地址 默认为 "/Account/Login" Cookie 模式登录页

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

Property Value

string

NotAuthorized

获得/设置 NotAuthorized 模板

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

Property Value

RenderFragment

NotFound

获得/设置 NotFound 模板

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

Property Value

RenderFragment

NotFoundTabText

获得/设置 NotFound 标签文本

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

Property Value

string

OnAuthorizing

获得/设置 授权回调方法多用于权限控制

[Parameter]
public Func<string, Task<bool>>? OnAuthorizing { get; set; }

Property Value

Func<string, Task<bool>>

OnClickMenu

获得/设置 点击菜单时回调委托方法 默认为 null

[Parameter]
public Func<MenuItem, Task>? OnClickMenu { get; set; }

Property Value

Func<MenuItem, Task>

OnCollapsed

获得/设置 收缩展开回调委托

[Parameter]
public Func<bool, Task>? OnCollapsed { get; set; }

Property Value

Func<bool, Task>

OnUpdateAsync

获得/设置 更新回调方法 默认 null

[Parameter]
public Func<string, Task>? OnUpdateAsync { get; set; }

Property Value

Func<string, Task>

Resource

获得/设置 AuthorizeRouteView 参数

[Parameter]
public object? Resource { get; set; }

Property Value

object

ShowCollapseBar

获得/设置 是否显示收缩展开 Bar 默认 false

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

Property Value

bool

ShowFooter

获得/设置 是否显示 Footer 模板 默认 false

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

Property Value

bool

ShowGotoTop

获得/设置 是否显示返回顶端按钮 默认为 false 不显示

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

Property Value

bool

Side

获得/设置 Side 模板

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

Property Value

RenderFragment

SideWidth

获得/设置 侧边栏宽度，支持百分比，设置 0 时关闭宽度功能 默认值 300

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

Property Value

string

TabDefaultUrl

获得/设置 默认标签页 关闭所以标签页时自动打开此地址 默认 null 未设置

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

Property Value

string

TooltipText

获得/设置 鼠标悬停提示文字信息

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

Property Value

string

UseTabSet

获得/设置 是否右侧使用 Tab 组件 默认为 false 不使用

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

Property Value

bool

Methods

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

DisposeAsync(bool)

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

protected override ValueTask DisposeAsync(bool disposing)

Parameters

disposing bool

Returns

ValueTask

HandlerException(Exception, RenderFragment<Exception>)

HandlerException 错误处理方法

public virtual Task HandlerException(Exception ex, RenderFragment<Exception> errorContent)

Parameters

ex Exception
errorContent RenderFragment<Exception>

Returns

Task

HandlerMain()

HandlerMain 方法

protected virtual RenderFragment HandlerMain()

Returns

RenderFragment

InvokeInitAsync()

call JavaScript method

protected override Task InvokeInitAsync()

Returns

Task

OnInitialized() 

protected override void OnInitialized()

OnInitializedAsync() 

protected override Task OnInitializedAsync()

Returns

Task

OnParametersSet() 

protected override void OnParametersSet()

SetCollapsed(int)

设置侧边栏收缩方法 客户端监控 window.onResize 事件回调此方法

[JSInvokable]
public void SetCollapsed(int width)

Parameters

width int

UpdateAsync(string)

调用 Update 回调方法

public Task UpdateAsync(string key)

Parameters

key string

Returns

Task