consecuit 0.2.0

A functional web UI framework that uses the type system for hooks and more
Documentation 
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
53
54
55
56
57
58
59
60

use web_sys::{window, Node};

use super::{
    component::ComponentBuilder,
    subtree::{mount_subtree, SubtreeInstance},
    types::ComponentReturn,
};

/// Mount the given component on the <body> element. This passes <body> to [`mount_app_at`].
///
/// The component must be a Consecuit component that takes `()` (empty tuple) as props.
///
/// See [`crate`] for what a Consecuit component looks like.
pub fn mount_app<Ret>(function: fn(ComponentBuilder, ()) -> Ret)
where
    Ret: ComponentReturn,
{
    let body = window().unwrap().document().unwrap().body().unwrap().into();
    mount_app_at(function, body)
}

/// Mount the given component on the given [`Node`]. This uses [`mount_app_without_leaking_at`] and leaks the result.
///
/// The component must be a Consecuit component that takes `()` (empty tuple) as props.
///
/// See [`crate`] for what a Consecuit component looks like.
pub fn mount_app_at<Ret>(function: fn(ComponentBuilder, ()) -> Ret, node: Node)
where
    Ret: ComponentReturn,
{
    Box::leak(Box::new(unsafe {
        mount_app_without_leaking_at(function, node)
    }));
}

/// Mount the given component on the given [`Node`], returning a [`SubtreeInstance`][crate::construction::subtree::SubtreeInstance] which will unmount the app when dropped.
///
/// Normally you should use [`mount_app`] or [`mount_app_at`]. Only use this if you have a way to store the returned value.
///
/// The component must be a Consecuit component that takes `()` (empty tuple) as props.
///
/// See [`crate`] for what a Consecuit component looks like.
///
/// This is unsafe because dropping the returned [`SubtreeInstance`][crate::construction::subtree::SubtreeInstance] while Consecuit is rendering could cause unsafe behavior.
///
/// If you're going to use it, make sure you keep the [`SubtreeInstance`][crate::construction::subtree::SubtreeInstance] forever.
///
/// If you're really going to drop it, and make sure to NOT do so from inside Consecuit hooks/components/use_effect/....
/// Dropping from inside an event callback or [`run_later`][crate::executor::run_later] is probably fine.
pub unsafe fn mount_app_without_leaking_at<Ret>(
    function: fn(ComponentBuilder, ()) -> Ret,
    node: Node,
) -> SubtreeInstance<Ret, ()>
where
    Ret: ComponentReturn,
{
    let root_tree = mount_subtree(function, (), node);

    root_tree
}