aetna-core 0.3.0

//! Backend-agnostic UI primitives for Aetna apps.
//!
//! Most applications should start with [`prelude`]:
//!
//! ```
//! use aetna_core::prelude::*;
//! ```
//!
//! The app-facing model is deliberately small:
//!
//! 1. Store your application state in a struct.
//! 2. Implement [`App`] for that struct.
//! 3. Refresh external state in [`App::before_build`] when needed.
//! 4. Return a fresh [`El`] tree from [`App::build`].
//! 5. Update your state from routed [`UiEvent`] values in
//!    [`App::on_event`].
//! 6. Run the app through a host crate such as `aetna-winit-wgpu`, or
//!    integrate a backend runner directly in a custom host.
//!
//! # Quick example
//!
//! ```
//! use aetna_core::prelude::*;
//!
//! struct Counter {
//!     value: i32,
//! }
//!
//! impl App for Counter {
//!     fn build(&self, _cx: &BuildCx) -> El {
//!         column([
//!             h1(format!("{}", self.value)),
//!             row([
//!                 button("-").key("dec"),
//!                 button("+").key("inc").primary(),
//!             ])
//!             .gap(tokens::SPACE_SM),
//!         ])
//!         .gap(tokens::SPACE_MD)
//!         .padding(tokens::SPACE_LG)
//!     }
//!
//!     fn on_event(&mut self, event: UiEvent) {
//!         if event.is_click_or_activate("inc") {
//!             self.value += 1;
//!         } else if event.is_click_or_activate("dec") {
//!             self.value -= 1;
//!         }
//!     }
//! }
//!
//! let app = Counter { value: 0 };
//! let theme = app.theme();
//! let mut ui = app.build(&BuildCx::new(&theme));
//! let bundle = render_bundle(&mut ui, Rect::new(0.0, 0.0, 720.0, 400.0), None);
//! assert!(!bundle.svg.is_empty());
//! ```
//!
//! # Running a native window
//!
//! In a desktop app, add `aetna-winit-wgpu` and pass your `App` to its
//! host:
//!
//! ```ignore
//! use aetna_core::prelude::*;
//!
//! fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     let viewport = Rect::new(0.0, 0.0, 720.0, 480.0);
//!     aetna_winit_wgpu::run("Counter", viewport, Counter { value: 0 })
//! }
//! ```
//!
//! Use `aetna-wgpu::Runner` directly only when you are writing your own
//! host or embedding Aetna into an existing render loop.
//!
//! # Public API layers
//!
//! - [`prelude`] is the app and widget author surface an LLM should
//!   usually import.
//! - [`widgets`] contains controlled widget builders and their helper
//!   modules, such as `text_input::apply_event` and
//!   `slider::normalized_from_event`.
//! - [`bundle`] is for headless artifacts, tests, and design review.
//! - [`ir`], [`paint`], [`runtime`], text atlas, vector mesh, and MSDF
//!   modules are advanced backend/diagnostic surfaces. They are public
//!   because sibling backend crates use them, but ordinary app code
//!   should not start there.
//!
//! # Rendering pipeline
//!
//! Builders produce an [`El`] tree. Layout writes rects into [`UiState`].
//! The draw-op pass resolves visual facts into backend-neutral [`DrawOp`]
//! values. Backend runners turn those draw ops into GPU resources and
//! route pointer/keyboard input back into [`UiEvent`] values.
//!
//! The stock surface shader is `rounded_rect`; text, icons, custom
//! shaders, and backdrop-sampling materials all flow through the same
//! tree and event model.
//!
//! # Packaged examples
//!
//! The crate ships runnable examples under `examples/`. After adding
//! the crate from crates.io, inspect or run these for focused usage
//! patterns: `settings`, `scroll_list`, `virtual_list`, `inline_runs`,
//! `modal`, `custom_shader`, and `circular_layout`.

pub mod anim;
pub mod bundle;
pub mod cursor;
pub mod draw_ops;
pub mod event;
pub mod focus;
pub mod hit_test;
pub mod icon_msdf;
pub mod icon_msdf_atlas;
pub mod icons;
pub mod image;
pub mod ir;
pub mod layout;
pub mod metrics;
#[doc(hidden)]
pub mod paint;
pub mod palette;
pub mod prelude;
#[doc(hidden)]
pub mod runtime;
pub mod selection;
pub mod shader;
pub mod state;
pub mod style;
pub mod svg_icon;
pub mod text;
pub mod theme;
pub mod toast;
pub mod tokens;
pub mod tooltip;
pub mod tree;
pub mod vector;
pub mod widgets;

