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
//! Vertigo is a library for building reactive web components.
//!
//! It mainly consists of three parts:
//!
//! * **Virtual DOM** - Lightweight representation of JavaScript DOM that can be used to optimally update real DOM
//! * **Reactive dependencies** - A graph of values and clients that can automatically compute what to refresh after one value change
//! * **HTML/CSS macros** - Allows to construct Virtual DOM nodes using HTML and CSS
//!
//! ## Example
//!
//! ```rust,no_run
//! use std::cmp::PartialEq;
//! use vertigo::{Computed, Driver, VDomElement, Value, html, css_fn};
//!
//! #[derive(PartialEq)]
//! pub struct State {
//! driver: Driver,
//!
//! pub message: Value<String>,
//! }
//!
//! impl State {
//! pub fn new(driver: &Driver) -> Computed<State> {
//! let state = State {
//! driver: driver.clone(),
//! message: driver.new_value("Hello world".to_string()),
//! };
//!
//! driver.new_computed_from(state)
//! }
//! }
//!
//! css_fn! { main_div, "
//! color: darkblue;
//! " }
//!
//! pub fn render(app_state: &Computed<State>) -> VDomElement {
//! let state = app_state.get_value();
//!
//! html! {
//! <div css={main_div()}>
//! "Message to the world: "
//! {state.message.get_value()}
//! </div>
//! }
//! }
//! ```
//!
//! More description soon! For now, to get started you may consider looking
//! at the [Tutorial](https://github.com/vertigo-web/vertigo/blob/master/tutorial.md).
#![deny(rust_2018_idioms)]
#![feature(trait_alias)]
#![feature(try_trait_v2)] // https://github.com/rust-lang/rust/issues/84277
mod app;
mod computed;
mod css;
mod driver;
mod driver_refs;
mod fetch;
mod html_macro;
mod instant;
pub mod router;
pub mod utils;
mod virtualdom;
mod websocket;
pub use app::start_app;
pub use computed::{AutoMap, Computed, Dependencies, Value};
pub use driver::{Driver, DriverTrait, EventCallback, FetchResult, FetchMethod};
pub use driver_refs::RefsContext;
pub use fetch::{
request_builder::{SingleRequestTrait, ListRequestTrait},
resource::Resource,
lazy_cache,
lazy_cache::LazyCache,
};
pub use html_macro::Embed;
pub use instant::{Instant, InstantType};
pub use utils::DropResource;
pub use virtualdom::models::{
realdom_id::RealDomId,
vdom_component::VDomComponent,
vdom_element::{VDomElement, KeyDownEvent},
vdom_refs::{NodeRefs, NodeRefsItem},
vdom_text::VDomText,
vdom_node::VDomNode,
css::{Css, CssGroup},
node_attr,
};
pub use websocket::{WebsocketMessageDriver, WebsocketMessage, WebcocketConnection};
#[cfg(feature = "serde_request")]
pub use vertigo_macro::{SerdeRequest, SerdeSingleRequest, SerdeListRequest};
#[cfg(feature = "serde_request")]
pub use serde_json;
// Export log module which can be used in vertigo plugins
pub use log;
/// Allows to create VDomElement using HTML tags.
///
/// ```rust,no_run
/// use vertigo::html;
///
/// let value = "world";
///
/// html! {
/// <div>
/// <h3>"Hello " {value} "!"</h3>
/// <p>"Good morning!"</p>
/// </div>
/// };
/// ```
pub use vertigo_macro::html;
/// Allows to create Css styles for virtual DOM.
///
/// ```rust,no_run
/// use vertigo::{Css, css};
///
/// fn green_on_red() -> Css {
/// css! { "
/// color: green;
/// background-color: red;
/// " }
/// }
/// ```
pub use vertigo_macro::css;
/// Coostructs a CSS block that can be manually pushed into existing Css styles instance.
///
/// ```rust,no_run
/// use vertigo::{css_fn, css_block};
///
/// css_fn! { green, "
/// color: green;
/// " }
///
/// let mut green_style = green();
///
/// green_style.push_str(
/// css_block! { "
/// font-style: italic;
/// " }
/// );
/// ```
pub use vertigo_macro::css_block;