Evan Almloff
0127501dbf
Improve inline docs * improve incorrect event handler return error message * Improve event handler docs * document the eval functions * document spawn and common spawn errors * fix event handler docs * add notes about how you use attributes and elements in rsx * add doc aliases for attributes and events we rename * add some more aliases for common search terms * don't doc ignore any public examples in core * don't ignore public doc examples in ssr * don't ignore examples in the dioxus package readme * add a warning when you launch without a renderer enabled * fix some outdated element docs * add a bunch of examples to resource * add notes about desktop events * add more docs for use_resource * add on_unimplemented hint to Dependency * fix some unresolved links * add examples to each of the router traits * add not implemented errors for router traits * add an example to the routable trait * expand rsx macro docs * improve memo docs * update the dioxus readme * mention dioxus crate features in the docs * fix a bunch of doc tests * fix html doc tests * fix router doc tests * fix dioxus signals doc tests * fix dioxus ssr doc tests * fix use_future example in the hooks cheat sheet * add a javascript alias for eval * fix hook explanation values * remove unused embed-doc-image dependency
88 lines
3.0 KiB
Rust
88 lines
3.0 KiB
Rust
use crate::{
|
|
any_props::BoxedAnyProps, nodes::RenderReturn, runtime::Runtime, scope_context::Scope,
|
|
};
|
|
use std::{cell::Ref, rc::Rc};
|
|
|
|
/// A component's unique identifier.
|
|
///
|
|
/// `ScopeId` is a `usize` that acts a key for the internal slab of Scopes. This means that the key is not unqiue across
|
|
/// time. We do try and guarantee that between calls to `wait_for_work`, no ScopeIds will be recycled in order to give
|
|
/// time for any logic that relies on these IDs to properly update.
|
|
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
|
|
#[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
|
pub struct ScopeId(pub usize);
|
|
|
|
impl std::fmt::Debug for ScopeId {
|
|
#[allow(unused_mut)]
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
let mut builder = f.debug_tuple("ScopeId");
|
|
let mut builder = builder.field(&self.0);
|
|
#[cfg(debug_assertions)]
|
|
{
|
|
if let Some(name) = Runtime::current()
|
|
.as_ref()
|
|
.and_then(|rt| rt.get_state(*self))
|
|
{
|
|
builder = builder.field(&name.name);
|
|
}
|
|
}
|
|
builder.finish()
|
|
}
|
|
}
|
|
|
|
impl ScopeId {
|
|
/// The root ScopeId.
|
|
///
|
|
/// This scope will last for the entire duration of your app, making it convenient for long-lived state
|
|
/// that is created dynamically somewhere down the component tree.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust, no_run
|
|
/// use dioxus::prelude::*;
|
|
/// let my_persistent_state = Signal::new_in_scope(String::new(), ScopeId::ROOT);
|
|
/// ```
|
|
pub const ROOT: ScopeId = ScopeId(0);
|
|
}
|
|
|
|
/// A component's rendered state.
|
|
///
|
|
/// This state erases the type of the component's props. It is used to store the state of a component in the runtime.
|
|
pub struct ScopeState {
|
|
pub(crate) runtime: Rc<Runtime>,
|
|
pub(crate) context_id: ScopeId,
|
|
pub(crate) last_rendered_node: Option<RenderReturn>,
|
|
pub(crate) props: BoxedAnyProps,
|
|
}
|
|
|
|
impl Drop for ScopeState {
|
|
fn drop(&mut self) {
|
|
self.runtime.remove_scope(self.context_id);
|
|
}
|
|
}
|
|
|
|
impl ScopeState {
|
|
/// Get a handle to the currently active head node arena for this Scope
|
|
///
|
|
/// This is useful for traversing the tree outside of the VirtualDom, such as in a custom renderer or in SSR.
|
|
///
|
|
/// Panics if the tree has not been built yet.
|
|
pub fn root_node(&self) -> &RenderReturn {
|
|
self.try_root_node()
|
|
.expect("The tree has not been built yet. Make sure to call rebuild on the tree before accessing its nodes.")
|
|
}
|
|
|
|
/// Try to get a handle to the currently active head node arena for this Scope
|
|
///
|
|
/// This is useful for traversing the tree outside of the VirtualDom, such as in a custom renderer or in SSR.
|
|
///
|
|
/// Returns [`None`] if the tree has not been built yet.
|
|
pub fn try_root_node(&self) -> Option<&RenderReturn> {
|
|
self.last_rendered_node.as_ref()
|
|
}
|
|
|
|
pub(crate) fn state(&self) -> Ref<'_, Scope> {
|
|
self.runtime.get_state(self.context_id).unwrap()
|
|
}
|
|
}
|