137 lines
3.2 KiB
Rust
137 lines
3.2 KiB
Rust
mod any_props;
|
|
mod arena;
|
|
mod bump_frame;
|
|
mod component;
|
|
mod create;
|
|
mod diff;
|
|
mod events;
|
|
mod factory;
|
|
mod future_container;
|
|
mod garbage;
|
|
mod lazynodes;
|
|
mod mutations;
|
|
mod nodes;
|
|
mod properties;
|
|
mod scope_arena;
|
|
mod scopes;
|
|
// mod subtree;
|
|
mod suspense;
|
|
mod virtualdom;
|
|
|
|
pub(crate) mod innerlude {
|
|
pub use crate::arena::*;
|
|
pub use crate::events::*;
|
|
pub use crate::future_container::*;
|
|
pub use crate::lazynodes::*;
|
|
pub use crate::mutations::*;
|
|
pub use crate::nodes::*;
|
|
pub use crate::properties::*;
|
|
pub use crate::scopes::*;
|
|
pub use crate::virtualdom::*;
|
|
|
|
/// An [`Element`] is a possibly-none [`VNode`] created by calling `render` on [`Scope`] or [`ScopeState`].
|
|
///
|
|
/// Any [`None`] [`Element`] will automatically be coerced into a placeholder [`VNode`] with the [`VNode::Placeholder`] variant.
|
|
pub type Element<'a> = Option<VNode<'a>>;
|
|
|
|
/// 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<Props>) -> Element {
|
|
/// // ...
|
|
/// }
|
|
///
|
|
/// rsx!(
|
|
/// example()
|
|
/// )
|
|
/// ```
|
|
/// ## React-Style
|
|
/// ```rust, ignore
|
|
/// fn Example(cx: Scope<Props>) -> Element {
|
|
/// // ...
|
|
/// }
|
|
///
|
|
/// rsx!(
|
|
/// Example {}
|
|
/// )
|
|
/// ```
|
|
pub type Component<P = ()> = fn(Scope<P>) -> 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,
|
|
ElementPath,
|
|
EventPriority,
|
|
LazyNodes,
|
|
NodeFactory,
|
|
Properties,
|
|
Scope,
|
|
ScopeId,
|
|
ScopeState,
|
|
TaskId,
|
|
Template,
|
|
TemplateAttribute,
|
|
TemplateNode,
|
|
UiEvent,
|
|
VNode,
|
|
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, Attribute, DynamicNode, Element, EventPriority, LazyNodes, NodeFactory,
|
|
Properties, Scope, ScopeId, ScopeState, 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();
|
|
)*}
|
|
}
|