Skip to main content

cranpose_ui/
lib.rs

1//! High level UI primitives built on top of the Compose core runtime.
2
3use cranpose_core::{location_key, MemoryApplier};
4pub use cranpose_core::{Composition, Key};
5pub use cranpose_macros::composable;
6
7mod cursor_animation;
8mod debug;
9mod draw;
10pub mod fling_animation;
11mod focus_dispatch;
12mod key_event;
13pub mod layout;
14mod modifier;
15mod modifier_nodes;
16mod pointer_dispatch;
17mod primitives;
18mod render_state;
19mod renderer;
20pub mod scroll;
21mod subcompose_layout;
22pub mod text;
23pub mod text_field_focus;
24mod text_field_handler;
25mod text_field_input;
26mod text_field_modifier_node;
27pub mod text_layout_result;
28mod text_modifier_node;
29pub mod widgets;
30mod word_boundaries;
31
32// Export for cursor blink animation - AppShell checks this to continuously redraw
33pub use text_field_focus::has_focused_field;
34// Export cursor blink timing for WaitUntil scheduling
35pub use cursor_animation::{
36    is_cursor_visible, next_cursor_blink_time, reset_cursor_blink, start_cursor_blink,
37    stop_cursor_blink, tick_cursor_blink,
38};
39
40pub use cranpose_ui_graphics::{BlurredEdgeTreatment, ColorFilter, Dp, ImageBitmap};
41pub use cranpose_ui_layout::IntrinsicSize;
42pub use draw::{execute_draw_commands, DrawCacheBuilder, DrawCommand};
43pub use focus_dispatch::{
44    active_focus_target, clear_focus_invalidations, has_pending_focus_invalidations,
45    process_focus_invalidations, schedule_focus_invalidation, set_active_focus_target,
46};
47// Re-export FocusManager from cranpose-foundation to avoid duplication
48pub use cranpose_foundation::nodes::input::focus::FocusManager;
49pub use layout::{
50    build_layout_tree_from_applier, build_semantics_tree_from_applier,
51    build_semantics_tree_from_layout_tree,
52    core::{
53        Alignment, Arrangement, HorizontalAlignment, LinearArrangement, Measurable, Placeable,
54        VerticalAlignment,
55    },
56    measure_layout, measure_layout_with_options, tree_needs_layout, tree_needs_semantics,
57    LayoutAllocationDebugStats, LayoutBox, LayoutEngine, LayoutMeasurements, LayoutNodeData,
58    LayoutNodeKind, LayoutTree, MeasureLayoutOptions, SemanticsAction, SemanticsCallback,
59    SemanticsNode, SemanticsRole, SemanticsTree,
60};
61pub use modifier::{
62    collect_modifier_slices, collect_semantics_from_modifier, collect_slices_from_modifier,
63    BlendMode, Brush, Color, CompositingStrategy, CornerRadii, DpOffset, EdgeInsets,
64    FocusDirection, FocusRequester, GraphicsLayer, LayerShape, Modifier, ModifierNodeSlices,
65    ModifierNodeSlicesDebugStats, Point, PointerEvent, PointerEventKind, PointerInputScope, Rect,
66    RenderEffect, ResolvedBackground, ResolvedModifiers, RoundedCornerShape, RuntimeShader, Shadow,
67    ShadowScope, Size, TransformOrigin,
68};
69pub use modifier_nodes::{
70    AlphaElement, AlphaNode, BackgroundElement, BackgroundNode, ClickableElement, ClickableNode,
71    CornerShapeElement, CornerShapeNode, FillDirection, FillElement, FillNode, OffsetElement,
72    OffsetNode, PaddingElement, PaddingNode, SizeElement, SizeNode,
73};
74pub use pointer_dispatch::{
75    clear_pointer_repasses, has_pending_pointer_repasses, process_pointer_repasses,
76    schedule_pointer_repass,
77};
78pub use primitives::{
79    BasicText, BasicTextField, BasicTextFieldOptions, BitmapPainter, Box, BoxScope, BoxSpec,
80    BoxWithConstraints, BoxWithConstraintsScope, BoxWithConstraintsScopeImpl, Button, Canvas,
81    Column, ColumnSpec, ContentScale, ForEach, Image, Layout, LayoutNode, Painter, Row, RowSpec,
82    Spacer, SubcomposeLayout, Text, DEFAULT_ALPHA,
83};
84// Lazy list exports - single source from cranpose-foundation
85pub use cranpose_foundation::lazy::{LazyListItemInfo, LazyListLayoutInfo, LazyListState};
86pub use key_event::{KeyCode, KeyEvent, KeyEventType, Modifiers};
87#[cfg(any(test, feature = "test-helpers"))]
88#[doc(hidden)]
89pub use render_state::reset_render_state_for_tests;
90pub use render_state::{
91    current_density, has_pending_draw_repasses, has_pending_layout_repasses,
92    peek_focus_invalidation, peek_layout_invalidation, peek_pointer_invalidation,
93    peek_render_invalidation, request_focus_invalidation, request_layout_invalidation,
94    request_pointer_invalidation, request_render_invalidation, schedule_draw_repass,
95    schedule_layout_repass, set_density, take_draw_repass_nodes, take_focus_invalidation,
96    take_layout_invalidation, take_layout_repass_nodes, take_pointer_invalidation,
97    take_render_invalidation,
98};
99pub use renderer::{HeadlessRenderer, PaintLayer, RecordedRenderScene, RenderOp};
100pub use scroll::{ScrollElement, ScrollNode, ScrollState};
101// Test utilities for fling velocity verification (only with test-helpers feature)
102#[cfg(feature = "test-helpers")]
103pub use modifier::{last_fling_velocity, reset_last_fling_velocity};
104pub use subcompose_layout::{
105    Constraints, MeasureResult, Placement, SubcomposeLayoutNode, SubcomposeLayoutScope,
106    SubcomposeMeasureScope, SubcomposeMeasureScopeImpl,
107};
108pub use text::{
109    get_cursor_x_for_offset, get_offset_for_position, layout_text, measure_text,
110    measure_text_for_node, measure_text_with_options, measure_text_with_options_for_node,
111    prepare_text_layout, prepare_text_layout_for_node, set_text_measurer, LinkAnnotation,
112    ParagraphStyle, PlatformParagraphStyle, PlatformSpanStyle, PlatformTextStyle,
113    PreparedTextLayout, SpanStyle, StringAnnotation, TextDrawStyle, TextLayoutOptions,
114    TextMeasurer, TextMetrics, TextOverflow, TextShaping, TextStyle,
115};
116pub use text_field_modifier_node::{TextFieldElement, TextFieldModifierNode};
117pub use text_modifier_node::{TextModifierElement, TextModifierNode};
118pub use widgets::clickable_text::ClickableText;
119pub use widgets::lazy_list::{LazyColumn, LazyColumnSpec, LazyRow, LazyRowSpec};
120pub use widgets::linked_text::LinkedText;
121
122// Debug utilities
123pub use debug::{
124    format_layout_tree, format_modifier_chain, format_render_scene, format_screen_summary,
125    install_modifier_chain_trace, log_layout_tree, log_modifier_chain, log_render_scene,
126    log_screen_summary, ModifierChainTraceGuard,
127};
128
129/// Convenience alias used in examples and tests.
130pub type TestComposition = Composition<MemoryApplier>;
131
132/// Build a composition with a simple in-memory applier and run the provided closure once.
133pub fn run_test_composition(build: impl FnMut()) -> TestComposition {
134    #[cfg(test)]
135    reset_render_state_for_tests();
136    let mut composition = Composition::new(MemoryApplier::new());
137    composition
138        .render(location_key(file!(), line!(), column!()), build)
139        .expect("initial render succeeds");
140    composition
141}
142
143pub use cranpose_core::MutableState as SnapshotState;
144
145#[cfg(test)]
146#[path = "tests/anchor_async_tests.rs"]
147mod anchor_async_tests;
148
149#[cfg(test)]
150#[path = "tests/async_runtime_full_layout_test.rs"]
151mod async_runtime_full_layout_test;
152
153#[cfg(test)]
154#[path = "tests/cursor_position_tests.rs"]
155mod cursor_position_tests;
156
157#[cfg(test)]
158#[path = "tests/tab_switching_tests.rs"]
159mod tab_switching_tests;
160
161#[cfg(test)]
162#[path = "tests/lazy_list_viewport_tests.rs"]
163mod lazy_list_viewport_tests;
164
165#[cfg(test)]
166#[path = "tests/lazy_list_recompose_tests.rs"]
167mod lazy_list_recompose_tests;