Blazorise Dock Layout API
Explore the Blazorise Dock Layout API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the Dock Layout documentation.
API
Parameters
DockLayout
| 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. | ||
DockPane
| Parameter | Default | Type |
|---|---|---|
AcceptPaneDrops | true | bool |
Defines whether other panes can be dropped onto or around this pane. | ||
AutoHide | false | bool |
Initially auto-hides the pane content while keeping the pane available on its docked side. | ||
AutoHideable | true | bool |
Allows the pane header to show a pin action that toggles auto-hide behavior. | ||
Caption | — | string |
Defines the caption used by tabbed dock groups. | ||
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this DockPane. | ||
Closable | true | bool |
Allows the pane header to show a close action that hides the pane. | ||
Collapsed | false | bool |
Initially collapses the pane content while keeping the pane in the dock layout. | ||
MaxSize | — | string |
Defines the maximum pane size when size constraints are applied. | ||
MinSize | — | string |
Defines the minimum pane size when size constraints are applied. | ||
Movable | true | bool |
Allows the pane to be moved to another dock position by dragging its header. | ||
Name | — | string |
Identifies the pane inside the parent DockLayout and acts as the stable key used by persisted DockLayoutState values. | ||
PanePosition | DockPanePosition.Left | DockPanePosition |
Defines where the pane is initially docked inside the layout. Possible values: LeftRightTopBottomCenter | ||
Resizable | false | bool |
Shows a splitter marker that indicates the pane can participate in resize behavior. | ||
Role | Tool | DockPaneRole |
Defines whether this pane behaves as a tool pane or as a document pane. Possible values: ToolDocument | ||
ShowTab | true | bool |
Defines whether this pane should display a tab when it is hosted inside a tab group. | ||
ShowTabCloseButton | false | bool |
Defines whether a close button should be shown when this pane is rendered as a document tab. | ||
Size | — | string |
Defines the initial pane size, such as 280px, 18rem, or 25%. | ||
TabPosition | DockPaneTabPosition.Default | DockPaneTabPosition |
Defines where tabs should be displayed when this pane is hosted inside a tab group. Possible values: DefaultTopBottom | ||
Visible | true | bool |
Initially shows or hides the pane in the dock layout. | ||
DockPaneHeader
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the header content to be rendered inside this DockPaneHeader. | ||
DockPaneBody
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the body content to be rendered inside this DockPaneBody. | ||
DockPaneFooter
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the footer content to be rendered inside this DockPaneFooter. | ||
DockContent
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this DockContent. | ||
DockSplit
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the split child content. | ||
Orientation | Orientation.Horizontal | Orientation |
Defines the initial split orientation. Possible values: HorizontalVertical | ||
Ratio | 0.5 | double |
Defines the initial first child ratio. | ||
DockTabs
| Parameter | Default | Type |
|---|---|---|
ActivePane | — | string |
Defines the initially active pane name. | ||
ChildContent | null | RenderFragment |
Specifies the tab child content. | ||
Events
DockLayout
| Event | Type |
|---|---|
StateChanged | EventCallback<DockLayoutState> |
Occurs after the docking state changes. | |
DockPane
| Event | Type |
|---|---|
Closing | Func<DockPaneClosingEventArgs, Task> |
Callback invoked before the pane closes. | |
Methods
DockLayout
| 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.
| ||
DockPane
| Method | Return | Parameters |
|---|---|---|
Refresh | Task | — |
Forces rendered pane content to refresh without changing the docking state.
| ||