Documentation

Fields

• pgLayout :: !(Layout -> Layout)

  Layout modifier for the grid container (default id); pass fillW . fillH to fill the parent area.

• pgSpacing :: !Float

  Gutter between panes per split level (default 4).

• pgMinSize :: !Float

  Minimum physical size any pane may shrink to (default 40).

• pgLeeway :: !Float

  Extra grab margin on each side of a divider, added to pgSpacing to form the divider's real layout gutter. The resize cursor and grab work anywhere in that gutter while only pgSpacing is drawn crisp, so the interaction space is far wider than the visible line (default 6).

• pgEdgeBand :: !Float

  Thickness of the grid's outer edge that acts as a top-level drop zone (default 20). Dragging a pane into this band restructures the whole grid instead of a single pane: the tree is wrapped in a new top-level split with the dragged pane on that side.

• pgViewPane :: !(Word64 -> PaneGridCtx es -> Eff es PaneView)

  Renders the content of one pane.

Fields

• pgcPaneId :: !Word64
   
• pgcRect :: !Rect

  Prev-frame screen rect of this pane (zero until it has been laid out once; the whole grid rect while maximized). Use it to build pvDragPick handles such as a title-bar sub-rect.

• pgcMaximized :: !Bool

  True when this pane currently fills the whole grid.

• pgcDragging :: !Bool

  True while this pane's drag is armed. Once the drag threshold is crossed, the pane is omitted from the visible layout until release.

• pgcDndActive :: !Bool

  True while any pane drag-and-drop gesture is in progress.

• pgcSplit :: !(GridAxis -> Eff es Word64)

  Split this pane along the axis; returns the new pane id.

• pgcClose :: !(Eff es ())
   
• pgcMaximize :: !(Eff es ())
   
• pgcRestore :: !(Eff es ())
   

Fields

• pvTitle :: !Text

  Label shown (abbreviated to fit) on the compact drag indicator.

• pvDraggable :: !Bool

  Grab the pane anywhere inside its own region to drag-and-drop it. This is the easy way to reorder panes without drawing a dedicated handle. Interactive children keep their pointer presses. Pane still needs a drag only on a sub-region? see pvDragPick.

• pvDragPick :: !(Maybe Rect)

  Optional absolute sub-region (e.g. just a title bar; position it via pgcRect) that also starts a drag. Both handles combine: the pane drags if the press lands in this rect or (when pvDraggable) anywhere in the pane. Nothing here and pvDraggable False makes the pane immovable.

Fields

• pgrChanged :: !Bool

  Any structural or maximize change happened this frame.

• pgrPaneCount :: !Int

  Number of panes (0 once the last pane has been closed).

• pgrPanes :: ![Word64]

  Live pane ids, depth-first.

• pgrFocusedPane :: !Word64

  Focused pane id, 0 when the grid has no panes.

• pgrMaximizedPane :: !Word64

  Maximized pane id, 0 when none.