Evan AlmloffandJonathan Kelley
af6fc3a542
* Switch to owned listener type * remove html event workaround * fix event conversion * keep track of the origin scope * fix clippy * fix docs * Use "ListenerCallback" instead of "ListenerCb" * Add a small example --------- Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
109 lines
4.1 KiB
Rust
109 lines
4.1 KiB
Rust
#![doc = include_str!("../README.md")]
|
|
#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")]
|
|
#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")]
|
|
#![warn(missing_docs)]
|
|
|
|
mod any_props;
|
|
mod arena;
|
|
mod diff;
|
|
mod effect;
|
|
mod error_boundary;
|
|
mod events;
|
|
mod fragment;
|
|
mod generational_box;
|
|
mod global_context;
|
|
mod launch;
|
|
mod mutations;
|
|
mod nodes;
|
|
mod properties;
|
|
mod reactive_context;
|
|
mod render_error;
|
|
mod root_wrapper;
|
|
mod runtime;
|
|
mod scheduler;
|
|
mod scope_arena;
|
|
mod scope_context;
|
|
mod scopes;
|
|
mod suspense;
|
|
mod tasks;
|
|
mod virtual_dom;
|
|
|
|
mod hotreload_utils;
|
|
|
|
/// Items exported from this module are used in macros and should not be used directly.
|
|
#[doc(hidden)]
|
|
pub mod internal {
|
|
#[doc(hidden)]
|
|
pub use crate::hotreload_utils::{
|
|
DynamicLiteralPool, DynamicValuePool, FmtSegment, FmtedSegments, HotReloadAttributeValue,
|
|
HotReloadDynamicAttribute, HotReloadDynamicNode, HotReloadLiteral,
|
|
HotReloadTemplateWithLocation, HotReloadedTemplate, HotreloadedLiteral, NamedAttribute,
|
|
TemplateGlobalKey,
|
|
};
|
|
|
|
#[doc(hidden)]
|
|
pub use generational_box;
|
|
}
|
|
|
|
pub(crate) mod innerlude {
|
|
pub(crate) use crate::any_props::*;
|
|
pub use crate::arena::*;
|
|
pub(crate) use crate::effect::*;
|
|
pub use crate::error_boundary::*;
|
|
pub use crate::events::*;
|
|
pub use crate::fragment::*;
|
|
pub use crate::generational_box::*;
|
|
pub use crate::global_context::*;
|
|
pub use crate::launch::*;
|
|
pub use crate::mutations::*;
|
|
pub use crate::nodes::*;
|
|
pub use crate::properties::*;
|
|
pub use crate::reactive_context::*;
|
|
pub use crate::render_error::*;
|
|
pub use crate::runtime::{Runtime, RuntimeGuard};
|
|
pub use crate::scheduler::*;
|
|
pub use crate::scopes::*;
|
|
pub use crate::suspense::*;
|
|
pub use crate::tasks::*;
|
|
pub use crate::virtual_dom::*;
|
|
|
|
/// An [`Element`] is a possibly-none [`VNode`] created by calling `render` on [`ScopeId`] or [`ScopeState`].
|
|
///
|
|
/// An Errored [`Element`] will propagate the error to the nearest error boundary.
|
|
pub type Element = std::result::Result<VNode, RenderError>;
|
|
|
|
/// A [`Component`] is a function that takes [`Properties`] and returns an [`Element`].
|
|
pub type Component<P = ()> = fn(P) -> Element;
|
|
}
|
|
|
|
pub use crate::innerlude::{
|
|
fc_to_builder, generation, schedule_update, schedule_update_any, use_hook, vdom_is_rendering,
|
|
AnyValue, Attribute, AttributeValue, CapturedError, Component, ComponentFunction, DynamicNode,
|
|
Element, ElementId, Event, Fragment, HasAttributes, IntoDynNode, LaunchConfig,
|
|
ListenerCallback, MarkerWrapper, Mutation, Mutations, NoOpMutations, Ok, Properties, Result,
|
|
Runtime, ScopeId, ScopeState, SpawnIfAsync, Task, Template, TemplateAttribute, TemplateNode,
|
|
VComponent, VNode, VNodeInner, VPlaceholder, VText, VirtualDom, WriteMutations,
|
|
};
|
|
|
|
/// The purpose of this module is to alleviate imports of many common types
|
|
///
|
|
/// This includes types like [`Element`], and [`Component`].
|
|
pub mod prelude {
|
|
pub use crate::innerlude::{
|
|
consume_context, consume_context_from_scope, current_owner, current_scope_id,
|
|
fc_to_builder, force_all_dirty, generation, has_context, needs_update, needs_update_any,
|
|
parent_scope, provide_context, provide_error_boundary, provide_root_context, queue_effect,
|
|
remove_future, spawn, spawn_forever, spawn_isomorphic, suspend, suspense_context,
|
|
throw_error, try_consume_context, use_after_render, use_before_render, use_drop, use_hook,
|
|
use_hook_with_cleanup, with_owner, AnyValue, Attribute, Callback, Component,
|
|
ComponentFunction, Context, Element, ErrorBoundary, ErrorContext, Event, EventHandler,
|
|
Fragment, HasAttributes, IntoAttributeValue, IntoDynNode, OptionStringFromMarker,
|
|
Properties, ReactiveContext, RenderError, Runtime, RuntimeGuard, ScopeId, ScopeState,
|
|
SuperFrom, SuperInto, SuspendedFuture, SuspenseBoundary, SuspenseBoundaryProps,
|
|
SuspenseContext, SuspenseExtension, Task, Template, TemplateAttribute, TemplateNode, VNode,
|
|
VNodeInner, VirtualDom,
|
|
};
|
|
}
|
|
|
|
pub use const_format;
|