dioxus-mirror/packages/core/src/lib.rs

#![allow(non_snake_case)]
#![doc = include_str!("../README.md")]

/*
Navigating this crate:
- virtual_dom: the primary entrypoint for the crate
- scheduler: the core interior logic called by the [`VirtualDom`]
- nodes: the definition of VNodes, listeners, etc.
- diff: the stackmachine-based diffing algorithm
- hooks: foundational hooks that require crate-private APIs
- mutations: DomEdits/NodeRefs and internal API to create them

Some utilities
*/
pub(crate) mod bumpframe;
pub(crate) mod childiter;
pub(crate) mod component;
pub(crate) mod coroutines;
pub(crate) mod diff;
pub(crate) mod diff_stack;
pub(crate) mod events;
pub(crate) mod heuristics;
pub(crate) mod hooklist;
pub(crate) mod hooks;
pub(crate) mod lazynodes;
pub(crate) mod mutations;
pub(crate) mod nodes;
pub(crate) mod resources;
pub(crate) mod scheduler;
pub(crate) mod scope;
pub(crate) mod tasks;
pub(crate) mod test_dom;
pub(crate) mod threadsafe;
pub(crate) mod util;
pub(crate) mod virtual_dom;

#[cfg(feature = "debug_vdom")]
pub mod debug_dom;

pub(crate) mod innerlude {
    pub(crate) use crate::bumpframe::*;
    pub(crate) use crate::childiter::*;
    pub use crate::component::*;
    pub(crate) use crate::diff::*;
    pub use crate::diff_stack::*;
    pub use crate::events::*;
    pub use crate::heuristics::*;
    pub(crate) use crate::hooklist::*;
    pub use crate::hooks::*;
    pub use crate::lazynodes::*;
    pub use crate::mutations::*;
    pub use crate::nodes::*;
    pub(crate) use crate::resources::*;
    pub use crate::scheduler::*;
    pub use crate::scope::*;
    pub use crate::tasks::*;
    pub use crate::test_dom::*;
    pub use crate::threadsafe::*;
    pub use crate::util::*;
    pub use crate::virtual_dom::*;

    pub type Element<'a> = Option<VNode<'a>>;
    pub type FC<P> = for<'a> fn(Scope<'a, P>) -> Element<'a>;
}

pub use crate::innerlude::{
    Context, DioxusElement, DomEdit, Element, ElementId, EventPriority, LazyNodes, MountType,
    Mutations, NodeFactory, Properties, SchedulerMsg, ScopeChildren, ScopeId, TaskHandle, TestDom,
    ThreadsafeVirtualDom, UserEvent, VNode, VirtualDom, FC,
};

pub mod prelude {
    pub use crate::component::{fc_to_builder, Fragment, Properties, Scope};
    pub use crate::hooks::*;
    pub use crate::innerlude::Context;
    pub use crate::innerlude::{DioxusElement, Element, LazyNodes, NodeFactory, ScopeChildren, FC};
    pub use crate::nodes::VNode;
    pub use crate::VirtualDom;
}

pub mod exports {
    //! Important dependencies that are used by the rest of the library
    // the foundation of this library
    pub use bumpalo;
    pub use futures_channel;
}