docking library
Classes
- Area
- Child area in the MultiSplitView.
- AreaBuilder
- ContentAreaThemeData
- DividerPainter
- Allows customizing the divider.
- DividerPainters
- The divider painter factory.
- DividerWidget
- The standard divider widget for MultiSplitView that renders the DividerPainter from the current MultiSplitViewTheme.
- Docking
- The docking widget.
- DockingArea
- Represents any area of the layout.
- DockingColumn
- Represents an area for a collection of widgets. Children will be arranged vertically.
- DockingIcons
- Docking icons
- DockingItem
-
Represents an area for a single widget.
The
keepAliveparameter keeps the state during the layout change. The default value isFALSE. This feature implies using GlobalKeys and keeping the widget in memory even if its tab is not selected. - DockingLayout
- Represents a layout.
- DockingParentArea
- Represents an abstract area for a collection of widgets.
- DockingRow
- Represents an area for a collection of widgets. Children will be arranged horizontally.
- DockingTabs
- Represents an area for a collection of widgets. Children will be arranged in tabs.
- DockingTheme
- Applies a Docking theme to descendant widgets. See also:
- DockingThemeData
- The Docking theme. Defines the configuration of the overall visual Theme for a widget subtree within the app.
- DraggableConfig
- Configures the tab drag.
- DraggableData
- IconProvider
- Provides an icon
- LayoutParser
- Parser between DockingLayout and String.
- MultiSplitView
- A widget to provides horizontal or vertical multiple split view.
- MultiSplitViewController
- Controller for MultiSplitView.
- MultiSplitViewTheme
- Applies a MultiSplitView theme to descendant widgets. See also:
- MultiSplitViewThemeData
- The MultiSplitView theme. Defines the configuration of the overall visual MultiSplitViewTheme for a widget subtree within the app.
- TabbedView
- Widget inspired by the classic Desktop-style tab component.
- TabbedViewController
- The TabbedView controller.
- TabbedViewIcons
- TabbedView icons
- TabbedViewMenuItem
- Menu item
- TabbedViewMenuThemeData
- Theme for menu.
- TabbedViewTheme
- Applies a TabbedView theme to descendant widgets. See also:
- TabbedViewThemeConstants
- TabbedViewThemeData
- The TabbedView theme. Defines the configuration of the overall visual Theme for a widget subtree within the app.
- TabButton
- Configures a tab button.
- TabData
- The tab data.
- TabsAreaThemeData
- Theme for tabs and buttons area.
- TabStatusThemeData
- Theme for tab in a given status. Allows you to overwrite TabThemeData properties.
- TabThemeData
- Theme for tab.
Enums
- DockingAreaType
- Represents the DockingArea type.
- DropPosition
- Represents all positions available for a drop event that will rearrange the layout.
- EqualHeights
- TabStatus
- Inner enum for tab status.
- VerticalAlignment
- Sets the alignment in the tab.
Typedefs
- CanDrop = bool Function(DraggableData source, TabbedViewController target)
- DividerBuilder = Widget Function(Axis axis, int index, bool resizable, bool dragging, bool highlighted, MultiSplitViewThemeData themeData)
- DividerDoubleTapCallback = void Function(int dividerIndex)
- Signature for when a divider double tap has occurred.
- DividerTapCallback = void Function(int dividerIndex)
- Signature for when a divider tap has occurred.
-
DockingButtonsBuilder
= List<
TabButton> Function(BuildContext context, DockingTabs? dockingTabs, DockingItem? dockingItem) - Buttons builder for DockingItem and DockingTabs.
- IconPath = Path Function(Size size)
- Builds a responsive path given a size. Used to draw a icon.
- ItemCloseInterceptor = bool Function(DockingItem item)
- Intercepts a DockingItem close event to indicates whether it can be closed.
- OnDraggableBuild = DraggableConfig Function(TabbedViewController controller, int tabIndex, TabData tab)
- Defines the configuration of a Draggable in its construction.
- OnItemClose = void Function(DockingItem item)
- Event that will be triggered after a DockingItem close.
- OnItemSelection = void Function(DockingItem item)
- Event that will be triggered when a DockingItem selection is changed.
- OnReorder = void Function(int oldIndex, int newIndex)
- Event that will be triggered when the tab is reorder.
- OnTabClose = void Function(int tabIndex, TabData tabData)
- The event that will be triggered after the tab close.
- OnTabSelection = dynamic Function(int? newTabIndex)
- Event that will be triggered when the tab selection is changed.
- OnWeightChange = void Function()
- Signature for when a weight area is changed.
-
TabbedViewMenuBuilder
= List<
TabbedViewMenuItem> Function(BuildContext context) - Menu builder
- TabCloseInterceptor = bool Function(int tabIndex)
- Intercepts a close event to indicates whether the tab can be closed.
- TabLeadingBuilder = Widget? Function(BuildContext context, TabStatus status)
- Signature for a function that builds a leading widget in tab.
-
TabsAreaButtonsBuilder
= List<
TabButton> Function(BuildContext context, int tabsCount) - Tabs area buttons builder
- TabSelectInterceptor = bool Function(int newTabIndex)
- Intercepts a select event to indicate whether the tab can be selected.