RayCraftDocs
v1.0.3 raycraft.dev
On this page

DockLayout

Complete

A workspace of panels. Panels dock to the left, right, top, bottom or center, share an area as tabs, collapse into a rail, or float above the layout.

Example

DockLayout control

Parameters

DockLayout

ParameterTypeDescription
CenterContentRenderFragmentContent of the center area while no panel is docked there.
ChildContentRenderFragmentContent rendered inside the component.
ClassstringExtra CSS classes added to the root element.
HeightstringCSS height of the whole layout.
LabelstringAccessible name of the layout.
PersistKeystringRemembers the arrangement in local storage under this name.
StylestringInline style added to the root element.

DockPanel

ParameterTypeDescription
ChildContentRenderFragmentContent of the panel.
ClosableboolShows the close button.
FloatableboolAllows the panel to float.
FloatHeightintStarting height of a floating panel in pixels.
FloatingboolStarts as a floating panel.
FloatLeftintStarting left of a floating panel in pixels.
FloatTopintStarting top of a floating panel in pixels.
FloatWidthintStarting width of a floating panel in pixels.
IconIconName?Icon in the tab, title bar and the collapsed rail.
IdstringUnique name of the panel inside its layout.
PositionDockPositionWhere the panel starts: Left, Right, Top, Bottom or Center.
Sizeint?Starting width (left, right) or height (top, bottom) of its area in pixels.
TitlestringText of the tab or title bar.
VisibleboolShows or hides the panel.

Events

DockLayout

EventTypeDescription
LayoutChangedEventCallback<DockLayoutState>Raised after every change with the current layout (DockLayoutState).

Package

DockLayout is part of RayCraft Complete. Package: RayCraft.Blazor.Complete. It comes from the private RayCraft feed and needs an active license. See Getting started.