Blazorise DockLayout component
Arranges docked panes around a central content surface.
API
Parameters
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the panes and content to be rendered inside the dock layout. | ||
PaneBordered | true | bool |
Defines whether non-document panes should render a visible border. | ||
SplitterThickness | 6 | double |
Defines the thickness, in pixels, of the splitters between dock panes. | ||
State | null | DockLayoutState |
Defines the mutable state used for docking, resizing, active tabs, and pane visibility. The same state can be saved with GetState and restored with DockLayoutState). Declarative values initialize this state and are reapplied by ResetState. In-place changes to the assigned instance are not detected; apply them with DockLayoutState) or follow them with Refresh. | ||
Events
| Event | Type |
|---|---|
StateChanged | EventCallback<DockLayoutState> |
Occurs after the docking state changes. | |
Methods
| Method | Return | Parameters |
|---|---|---|
ClosePane | Task | string paneName |
Closes a pane and removes it from the visible layout.
| ||
GetState | DockLayoutState | — |
Returns a persistence snapshot of the current docking state.
| ||
IsPaneOpen | bool | string paneName |
Indicates whether a pane is currently open.
| ||
LoadState | Task | DockLayoutState state |
Loads a docking state and applies it to the current layout.
| ||
OpenPane | Task | string paneName |
Opens a pane that was previously closed.
| ||
Refresh | Task | — |
Forces rendered dock content to refresh without changing the docking state. Call this after mutating the State instance directly.
| ||
ResetState | Task | — |
Resets the docking state to the latest declarative layout definition.
| ||
ShowPane | Task | string paneName |
Shows a pane by opening it, activating it, or expanding its auto-hide flyout.
| ||
TogglePane | Task | string paneName |
Toggles a pane between opened and closed states.
| ||