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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
// TODO: remove warnings on js Promise must be used #![deny(warnings)] #![deny(clippy::all)] #![doc( html_logo_url = "https://raw.githubusercontent.com/ivanceras/sauron/master/assets/sauron.png" )] //! //! [](https://crates.io/crates/sauron) //! [](https://travis-ci.org/ivanceras/sauron) //! [](./LICENSE) //! //!  //! //! //! > One crate to rule the DOM //! > //! > One crate to mind it //! > //! > One crate to bring JSON //! > //! > And in the Rust code bind it //! > //! > //! > //! > This code, no other, is made by code elves //! > //! > Who'd pawn parent process to get it themselves //! > //! > Ruler of net troll and mortal and hacker //! > //! > This code is a lib crate for Patreon backers //! > //! > If trashed or buggy it cannot be remade //! > //! > If found send to Ivan, the bandwidth is prepaid //! //! -- The Harvard Lampoon & [po8](https://www.reddit.com/user/po8/) //! //! //! **Sauron** is an html web framework for building web-apps with the goal of //! closely adhering to [The Elm Architecture](https://guide.elm-lang.org/architecture/), a paragon for elegant design. //! //! As with elm, sauron follows the simplistic design of writing view code. //! //! ### Example //! ```rust,no_run //! use sauron::prelude::*; //! use wasm_bindgen::prelude::*; //! use log::*; //! //! #[derive(Debug, PartialEq, Clone)] //! pub enum Msg { //! Click, //! } //! //! pub struct App { //! click_count: u32, //! } //! //! impl App { //! pub fn new() -> Self { //! App { click_count: 0 } //! } //! } //! //! impl Component<Msg> for App { //! //! fn view(&self) -> Node<Msg> { //! div!( //! [class("some-class"), id("some-id"), attr("data-id", 1)], //! [ //! input!( //! [ //! class("client"), //! type_("button"), //! value("Click me!"), //! onclick(|_| { //! trace!("Button is clicked"); //! Msg::Click //! }), //! ], //! [], //! ), //! text!("Clicked: {}", self.click_count), //! ], //! ) //! } //! //! fn update(&mut self, msg: Msg) -> Cmd<Self, Msg> { //! trace!("App is updating from msg: {:?}", msg); //! match msg { //! Msg::Click => { //! self.click_count += 1; //! Cmd::none() //! } //! } //! } //! //! } //! //! #[wasm_bindgen(start)] //! pub fn main() { //! Program::mount_to_body(App::new()); //! } //! ``` //! index.html //! ```html //! <html> //! <head> //! <meta content="text/html;charset=utf-8" http-equiv="Content-Type"/> //! <title>Minimal sauron app</title> //! </head> //! <body> //! <script src='pkg/minimal.js'></script> //! <script type=module> //! window.wasm_bindgen('pkg/minimal_bg.wasm') //! .catch(console.error); //! </script> //! </body> //! </html> //! ``` //! In Cargo.toml, specify the crate-type to be `cdylib` //! ```toml //! [lib] //! crate-type = ["cdylib"] //! ``` //! //! **Note:** You need to use the nightly compiler with minimum version: rustc 1.37.0-nightly (17e62f77f 2019-07-01) //! //! Build using //! ```sh //! $> wasm-pack build --target no-modules //! ``` //! Look at the [examples](https://github.com/ivanceras/sauron/tree/master/examples) //! and the build script for the details. //! //! //! ### Demo examples //! - [data-viewer](https://ivanceras.github.io/data-viewer/) - A resizable spreadsheet csv data viewer //! - [svg_clock](https://ivanceras.github.io/svg_clock/) - A clock drawn using svg and window tick event. //! - [svg_graph](https://ivanceras.github.io/svg_graph/) - A simple graph using svg //! //! ### Convert html to sauron syntax //! [html2sauron](https://ivanceras.github.io/html2sauron/) - A tool to easily convert html into //! sauron node tree for your views. //! //! ### Prerequisite: //! //! ```sh //! cargo install wasm-pack //! cargo install basic-http-server //! ``` //! //! **Warning:** I repeat, You need to use the latest nightly compiler in order for this to work. //! //! ### Performance: //!  //! //! ### Please support this project: //! [](https://www.patreon.com/ivanceras) //! //! //! use cfg_if::cfg_if; cfg_if! {if #[cfg(feature = "with-dom")] { pub mod dom; pub use dom::*; use wasm_bindgen::{ JsCast, JsValue, }; /// This needs wrapping only so that we can implement /// PartialEq for testing purposes #[derive(Clone, Debug)] pub struct DomEvent(pub web_sys::Event); impl std::ops::Deref for crate::Event { type Target = web_sys::Event; fn deref(&self) -> &Self::Target { &self.0 } } impl PartialEq for crate::Event { fn eq(&self, other: &Self) -> bool { let js_value: Option<&JsValue> = self.0.dyn_ref(); let other_value: Option<&JsValue> = other.0.dyn_ref(); js_value == other_value } } }} #[cfg(feature = "with-dom")] pub type Event = DomEvent; #[cfg(not(feature = "with-dom"))] pub type Event = (); cfg_if! {if #[cfg(feature = "with-markdown")] { mod markdown; pub use markdown::*; }} #[cfg(feature = "with-parser")] pub mod parser; #[macro_use] pub mod html; #[macro_use] pub mod svg; pub use sauron_vdom; pub use sauron_vdom::{ diff, Callback, Text, Value, }; /// Prelude simplifies the imports from sauron /// This imports the necessary functions to build /// a basic sauron app. pub mod prelude { pub use crate::{ html::{ attributes::*, tags::{ commons::*, *, }, units::*, *, }, svg::{ attributes::*, tags::commons::*, *, }, *, }; #[cfg(feature = "with-dom")] pub use crate::html::events::*; } /// A simplified version of saurdon_vdom node, where we supplied the type for the tag /// which is a &'static str. The missing type is now only MSG which will be supplied by the users /// App code. pub type Node<MSG> = sauron_vdom::Node<&'static str, &'static str, Event, MSG>; pub type Element<MSG> = sauron_vdom::Element<&'static str, &'static str, Event, MSG>; pub type Patch<'a, MSG> = sauron_vdom::Patch<'a, &'static str, &'static str, Event, MSG>; pub type Attribute<MSG> = sauron_vdom::Attribute<&'static str, Event, MSG>;