// Prelude — for `use aetna_core::*;`.
pub use anim::{AnimProp, AnimValue, Animation, SpringConfig, Timing, TweenConfig};
pub use bundle::artifact::{
    Bundle, render_bundle, render_bundle_themed, render_bundle_with, render_bundle_with_theme,
    write_bundle,
};
pub use bundle::inspect::dump_tree;
pub use bundle::lint::{Finding, FindingKind, LintReport, lint};
pub use bundle::manifest::{draw_ops_text, shader_manifest};
pub use bundle::svg::svg_from_ops;
pub use cursor::Cursor;
pub use draw_ops::{draw_ops, draw_ops_with_theme};
pub use event::{
    App, AppShader, BuildCx, KeyChord, KeyModifiers, KeyPress, PointerButton, UiEvent, UiEventKind,
    UiKey, UiTarget,
};
pub use focus::focus_order;
pub use hit_test::{hit_test, hit_test_target};
pub use icons::{IconStroke, all_icon_names, icon, icon_path, icon_strokes, icon_vector_asset};
pub use ir::{DrawOp, TextAnchor};
pub use layout::{LayoutCtx, LayoutFn, VirtualItems, layout};
pub use metrics::{ComponentSize, Density, LayoutMetrics, MetricsRole, ThemeMetrics};
pub use shader::{ShaderBinding, ShaderHandle, StockShader, UniformBlock, UniformValue};
pub use state::{AnimationMode, UiState, WidgetState};
pub use style::StyleProfile;
pub use svg_icon::{IconSource, IntoIconSource, SvgIcon};
// Atlas/glyph types are backend-implementer surface (consumed by
// `aetna-wgpu` / `aetna-vulkano` paint paths). App authors don't
// touch them, so hide from docs.rs while keeping them resolvable
// at the crate root for backend imports.
pub use palette::Palette;
pub use selection::{Selection, SelectionPoint, SelectionRange, selected_text};
#[doc(hidden)]
pub use text::atlas::{
    AtlasPage, AtlasRect, GlyphAtlas, GlyphKey, GlyphSlot, RunStyle, ShapedGlyph, ShapedRun,
};
pub use text::metrics::{
    MeasuredText, TextGeometry, TextHit, TextLayout, TextLine, caret_xy, caret_xy_with_family,
    hit_text, hit_text_with_family, layout_text, layout_text_with_family,
    layout_text_with_line_height_and_family, line_height, line_width, line_width_with_family,
    measure_text, selection_rects, selection_rects_with_family, wrap_lines, wrap_lines_with_family,
};
pub use theme::Theme;
pub use tree::{
    Align, Axis, Color, El, FontFamily, FontWeight, IconName, InteractionState, Justify, Kind,
    Rect, Sides, Size, Source, SurfaceRole, TextAlign, TextOverflow, TextRole, TextWrap, column,
    divider, hard_break, row, scroll, spacer, stack, text_runs, virtual_list,
};
pub use vector::IconMaterial;
// Vector path / mesh tessellation types are internal-tooling surface.
// `aetna_core::vector::*` keeps them reachable for tools that need
// raw mesh access; hide from docs.rs and the crate-root prelude so
// app authors aren't tempted to depend on them.
#[doc(hidden)]
pub use vector::{
    VectorAsset, VectorColor, VectorFill, VectorFillRule, VectorLineCap, VectorLineJoin,
    VectorMesh, VectorMeshOptions, VectorMeshRun, VectorMeshVertex, VectorParseError, VectorPath,
    VectorSegment, VectorStroke, append_vector_asset_mesh, parse_svg_asset,
    tessellate_vector_asset,
};

pub use widgets::accordion::{
    AccordionAction, accordion, accordion_content, accordion_item, accordion_item_key,
    accordion_separator, accordion_trigger, accordion_trigger_with_icon,
};
pub use widgets::alert::{alert, alert_description, alert_title};
pub use widgets::avatar::{DEFAULT_AVATAR_SIZE, avatar_fallback, avatar_image, avatar_initials};
pub use widgets::badge::badge;
pub use widgets::breadcrumb::{
    breadcrumb, breadcrumb_item, breadcrumb_link, breadcrumb_list, breadcrumb_page,
    breadcrumb_separator,
};
pub use widgets::button::{button, button_with_icon, icon_button};
pub use widgets::card::{
    card, card_content, card_description, card_footer, card_header, card_title, titled_card,
};
pub use widgets::checkbox::checkbox;
pub use widgets::command::{
    command_group, command_icon, command_item, command_label, command_row, command_shortcut,
};
pub use widgets::dialog::{
    dialog, dialog_content, dialog_description, dialog_footer, dialog_header, dialog_title,
};
pub use widgets::dropdown_menu::{
    dropdown_menu, dropdown_menu_content, dropdown_menu_group, dropdown_menu_icon,
    dropdown_menu_item, dropdown_menu_item_label, dropdown_menu_item_with_icon,
    dropdown_menu_item_with_icon_and_shortcut, dropdown_menu_item_with_shortcut,
    dropdown_menu_label, dropdown_menu_separator, dropdown_menu_shortcut,
};
pub use widgets::form::{
    field_row, form, form_control, form_description, form_item, form_label, form_message,
    form_section,
};
pub use widgets::overlay::{modal, modal_panel, overlay, overlays, scrim};
pub use widgets::pagination::{
    pagination, pagination_content, pagination_ellipsis, pagination_item, pagination_link,
    pagination_next, pagination_previous,
};
pub use widgets::popover::{
    Anchor, Side, anchor_rect, context_menu, dropdown, menu_item, popover, popover_panel,
};
pub use widgets::progress::progress;
pub use widgets::radio::{RadioAction, radio_group, radio_item, radio_option_key};
pub use widgets::select::{SelectAction, select_menu, select_option_key, select_trigger};
pub use widgets::separator::{separator, vertical_separator};
pub use widgets::sheet::{
    SheetSide, sheet, sheet_content, sheet_description, sheet_footer, sheet_header, sheet_title,
};
pub use widgets::sidebar::{
    sidebar, sidebar_group, sidebar_group_label, sidebar_header, sidebar_menu, sidebar_menu_button,
    sidebar_menu_button_with_icon, sidebar_menu_item, sidebar_menu_label,
};
pub use widgets::skeleton::{skeleton, skeleton_circle};
pub use widgets::slider::{SliderAction, slider};
pub use widgets::switch::switch;
pub use widgets::table::{table, table_body, table_cell, table_head, table_header, table_row};
pub use widgets::tabs::{TabsAction, tab_option_key, tab_trigger, tabs_list};
pub use widgets::text::{h1, h2, h3, mono, paragraph, text};
pub use widgets::text_area::text_area;
pub use widgets::text_input::{
    ClipboardKind, MaskMode, TextInputOpts, TextSelection, text_input, text_input_with,
};
pub use widgets::toolbar::{toolbar, toolbar_description, toolbar_group, toolbar_title};