velox-core 0.1.1

Core reactive primitives for the Velox UI framework
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

pub mod ergonomics;
pub mod lifecycle;
pub mod next_tick;
pub mod provide_inject;
pub mod ref_cell;
pub mod signal;
pub mod vmodel;
pub mod watch;

// Re-export ergonomics for convenient access
pub use ergonomics::*;

// Re-export lifecycle hooks for convenient access.
// Each `on_*` function pairs with a same-named `#[macro_export]` macro at the
// crate root (e.g. `velox_core::on_mounted!`), so SFC `<script setup>` blocks
// can call either the function or macro form.
pub use lifecycle::{
    LifecycleHandle, before_destroy, cleanup_component, clear_current_component,
    clear_updated_hooks, current_component_id, generate_component_id, has_updated_hooks,
    on_mounted, on_unmounted, on_updated, run_all_destroy_hooks, run_all_mounted_hooks,
    run_all_updated_hooks, run_destroy_hooks, run_mounted_hooks, run_unmounted_hooks,
    run_updated_hooks, set_current_component,
};

/// Create a Signal with an initial value.
/// Usage: `let count = signal!(count = 0);`
#[macro_export]
macro_rules! signal {
    ($name:ident = $value:expr) => {
        std::rc::Rc::new($crate::signal::Signal::new($value))
    };
}

/// Create a Vue-like reactive reference.
/// Usage: `let count = ref!(0);`
/// Expands to: `velox_core::ref_value(0)`
#[macro_export]
macro_rules! r#ref {
    ($value:expr) => {
        $crate::ergonomics::ref_value($value)
    };
}

/// Create a shallow reactive reference for Copy types.
/// Usage: `let count = shallow!(0);`
#[macro_export]
macro_rules! shallow {
    ($value:expr) => {
        $crate::ergonomics::shallow_ref($value)
    };
}