Savory

Rust / Wasm 前端库，用于构建用户界面。

· · · ·

Savory 是一个基于 Seed 的构建用户界面的库

文档

特性

• 设计系统：元素使用 DesignSystem 完全样式化。
• 可复用性：元素高度可复用/可组合。
• 解耦开发：设计系统可以在独立的crate中开发，甚至不需要接触元素代码，同样，元素的开发也是与设计系统分离的，这要归功于 DesignSystemImpl trait。
• 干净视图：以干净和声明的方式构建您的视图，不再需要任何宏。
• 基于特质：拥抱Rust特质系统，所有Savory元素都实现了 Element 和/或 View 特质。
• 类型化HTML：使用类型化的CSS和HTML属性，Savory努力不依赖字符串创建CSS和HTML属性，因为这些可能会产生难以调试的错误。
• UI元素集合：Savory附带了一组可复用和可主题化的UI元素。
• 增强Seed API：增强Seed API，使得使用 Node、Orders 更加有趣。

Savory试图让编写UI元素变得有趣且无需样板代码。

截图

入门

最快入门的方式是遵循 Savory 入门 仓库的说明。

示例

在这里，我们将创建在 Elm 教程 中找到的相同计数器应用，然后我们将以样式化和可复用的元素重写相同的应用。

简单计数器

use savory::prelude::*;

// app element (the model)
pub struct Counter(i32);

// app message
pub enum Msg {
    Increment,
    Decrement,
}

impl Element for Counter {
    type Message = Msg;
    type Config = Url;

    // initialize the app in this function
    fn init(_: Url, _: &mut impl Orders<Msg>) -> Self {
        Self(0)
    }

    // handle app messages
    fn update(&mut self, msg: Msg, _: &mut impl Orders<Msg>) {
        match msg {
            Msg::Increment => self.0 += 1,
            Msg::Decrement => self.0 -= 1,
        }
    }
}

impl View<Node<Msg>> for Counter {
    // view the app
    fn view(&self) -> Node<Msg> {
        let inc_btn = html::button().push("Increment").on_click(|_| Msg::Increment);
        let dec_btn = html::button().push("Decrement").on_click(|_| Msg::Decrement);

        html::div()
            .push(inc_btn)
            .push(self.0.to_string())
            .push(dec_btn)
    }
}

#[wasm_bindgen(start)]
pub fn view() {
    // mount and start the app at `app` element
    Counter::start();
}

预览：

源代码

Counter As Element

现在我们将创建一个计数器元素和一个应用程序元素，这展示了如何创建父元素和子元素，以及如何创建可重用和可样式的元素。

use savory::prelude::*;
use savory_elements::prelude::*;
use savory_style::{
    css::{unit::px, values as val, Color, St},
    prelude::*,
};

#[derive(Element)]
pub struct Counter {
    #[element(config(default = "10"))]
    value: i32,
}

pub enum Msg {
    Increment,
    Decrement,
}

impl Element for Counter {
    type Message = Msg;
    type Config = Config;

    fn init(config: Self::Config, _: &mut impl Orders<Msg>) -> Self {
        Self {
            value: config.value,
        }
    }

    fn update(&mut self, msg: Msg, _: &mut impl Orders<Msg>) {
        match msg {
            Msg::Increment => self.value += 1,
            Msg::Decrement => self.value -= 1,
        }
    }
}

impl View<Node<Msg>> for Counter {
    fn view(&self) -> Node<Msg> {
        // sharde style for buttons
        let style_btns = |conf: css::Style| {
            conf.push(St::Appearance, val::None)
                .background(Color::SlateBlue)
                .text(Color::White)
                .and_border(|conf| conf.none().radius(px(4)))
                .margin(px(4))
                .padding(px(4))
        };

        // increment button node
        let inc_btn = html::button()
            .class("inc-btn")
            .and_style(style_btns)
            .on_click(|_| Msg::Increment)
            .push("Increment");

        // decrement button node
        let dec_btn = html::button()
            .class("dec-btn")
            .and_style(style_btns)
            .on_click(|_| Msg::Decrement)
            .push("Decrement");

        // contianer node
        html::div()
            .push(dec_btn)
            .push(self.value.to_string())
            .push(inc_btn)
    }
}

// convenient way to convert Config into Counter
impl Config {
    pub fn init(self, orders: &mut impl Orders<Msg>) -> Counter {
        Counter::init(self, orders)
    }
}

// App Element ---

pub enum AppMsg {
    Counter(Msg),
}

pub struct MyApp {
    counter_element: Counter,
}

impl Element for MyApp {
    type Message = AppMsg;
    type Config = Url;

    fn init(_: Url, orders: &mut impl Orders<AppMsg>) -> Self {
        Self {
            counter_element: Counter::config()
                // give it starting value. 10 will be used as default value if
                // we didn't pass value
                .value(100)
                .init(&mut orders.proxy(AppMsg::Counter)),
        }
    }

    fn update(&mut self, msg: AppMsg, orders: &mut impl Orders<AppMsg>) {
        match msg {
            AppMsg::Counter(msg) => self
                .counter_element
                .update(msg, &mut orders.proxy(AppMsg::Counter)),
        }
    }
}

impl View<Node<AppMsg>> for MyApp {
    fn view(&self) -> Node<AppMsg> {
        self.counter_element.view().map_msg(AppMsg::Counter)
    }
}

#[wasm_bindgen(start)]
pub fn view() {
    // mount and start the app at `app` element
    MyApp::start();
}

预览：

源代码

在这个例子中有许多事情发生，首先我们创建了元素结构 Counter，并定义了它的属性、事件和样式类型，这一切都是通过 derive 宏 Element 实现的，我们将在稍后解释它的工作原理，然后我们定义了一个包含计数器元素的应用程序元素，并在 init 函数中初始化它。最后，我们只是调用 start 方法来挂载和启动应用程序。

计数器使用 Savory Elements！

Savory 附带一系列元素，我们将使用它们来构建计数器应用程序并查看 Savory 元素提供的功能。

TODO：添加示例

生态系统

• savory - 构建用户界面的核心库
• savory-router - Savory 路由器，用于为您的应用程序生成路由器
• savory-style - Savory 的类型化 CSS 样式
• savory-elements - 基于 Savory 的 UI 元素集合
• savory-elements-derive - 提供 Element derive 的包

许可

根据您的选择，受Apache License, Version 2.0 或 MIT 许可证的许可。

除非您明确声明，否则您提交给 Savory 的任何贡献，根据 Apache-2.0 许可证定义，应按上述方式双重许可，而不附加任何额外的条款或条件。