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
75
76
77
78
79

#![deny(missing_docs)]

//! # About custom-element
//!
//! `custom-element` provides a `CustomElement` trait that, when implemented,
//! allows your Rust struct to be rendered as a web component on any html page.
//!
//! Web components are a great way to [eliminate frontend framework lock-in](https://jakelazaroff.com/words/web-components-eliminate-javascript-framework-lock-in/).
//! They are also a great way to bridge the divide between UI components written in JavaScript
//! and UI elements written in Rust.
//!
//! # Learn By Example
//! If you want to see some examples of writing web components in Rust, check out
//! [examples](https://github.com/austintheriot/custom-element/tree/main/examples) directory:
//! - [`hello_world`](https://github.com/austintheriot/custom-element/tree/main/examples/hello_world) is the most basic web component you can create
//! - [`counter`](https://github.com/austintheriot/custom-element/tree/main/examples/counter) is the standard
//! counter example, showing how to re-render in response to events in pure Rust.
//! - [`leptos_in_react`](https://github.com/austintheriot/custom-element/tree/main/examples/leptos_in_react)
//! shows how you can mix Rust and JavaScript in the same codebase, and even mix Rust/JavaScript
//! frameworks.
//!
//! # A Simple Hello World
//!
//! ```rust
//! # use custom_element::CustomElement;
//! # use js_sys::Array;
//! # use wasm_bindgen::JsValue;
//! # use web_sys::HtmlElement;
//! #
//! # // can't run web code in the docs
//! # if false {
//! #
//! struct HelloWorld;
//!
//! // all custom element lifecycle hooks have a default no-op implementation
//! impl CustomElement for HelloWorld {}
//!
//! impl HelloWorld {
//!     // called from the JavaScript custom element's `constructor`
//!     fn new(instance: JsValue, _args: Array) -> Self {
//!         let instance: HtmlElement = instance.into();
//!         instance.set_text_content(Some("Hello, world!"));
//!         HelloWorld
//!     }
//! }
//!
//! fn main() {
//!     // create custom element constructor
//!     let component_name = "hello-world";
//!     let (closure, constructor) = custom_element::create_custom_element(HelloWorld::new, vec![]);
//!
//!     // we want the Rust code for our custom element to live forever
//!     closure.forget();
//!
//!     // define the element
//!     let window = web_sys::window().unwrap();
//!     window
//!         .custom_elements()
//!         .define(component_name, &constructor)
//!         .unwrap();
//!
//!     // render in the DOM
//!     let body = window.document().unwrap().body().unwrap();
//!     body.set_inner_html(&format!("<{0}></{0}>", component_name));
//! }
//! # }
//! ```

mod bridge;
mod create_custom_element;
mod custom_element;
mod generated_constructor;
mod html_constructors;

pub use bridge::*;
pub use create_custom_element::*;
pub use custom_element::*;
pub use generated_constructor::*;
pub use html_constructors::*;