wasm-react 0.6.0

WASM bindings for React.
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74

#![warn(missing_docs)]
#![doc = include_str!("../README.md")]

// This hack is needed to let the doctests run for our README file
#[cfg(doctest)]
#[doc = include_str!("../README.md")]
extern "C" {}

mod builtin_components;
mod callback;
mod component;
mod context;
mod macros;
mod prop_container;
mod vnode;

pub mod hooks;
pub mod props;
#[doc(hidden)]
pub mod react_bindings;

use props::Props;
use wasm_bindgen::prelude::*;

pub use builtin_components::*;
pub use callback::*;
pub use component::*;
pub use context::*;
#[doc(hidden)]
pub use paste::paste;
pub use prop_container::*;
pub use vnode::*;

/// Contains all functions exported to JS by `wasm-react`. These functions should
/// be called from JS only.
#[doc(hidden)]
#[wasm_bindgen]
pub struct WasmReact;

#[wasm_bindgen]
impl WasmReact {
  /// Set the React runtime that `wasm-react` should use.
  ///
  /// Calling this function multiple times will result in no-ops.
  ///
  /// # Example
  ///
  /// ```js
  /// import React from "react";
  /// import init, { WasmReact } from "./path/to/pkg/project.js";
  ///
  /// async function main() {
  ///   await init();
  ///   WasmReact.useReact(React);
  /// }
  ///
  /// main();
  /// ```
  #[wasm_bindgen(js_name = useReact)]
  pub fn use_react(value: &JsValue) {
    react_bindings::use_react(value);
  }
}

/// The Rust equivalent to `React.createElement`. Use [`h!`] for a more
/// convenient way to create HTML element nodes. To create Rust components, use
/// [`Component::build()`].
pub fn create_element(typ: &JsValue, props: &Props, children: VNode) -> VNode {
  VNode::Single(react_bindings::create_element(
    typ,
    props.as_ref(),
    &children.into(),
  ))
}