fret_ui/
lib.rs

1//! UI runtime contract and mechanisms for the Fret workspace.
2//!
3//! This crate focuses on the **mechanisms** needed for editor-grade UI (tree, layout, input
4//! routing, paint orchestration) rather than policy-heavy components. Radix/shadcn-style
5//! interaction policies live in the ecosystem layer (`fret-ui-kit`, `fret-ui-shadcn`) instead.
6//!
7//! For module ownership and “where should this go?” guidance, see `crates/fret-ui/README.md`.
8//!
9//! ## Where to start
10//!
11//! - [`UiTree`]: retained UI tree and per-window interaction state machine
12//! - [`ElementContext`]: per-frame context passed to element constructors
13//! - [`AnyElement`]: type-erased element node used by the declarative surface
14//! - [`Theme`]/[`ThemeConfig`]: token-driven theme configuration
15//!
16//! Most applications should not wire this crate directly; prefer `fret-bootstrap` or the
17//! ecosystem `fret` facade for the “golden path” runner/driver wiring.
18
19#![cfg_attr(test, allow(clippy::arc_with_non_send_sync))]
20
21pub mod action;
22pub mod cache_key;
23pub mod canvas;
24pub mod declarative;
25mod drag_route;
26pub mod element;
27pub mod elements;
28#[cfg(any(test, feature = "compat-retained-widgets"))]
29pub mod fixed_split;
30pub mod focus_visible;
31mod frame_cx;
32pub mod frame_pipeline;
33pub mod host;
34pub mod input_modality;
35pub mod internal_drag;
36mod layout;
37pub use layout::constraints as layout_constraints;
38pub use layout::engine as layout_engine;
39#[doc(hidden)]
40pub use layout::overflow::LayoutOverflowContext;
41pub use layout::pass as layout_pass;
42pub mod overlay_placement;
43pub mod paint;
44pub mod pending_shortcut;
45pub mod pixel_snap;
46mod pointer_motion;
47#[cfg(feature = "unstable-retained-bridge")]
48pub mod retained_bridge;
49mod runtime_config;
50pub(crate) mod strict_runtime;
51/// Stable key type used by keyed element APIs (e.g. lists and cached subtrees).
52pub type ItemKey = u64;
53#[allow(dead_code)]
54pub(crate) mod resizable_panel_group;
55#[allow(dead_code)]
56pub(crate) mod resizable_split;
57#[allow(dead_code)]
58pub(crate) mod resize_handle;
59pub mod scroll;
60mod svg_source;
61#[cfg(test)]
62mod test_host;
63mod text;
64pub(crate) use text::area as text_area;
65pub(crate) use text::edit as text_edit;
66pub(crate) use text::input as text_input;
67pub(crate) use text::props as text_props;
68pub(crate) use text::surface as text_surface;
69pub mod theme;
70pub use theme::keys as theme_keys;
71pub(crate) use theme::registry as theme_registry;
72pub mod tree;
73pub mod virtual_list;
74#[allow(dead_code)]
75pub(crate) mod widget;
76pub(crate) mod windowed_surface_host;
77
78pub use elements::{ElementContext, ElementContextAccess, ElementRuntime, GlobalElementId};
79#[cfg(any(test, feature = "compat-retained-widgets"))]
80pub use fixed_split::FixedSplit;
81pub use frame_cx::{UiFrameContext, UiFrameCx};
82pub use host::UiHost;
83pub use pending_shortcut::PendingShortcutOverlayState;
84pub use resizable_panel_group::ResizablePanelGroupStyle;
85pub use scroll::{ScrollHandle, ScrollStrategy, VirtualListScrollHandle};
86pub use svg_source::SvgSource;
87pub use text::{TextAreaStyle, TextInputStyle};
88pub use theme::{Theme, ThemeConfig, ThemeSnapshot};
89pub use theme_keys::{ThemeColorKey, ThemeMetricKey, ThemeNamedColorKey};
90pub use tree::{
91    OverlayRootOptions, PaintCachePolicy, UiDebugFrameStats, UiDebugHitTest,
92    UiDebugHoverDeclarativeInvalidationHotspot, UiDebugLayerInfo, UiLayerId, UiTree,
93};
94pub use widget::CommandAvailability;
95pub use widget::Invalidation;
fret_ui/lib.rs

fret_ui/
lib.rs
