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
//! //! [](https://crates.io/crates/sauron) //! [](https://travis-ci.org/ivanceras/sauron) //! [](./LICENSE) //! //!  //! //! [Guide](https://sauron-rs.github.io/) //! //! **Sauron** is an web framework for creating fast and interactive client side web application, //! as well as server-side rendering for back-end web applications. //! //! //! ### Example //! ```rust,no_run //! use log::trace; //! use sauron::html::attributes::attr; //! use sauron::html::text; //! use sauron::prelude::*; //! use sauron::{Cmd, Component, Node, Program}; //! //! #[derive(Debug)] //! 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> { //! node! { //! <main> //! <h1>"Minimal example"</h1> //! <div class="some-class" id="some-id" {attr("data-id", 1)}> //! <input class="client" //! type="button" //! value="Click me!" //! key=1 //! on_click={|_| { //! trace!("Button is clicked"); //! Msg::Click //! }} //! /> //! <div>{text(format!("Clicked: {}", self.click_count))}</div> //! <input type="text" value={self.click_count}/> //! </div> //! </main> //! } //! } //! //! fn update(&mut self, msg: Msg) -> Cmd<Self, Msg> { //! trace!("App is updating with msg: {:?}", msg); //! match msg { //! Msg::Click => self.click_count += 1, //! } //! Cmd::none() //! } //! } //! //! #[wasm_bindgen(start)] //! pub fn main() { //! console_log::init_with_level(log::Level::Trace).unwrap(); //! console_error_panic_hook::set_once(); //! 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 type=module> //! import init from './pkg/minimal.js'; //! init().catch(console.error); //! </script> //! </body> //! </html> //! ``` //! In Cargo.toml, specify the crate-type to be `cdylib` //! ```toml //! //! [package] //! name = "minimal" //! version = "0.1.0" //! edition = "2018" //! //! [lib] //! crate-type = ["cdylib"] //! //! //! [dependencies] //! sauron = "0.34" //! console_error_panic_hook = "0.1" //! log = "0.4" //! console_log = "0.2" //! ``` //! //! //! Build using //! ```sh //! $> wasm-pack build --target web --release //! ``` //! Look at the [examples](https://github.com/ivanceras/sauron/tree/master/examples) //! and the build script for the details. //! //! //! ### Demo examples //! - [todomvc](https://ivanceras.github.io/todomvc/) The todomvc example //! - [futuristic-ui](https://ivanceras.github.io/futuristic-ui/) - A demo of futuristic-ui //! showcasing animation, transition and timed Component update. //! - [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 //! - [code-editor](https://ivanceras.github.io/code-editor/) - A WIP web-base code-editor //! //! ### Converting HTML into Sauron's 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 //! ``` //! //! ### Performance: //! Sauron is one of the fastest. //! //!  //!  //! //! ### Run the benchmark yourself: //! [Benchmark 1](https://ivanceras.github.io/todo-mvc-bench/) //! [Benchmark 2](https://ivanceras.github.io/todomvc-benchmark/) //! //! ### Please support this project: //! [](https://www.patreon.com/ivanceras) //! //! //! //! #![doc( html_logo_url = "https://raw.githubusercontent.com/ivanceras/sauron/master/assets/sauron.png" )] #![deny(clippy::all)] #![deny( warnings, missing_docs, missing_copy_implementations, trivial_casts, trivial_numeric_casts, unstable_features, unused_import_braces )] use cfg_if::cfg_if; cfg_if! {if #[cfg(feature = "with-dom")] { pub use sauron_core::dom; pub use sauron_core::dom::*; pub use sauron_core::web_sys; pub use sauron_core::wasm_bindgen; pub use sauron_core::{Component, Cmd, Program}; pub use sauron_core::js_sys; }} /// reexport prelude from sauron core pub mod prelude { pub use sauron_core::prelude::*; #[cfg(feature = "with-node-macro")] pub use sauron_node_macro::node; } pub use sauron_core::{ diff, html, jss, mt_dom, svg, Attribute, Callback, Element, Node, Patch, Render, Text, }; // reexports pub use sauron_core::serde_json; #[cfg(any(feature = "with-markdown", feature = "with-lite-markdown"))] pub use sauron_markdown::markdown; #[cfg(feature = "with-node-macro")] pub use sauron_node_macro::node;