panes 0.19.0

Renderer-agnostic layout engine with declarative ergonomics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! Renderer-agnostic spatial layout engine.
//!
//! Describe panels in rows, columns, and presets. panes solves the geometry
//! via Taffy's flexbox engine and hands back a map of `PanelId → Rect`.

mod adapter;
mod breakpoint;
mod builder;
/// Compiles a [`LayoutTree`] into a Taffy tree for layout computation.
pub mod compiler;
mod decoration;
/// Frame-to-frame diffing of resolved layouts.
pub mod diff;
mod error;
mod focus;
mod focus_outcome;
mod layout;
mod macros;
mod node;
/// Overlay types for floating UI elements rendered above the base layout.
pub mod overlay;
mod panel;
mod preset;
mod rect;
mod resize;
/// Resolves compiled Taffy output into [`ResolvedLayout`].
pub mod resolver;
/// Stateful runtime with viewport tracking, caching, and frame diffing.
pub mod runtime;
mod runtime_overlay;
/// Ordered panel sequence for focus navigation.
mod sequence;
/// Serializable snapshots for session persistence.
mod snapshot;
/// Layout mutation strategies mapped to presets.
mod strategy;
#[cfg(feature = "toml")]
mod toml_parse;
mod tree;
mod validate;
mod viewport;

pub use adapter::AdapterFrame;
pub use breakpoint::{AdaptiveBuilder, BreakpointEntry};
pub use builder::{ContainerCtx, Grid, GridCtx, LayoutBuilder};
pub use decoration::DecorationRole;
pub use diff::{
    DiffResult, LayoutDiff, OverlayDiff, OverlayDiffScratch, OverlayRectChange, PanelDiffScratch,
    PanelRectChange, PanelScratch, RectChange,
};
pub use error::{ConstraintError, MutationError, PaneError, TreeError, ViewportError};
pub use focus::FocusDirection;
pub use focus_outcome::{FocusOutcome, FocusRejection};
pub use layout::Layout;
pub use node::{Node, NodeId, PanelId, PanelKey};
pub use overlay::{
    AnchorFailure, ExtentValue, HAlign, Overlay, OverlayAnchor, OverlayDef, OverlayEntry,
    OverlayExtent, OverlayId, SnapshotOverlay, VAlign,
};
pub use panel::{Align, Axis, Constraints, PanelIdGenerator, SizeMode, fixed, grow};
pub use preset::{
    ActivePanelPreset, CenteredMaster, Dashboard, Deck, Dwindle, HolyGrail, MasterStack, Monocle,
    PanelInputKind, PresetInfo, Scrollable, Sidebar, Spiral, Split, Stacked, Tabbed,
};
pub use rect::Rect;
pub use resolver::{BoundaryAxis, BoundaryHit, DecorationPanelInfo, PanelEntry, ResolvedLayout};
pub use runtime::Placement;
pub use sequence::PanelSequence;
pub use snapshot::{
    LayoutSnapshot, SnapshotBreakpoint, SnapshotGridItem, SnapshotNode, SnapshotSlotDef,
    SnapshotSource, StrategyConfig,
};
pub use strategy::{
    ActivePanelStrategy, ActivePanelVariant, BinarySplitStrategy, BoundStrategy, CardSpan,
    CenteredMasterStrategy, DashboardStrategy, DeckStrategy, GridColumnMode, HolyGrailStrategy,
    MasterStackStrategy, SidebarStrategy, SlotDef, SplitStrategy, Strategy, StrategyKind,
    WindowStrategy,
};
#[cfg(feature = "toml")]
pub use toml_parse::TomlError;
pub use tree::{LayoutTree, Position};
pub use viewport::ViewportState;

#[doc(hidden)]
pub use rustc_hash::FxHashMap as __FxHashMap;