mod any_props; mod arena; mod bump_frame; mod create; mod diff; mod dirty_scope; mod error_boundary; mod events; mod factory; mod fragment; mod lazynodes; mod mutations; mod nodes; mod properties; mod scheduler; mod scope_arena; mod scopes; mod virtual_dom; pub(crate) mod innerlude { pub use crate::arena::*; pub use crate::dirty_scope::*; pub use crate::events::*; pub use crate::fragment::*; pub use crate::lazynodes::*; pub use crate::mutations::*; pub use crate::nodes::*; pub use crate::properties::*; pub use crate::scheduler::*; pub use crate::scopes::*; pub use crate::virtual_dom::*; /// An [`Element`] is a possibly-errored [`VNode`] created by calling `render` on [`Scope`] or [`ScopeState`]. /// /// An Errored [`Element`] will propagate the error to the nearest error boundary. pub type Element<'a> = Result, anyhow::Error>; /// A [`Component`] is a function that takes a [`Scope`] and returns an [`Element`]. /// /// Components can be used in other components with two syntax options: /// - lowercase as a function call with named arguments (rust style) /// - uppercase as an element (react style) /// /// ## Rust-Style /// /// ```rust, ignore /// fn example(cx: Scope) -> Element { /// // ... /// } /// /// rsx!( /// example() /// ) /// ``` /// ## React-Style /// ```rust, ignore /// fn Example(cx: Scope) -> Element { /// // ... /// } /// /// rsx!( /// Example {} /// ) /// ``` pub type Component

= fn(Scope

) -> Element; /// A list of attributes pub type Attributes<'a> = Option<&'a [Attribute<'a>]>; } pub use crate::innerlude::{ // AnyAttributeValue, AnyEvent, fc_to_builder, Attribute, AttributeValue, Attributes, Component, DynamicNode, Element, ElementId, ElementRef, EventPriority, Fragment, LazyNodes, Mutation, Mutations, NodeFactory, Properties, Scope, ScopeId, ScopeState, Scoped, SuspenseBoundary, SuspenseContext, TaskId, Template, TemplateAttribute, TemplateNode, UiEvent, VComponent, VFragment, VNode, VText, VirtualDom, }; /// The purpose of this module is to alleviate imports of many common types /// /// This includes types like [`Scope`], [`Element`], and [`Component`]. pub mod prelude { pub use crate::innerlude::{ fc_to_builder, Element, EventHandler, EventPriority, Fragment, LazyNodes, NodeFactory, Properties, Scope, ScopeId, ScopeState, Scoped, TaskId, Template, TemplateAttribute, TemplateNode, UiEvent, VNode, VirtualDom, }; } pub mod exports { //! Important dependencies that are used by the rest of the library //! Feel free to just add the dependencies in your own Crates.toml pub use bumpalo; pub use futures_channel; } #[macro_export] /// A helper macro for using hooks in async environements. /// /// # Usage /// /// /// ```ignore /// let (data) = use_ref(&cx, || {}); /// /// let handle_thing = move |_| { /// to_owned![data] /// cx.spawn(async move { /// // do stuff /// }); /// } /// ``` macro_rules! to_owned { ($($es:ident),+) => {$( #[allow(unused_mut)] let mut $es = $es.to_owned(); )*} }