lewp 0.3.0

Say goodbye to the web template hell. Generate your HTML5 website technically optimized and always valid. In your Rust source.
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

use {
    super::{ModulePtr, RuntimeInformation},
    crate::{config::ModuleConfig, LewpError},
    lewp_html::{api::div, NodeExt, Nodes},
    std::{cell::RefCell, rc::Rc},
};

/// Defines a web page module.
pub trait Module {
    /// Returns the unique module id.
    ///
    /// Allowed characters for id are `[a-z]`, `[0-9]` and `-`.
    /// **There is currently no check wether other characters are used. So please
    /// make sure that you do not use any other characters while creating modules.**
    fn id(&self) -> &str;

    /// The configuration of the module.
    fn config(&self) -> &ModuleConfig;

    /// Borrows the head tags that are required to run this module in a web page.
    fn head_tags(&self) -> &Nodes;

    /// Wraps `self` into a `Rc<RefCell<>>`
    fn into_module_ptr(self) -> ModulePtr
    where
        Self: Sized + 'static,
    {
        Rc::new(RefCell::new(self))
    }

    /// Constructs the view of the module.
    fn view(&self) -> Nodes;

    /// Renders as DOM nodes.
    fn render(&self) -> Nodes {
        if self.config().skip_wrapper {
            return self.view();
        }
        vec![div(self.view()).attrs(vec![
            ("class", self.id()),
            ("data-lewp-component", "module"),
        ])]
    }

    /// Executes the module. Main function that is able to collect and modify
    /// data required for rendering.
    fn run(
        &mut self,
        runtime_info: Rc<RuntimeInformation>,
    ) -> Result<(), LewpError>;
}