aetna_core/
lib.rs

1#![doc = include_str!("../README.md")]
2//!
3//! # Rendering smoke test
4//!
5//! Any `App` builds and renders headlessly through the bundle pipeline:
6//!
7//! ```
8//! use aetna_core::prelude::*;
9//!
10//! struct Demo;
11//!
12//! impl App for Demo {
13//!     fn build(&self, _cx: &BuildCx) -> El {
14//!         card([
15//!             card_header([card_title("Hello")]),
16//!             card_content([text("rendered headlessly")]),
17//!         ])
18//!         .width(Size::Fixed(320.0))
19//!     }
20//! }
21//!
22//! let app = Demo;
23//! let theme = app.theme();
24//! let mut ui = app.build(&BuildCx::new(&theme));
25//! let bundle = render_bundle(&mut ui, Rect::new(0.0, 0.0, 720.0, 400.0));
26//! assert!(!bundle.svg.is_empty());
27//! ```
28//!
29//! # Rendering pipeline
30//!
31//! Builders produce an [`El`] tree. Layout writes rects into [`UiState`].
32//! The draw-op pass resolves visual facts into backend-neutral [`DrawOp`]
33//! values. Backend runners turn those draw ops into GPU resources and
34//! route pointer/keyboard input back into [`UiEvent`] values.
35//!
36//! The stock surface shader is `rounded_rect`; text, icons, custom
37//! shaders, and backdrop-sampling materials all flow through the same
38//! tree and event model.
39
40pub mod affine;
41pub mod anim;
42pub mod bundle;
43pub mod clipboard;
44pub mod cursor;
45pub mod draw_ops;
46pub mod event;
47pub mod focus;
48pub mod hit_test;
49pub mod icon_msdf;
50pub mod icon_msdf_atlas;
51pub mod icons;
52pub mod image;
53mod inline_mixed;
54pub mod ir;
55pub mod layout;
56pub mod math;
57pub mod metrics;
58#[doc(hidden)]
59pub mod paint;
60pub mod palette;
61pub mod prelude;
62pub mod profile;
63#[doc(hidden)]
64pub mod runtime;
65pub mod scroll;
66pub mod selection;
67pub mod shader;
68pub mod state;
69pub mod style;
70pub mod surface;
71pub mod svg_icon;
72pub mod text;
73pub mod theme;
74pub mod toast;
75pub mod tokens;
76pub mod tooltip;
77pub mod tree;
78pub mod vector;
79pub mod widgets;
80
81// Prelude — for `use aetna_core::*;`.
82pub use anim::{AnimProp, AnimValue, Animation, SpringConfig, Timing, TweenConfig};
83pub use bundle::artifact::{
84    Bundle, render_bundle, render_bundle_themed, render_bundle_with, render_bundle_with_theme,
85    write_bundle,
86};
87pub use bundle::inspect::dump_tree;
88pub use bundle::lint::{Finding, FindingKind, LintReport, lint};
89pub use bundle::manifest::{draw_ops_text, shader_manifest};
90pub use bundle::svg::svg_from_ops;
91pub use clipboard::{delete_selection_event, paste_text_event, selected_text_for_app};
92pub use cursor::Cursor;
93pub use draw_ops::{draw_ops, draw_ops_with_theme};
94pub use event::{
95    App, AppShader, BuildCx, FrameTrigger, HostDiagnostics, KeyChord, KeyModifiers, KeyPress,
96    PointerButton, UiEvent, UiEventKind, UiKey, UiTarget,
97};
98pub use focus::focus_order;
99pub use hit_test::{hit_test, hit_test_target};
100pub use icons::{IconStroke, all_icon_names, icon, icon_path, icon_strokes, icon_vector_asset};
101pub use ir::{DrawOp, TextAnchor};
102pub use layout::{LayoutCtx, LayoutFn, VirtualAnchorPolicy, VirtualItems, VirtualMode, layout};
103pub use math::{
104    MathAtom, MathDisplay, MathExpr, MathLayout, MathParseError, layout_math, parse_mathml,
105    parse_mathml_with_display, parse_tex,
106};
107pub use metrics::{ComponentSize, MetricsRole, ThemeMetrics};
108pub use shader::{ShaderBinding, ShaderHandle, StockShader, UniformBlock, UniformValue};
109pub use state::{AnimationMode, UiState, WidgetState};
110pub use style::StyleProfile;
111pub use surface::{
112    AppTexture, AppTextureBackend, AppTextureId, SurfaceAlpha, SurfaceFormat, SurfaceSource,
113    next_app_texture_id,
114};
115pub use svg_icon::{IconSource, IntoIconSource, SvgIcon, SvgIconPaintMode};
116// Atlas/glyph types are backend-implementer surface (consumed by
117// `aetna-wgpu` / `aetna-vulkano` paint paths). App authors don't
118// touch them, so hide from docs.rs while keeping them resolvable
119// at the crate root for backend imports.
120pub use palette::Palette;
121pub use selection::{Selection, SelectionPoint, SelectionRange, selected_text};
122#[doc(hidden)]
123pub use text::atlas::{
124    AtlasPage, AtlasRect, GlyphAtlas, GlyphKey, GlyphSlot, RunStyle, ShapedGlyph, ShapedRun,
125};
126pub use text::metrics::{
127    MeasuredText, TextGeometry, TextHit, TextLayout, TextLine, caret_xy, caret_xy_with_family,
128    hit_text, hit_text_with_family, layout_text, layout_text_with_family,
129    layout_text_with_line_height_and_family, line_height, line_width, line_width_with_family,
130    measure_text, selection_rects, selection_rects_with_family, wrap_lines, wrap_lines_with_family,
131};
132pub use theme::Theme;
133pub use tree::{
134    Align, Axis, Color, Corners, El, FontFamily, FontWeight, IconName, InteractionState, Justify,
135    Kind, Rect, Sides, Size, Source, SurfaceRole, TextAlign, TextOverflow, TextRole, TextWrap,
136    column, divider, hard_break, math, math_block, math_inline, row, scroll, spacer, stack,
137    surface, text_runs, vector, virtual_list, virtual_list_dyn,
138};
139pub use vector::{IconMaterial, VectorRenderMode};
140// Vector path / mesh tessellation types are internal-tooling surface.
141// `aetna_core::vector::*` keeps them reachable for tools that need
142// raw mesh access; hide from docs.rs and the crate-root prelude so
143// app authors aren't tempted to depend on them.
144#[doc(hidden)]
145pub use vector::{
146    PathBuilder, VectorAsset, VectorColor, VectorFill, VectorFillRule, VectorGradient,
147    VectorGradientStop, VectorLineCap, VectorLineJoin, VectorLinearGradient, VectorMesh,
148    VectorMeshOptions, VectorMeshRun, VectorMeshVertex, VectorParseError, VectorPath,
149    VectorRadialGradient, VectorSegment, VectorSpreadMethod, VectorStroke,
150    append_vector_asset_mesh, parse_svg_asset, tessellate_vector_asset,
151};
152
153pub use widgets::accordion::{
154    AccordionAction, accordion, accordion_content, accordion_item, accordion_item_key,
155    accordion_separator, accordion_trigger, accordion_trigger_with_icon,
156};
157pub use widgets::alert::{alert, alert_description, alert_title};
158pub use widgets::avatar::{DEFAULT_AVATAR_SIZE, avatar_fallback, avatar_image, avatar_initials};
159pub use widgets::badge::badge;
160pub use widgets::blockquote::blockquote;
161pub use widgets::breadcrumb::{
162    breadcrumb, breadcrumb_item, breadcrumb_link, breadcrumb_list, breadcrumb_page,
163    breadcrumb_separator,
164};
165pub use widgets::button::{button, button_with_icon, icon_button};
166pub use widgets::calendar::{CalendarAction, CalendarDay, calendar_day_key, calendar_month};
167pub use widgets::card::{
168    card, card_content, card_description, card_footer, card_header, card_title, titled_card,
169};
170pub use widgets::checkbox::checkbox;
171pub use widgets::code_block::{code_block, code_block_chrome};
172pub use widgets::command::{
173    command_group, command_icon, command_item, command_label, command_row, command_shortcut,
174};
175pub use widgets::dialog::{
176    dialog, dialog_content, dialog_description, dialog_footer, dialog_header, dialog_title,
177};
178pub use widgets::dropdown_menu::{
179    dropdown_menu, dropdown_menu_content, dropdown_menu_group, dropdown_menu_icon,
180    dropdown_menu_item, dropdown_menu_item_label, dropdown_menu_item_with_icon,
181    dropdown_menu_item_with_icon_and_shortcut, dropdown_menu_item_with_shortcut,
182    dropdown_menu_label, dropdown_menu_separator, dropdown_menu_shortcut,
183};
184pub use widgets::editor_tabs::{
185    ActiveTabStyle, CloseVisibility, EditorTabsAction, EditorTabsConfig, editor_tab,
186    editor_tab_add_key, editor_tab_close_key, editor_tab_select_key, editor_tabs, editor_tabs_with,
187};
188pub use widgets::form::{
189    field_row, form, form_control, form_description, form_item, form_label, form_message,
190    form_section,
191};
192pub use widgets::input_otp::input_otp;
193pub use widgets::item::{
194    item, item_actions, item_content, item_description, item_footer, item_group, item_header,
195    item_media, item_media_icon, item_separator, item_title,
196};
197pub use widgets::list::{bullet_list, numbered_list, numbered_list_from, task_list};
198pub use widgets::menubar::{
199    MenubarAction, menubar, menubar_content, menubar_group, menubar_icon, menubar_item,
200    menubar_item_label, menubar_item_with_icon, menubar_item_with_icon_and_shortcut,
201    menubar_item_with_shortcut, menubar_label, menubar_menu, menubar_separator, menubar_shortcut,
202    menubar_trigger, menubar_trigger_key,
203};
204pub use widgets::numeric_input::{NumericInputOpts, numeric_input};
205pub use widgets::overlay::{modal, modal_panel, overlay, overlays, scrim};
206pub use widgets::pagination::{
207    pagination, pagination_content, pagination_ellipsis, pagination_item, pagination_link,
208    pagination_next, pagination_previous,
209};
210pub use widgets::popover::{
211    Anchor, Side, anchor_rect, context_menu, dropdown, menu_item, popover, popover_panel,
212};
213pub use widgets::progress::progress;
214pub use widgets::radio::{RadioAction, radio_group, radio_item, radio_option_key};
215pub use widgets::select::{SelectAction, select_menu, select_option_key, select_trigger};
216pub use widgets::separator::{separator, vertical_separator};
217pub use widgets::sheet::{
218    SheetSide, sheet, sheet_content, sheet_description, sheet_footer, sheet_header, sheet_title,
219};
220pub use widgets::sidebar::{
221    sidebar, sidebar_group, sidebar_group_label, sidebar_header, sidebar_menu, sidebar_menu_button,
222    sidebar_menu_button_with_icon, sidebar_menu_item, sidebar_menu_label,
223};
224pub use widgets::skeleton::{skeleton, skeleton_circle};
225pub use widgets::slider::{SliderAction, slider};
226pub use widgets::switch::switch;
227pub use widgets::table::{
228    table, table_body, table_cell, table_head, table_head_el, table_header, table_row,
229};
230pub use widgets::tabs::{
231    TabsAction, tab_option_key, tab_trigger, tab_trigger_content, tabs_list,
232    tabs_list_from_triggers,
233};
234pub use widgets::text::{h1, h2, h3, mono, paragraph, text};
235pub use widgets::text_area::text_area;
236pub use widgets::text_input::{
237    ClipboardKind, MaskMode, TextInputOpts, TextSelection, text_input, text_input_with,
238};
239pub use widgets::toggle::{
240    ToggleAction, toggle, toggle_group, toggle_group_multi, toggle_item, toggle_option_key,
241};
242pub use widgets::toolbar::{toolbar, toolbar_description, toolbar_group, toolbar_title};
aetna_core/lib.rs

aetna_core/
lib.rs
