beet_dom 0.0.8

Utilities for dom rendering and interaction
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use crate::prelude::*;
use beet_core::prelude::*;

/// A unique identifier for this node in a templating tree,
/// used for dom binding and reconcilling client island locations.
/// The index must be assigned in a depth-first manner so that
/// client islands can resolve their child indices.
///
/// A DomIdx is assigned to each [`ElementNode`] in the tree requiring
/// a binding, and each [`TemplateNode`] with a client island directive.
#[derive(
	Debug,
	Default,
	Clone,
	Copy,
	PartialEq,
	Eq,
	PartialOrd,
	Ord,
	Hash,
	Deref,
	Reflect,
	Component,
)]
#[reflect(Default, Component)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "tokens", derive(ToTokens))]
pub struct DomIdx(
	/// Depth-first assigned index of this node in the templating tree.
	pub u32,
);

impl std::fmt::Display for DomIdx {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		write!(f, "DomIdx({})", self.0)
	}
}

impl DomIdx {
	pub fn new(idx: u32) -> Self { Self(idx) }
	pub fn inner(&self) -> u32 { self.0 }
}

/// Marker type indicating this entity will need a [`DomIdx`]
/// assigned to it after the tree has been built.
/// This is often a [`RequiredComponent`] ie [`EventTarget`] or [`ClientOnlyDirective`],
/// or added to a parent OnSpawn (ie for signal attributes)
#[derive(Default, Clone, PartialEq, Eq, Hash, Component, Reflect)]
#[reflect(Default, Component)]
#[cfg_attr(feature = "tokens", derive(ToTokens))]
#[require(RequiresDomBinding)]
pub struct RequiresDomIdx;