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::{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    core::{
51        Alignment, Arrangement, HorizontalAlignment, LinearArrangement, Measurable, Placeable,
52        VerticalAlignment,
53    },
54    measure_layout, tree_needs_layout, LayoutBox, LayoutEngine, LayoutMeasurements, LayoutNodeData,
55    LayoutNodeKind, LayoutTree, SemanticsAction, SemanticsCallback, SemanticsNode, SemanticsRole,
56    SemanticsTree,
57};
58pub use modifier::{
59    collect_modifier_slices, collect_slices_from_modifier, Brush, Color, CornerRadii, EdgeInsets,
60    GraphicsLayer, Modifier, ModifierNodeSlices, Point, PointerEvent, PointerEventKind,
61    PointerInputScope, Rect, ResolvedBackground, ResolvedModifiers, RoundedCornerShape, Size,
62};
63pub use modifier_nodes::{
64    AlphaElement, AlphaNode, BackgroundElement, BackgroundNode, ClickableElement, ClickableNode,
65    CornerShapeElement, CornerShapeNode, FillDirection, FillElement, FillNode, OffsetElement,
66    OffsetNode, PaddingElement, PaddingNode, SizeElement, SizeNode,
67};
68pub use pointer_dispatch::{
69    clear_pointer_repasses, has_pending_pointer_repasses, process_pointer_repasses,
70    schedule_pointer_repass,
71};
72pub use primitives::{
73    BasicTextField, BasicTextFieldOptions, BitmapPainter, Box, BoxScope, BoxSpec,
74    BoxWithConstraints, BoxWithConstraintsScope, BoxWithConstraintsScopeImpl, Button, Canvas,
75    Column, ColumnSpec, ContentScale, ForEach, Image, Layout, LayoutNode, Painter, Row, RowSpec,
76    Spacer, SubcomposeLayout, Text, DEFAULT_ALPHA,
77};
78// Lazy list exports - single source from cranpose-foundation
79pub use cranpose_foundation::lazy::{LazyListItemInfo, LazyListLayoutInfo, LazyListState};
80pub use key_event::{KeyCode, KeyEvent, KeyEventType, Modifiers};
81pub use render_state::{
82    current_density, has_pending_draw_repasses, has_pending_layout_repasses,
83    peek_focus_invalidation, peek_layout_invalidation, peek_pointer_invalidation,
84    peek_render_invalidation, request_focus_invalidation, request_layout_invalidation,
85    request_pointer_invalidation, request_render_invalidation, schedule_draw_repass,
86    schedule_layout_repass, set_density, take_draw_repass_nodes, take_focus_invalidation,
87    take_layout_invalidation, take_layout_repass_nodes, take_pointer_invalidation,
88    take_render_invalidation,
89};
90pub use renderer::{HeadlessRenderer, PaintLayer, RecordedRenderScene, RenderOp};
91pub use scroll::{ScrollElement, ScrollNode, ScrollState};
92// Test utilities for fling velocity verification (only with test-helpers feature)
93#[cfg(feature = "test-helpers")]
94pub use modifier::{last_fling_velocity, reset_last_fling_velocity};
95pub use subcompose_layout::{
96    Constraints, MeasureResult, Placement, SubcomposeLayoutNode, SubcomposeLayoutScope,
97    SubcomposeMeasureScope, SubcomposeMeasureScopeImpl,
98};
99pub use text::{
100    get_cursor_x_for_offset, get_offset_for_position, layout_text, measure_text, set_text_measurer,
101    TextMeasurer, TextMetrics, TextStyle,
102};
103pub use text_field_modifier_node::{TextFieldElement, TextFieldModifierNode};
104pub use text_modifier_node::{TextModifierElement, TextModifierNode};
105pub use widgets::lazy_list::{LazyColumn, LazyColumnSpec, LazyRow, LazyRowSpec};
106
107// Debug utilities
108pub use debug::{
109    format_layout_tree, format_modifier_chain, format_render_scene, install_modifier_chain_trace,
110    log_layout_tree, log_modifier_chain, log_render_scene, log_screen_summary,
111    ModifierChainTraceGuard,
112};
113
114/// Convenience alias used in examples and tests.
115pub type TestComposition = Composition<MemoryApplier>;
116
117/// Build a composition with a simple in-memory applier and run the provided closure once.
118pub fn run_test_composition(build: impl FnMut()) -> TestComposition {
119    let mut composition = Composition::new(MemoryApplier::new());
120    composition
121        .render(location_key(file!(), line!(), column!()), build)
122        .expect("initial render succeeds");
123    composition
124}
125
126pub use cranpose_core::MutableState as SnapshotState;
127
128#[cfg(test)]
129#[path = "tests/anchor_async_tests.rs"]
130mod anchor_async_tests;
131
132#[cfg(test)]
133#[path = "tests/async_runtime_full_layout_test.rs"]
134mod async_runtime_full_layout_test;
135
136#[cfg(test)]
137#[path = "tests/cursor_position_tests.rs"]
138mod cursor_position_tests;
139
140#[cfg(test)]
141#[path = "tests/tab_switching_tests.rs"]
142mod tab_switching_tests;
143
144#[cfg(test)]
145#[path = "tests/lazy_list_viewport_tests.rs"]
146mod lazy_list_viewport_tests;
147
148#[cfg(test)]
149#[path = "tests/lazy_list_recompose_tests.rs"]
150mod lazy_list_recompose_tests;