#用户界面 #声明式UI #UI框架 #leptos #视图 #DOM #

tachys

为用户界面库构建无反应性、通用渲染器、静态类型视图树的工具

6个版本

0.1.0-preview 2024年4月28日
0.1.0-beta32024年8月17日
0.1.0-beta2024年7月24日
0.1.0-alpha32024年6月29日

#235网页编程

Download history 172/week @ 2024-04-26 35/week @ 2024-05-03 17/week @ 2024-05-10 25/week @ 2024-05-17 32/week @ 2024-05-24 43/week @ 2024-05-31 34/week @ 2024-06-07 31/week @ 2024-06-14 1/week @ 2024-06-21 216/week @ 2024-06-28 36/week @ 2024-07-05 27/week @ 2024-07-12 132/week @ 2024-07-19 172/week @ 2024-07-26 119/week @ 2024-08-02 222/week @ 2024-08-09

652 每月下载

MIT 许可证

800KB
18K SLoC

Leptos Logo

crates.io docs.rs Discord Matrix

网站 | 书籍 | Docs.rs | 沙箱 | Discord

您可以在 awesome-leptos 找到有用库和示例项目的列表。

main 分支目前正在为 0.7 版本发布进行重大更改。对于稳定版本,请使用 v0.6.13 标签

Leptos

use leptos::*;

#[component]
pub fn SimpleCounter(initial_value: i32) -> impl IntoView {
    // create a reactive signal with the initial value
    let (value, set_value) = create_signal(initial_value);

    // create event handlers for our buttons
    // note that `value` and `set_value` are `Copy`, so it's super easy to move them into closures
    let clear = move |_| set_value(0);
    let decrement = move |_| set_value.update(|value| *value -= 1);
    let increment = move |_| set_value.update(|value| *value += 1);

    // create user interfaces with the declarative `view!` macro
    view! {
        <div>
            <button on:click=clear>Clear</button>
            <button on:click=decrement>-1</button>
            // text nodes can be quoted or unquoted
            <span>"Value: " {value} "!"</span>
            <button on:click=increment>+1</button>
        </div>
    }
}

// we also support a builder syntax rather than the JSX-like `view` macro
#[component]
pub fn SimpleCounterWithBuilder(initial_value: i32) -> impl IntoView {
    use leptos::html::*;

    let (value, set_value) = create_signal(initial_value);
    let clear = move |_| set_value(0);
    let decrement = move |_| set_value.update(|value| *value -= 1);
    let increment = move |_| set_value.update(|value| *value += 1);

    // the `view` macro above expands to this builder syntax
    div().child((
        button().on(ev::click, clear).child("Clear"),
        button().on(ev::click, decrement).child("-1"),
        span().child(("Value: ", value, "!")),
        button().on(ev::click, increment).child("+1")
    ))
}

// Easy to use with Trunk (trunkrs.dev) or with a simple wasm-bindgen setup
pub fn main() {
    mount_to_body(|| view! {
        <SimpleCounter initial_value=3 />
    })
}

关于框架

Leptos 是一个全栈、同构的 Rust 网页框架,利用精细粒度的反应性来构建声明式用户界面。

这是什么意思?

  • 全栈:Leptos 可以用来构建在浏览器(客户端渲染)或服务器(服务器端渲染)中运行的应用程序,也可以通过在服务器上渲染 HTML 然后在浏览器中添加交互性(服务器端渲染与恢复)。这包括对数据(Resource)和 HTML(<Suspense/> 组件的顺序或无序流)的 HTTP 流的支持。
  • 同构:Leptos 提供了编写同构 服务器函数 的原语,即可以在客户端或服务器上以“相同形状”调用的函数,但仅运行在服务器上。这意味着您可以在客户端组件旁边编写仅服务器逻辑(数据库请求、身份验证等),就像它们在浏览器中运行一样调用服务器函数,而不需要创建和维护单独的 REST 或其他 API。
  • Web:Leptos 建立在 Web 平台和 Web 标准之上。路由器设计用于使用 Web 基础设施(如链接和表单)并在此基础上构建,而不是试图替换它们。
  • 框架:Leptos 提供了你构建现代 Web 应用所需的大部分功能:一个响应式系统、模板库以及同时适用于服务器和客户端的路由器。
  • 细粒度响应性:整个框架都是基于响应式原语构建的。这使得代码具有极高的性能,同时开销极小:当响应式信号的值发生变化时,它可以更新单个文本节点、切换单个类或从 DOM 中移除元素,而无需运行任何其他代码。(因此,没有虚拟 DOM 的开销!)
  • 声明式:告诉 Leptos 你希望页面如何显示,然后让框架告诉浏览器如何实现。

了解更多

以下是一些关于学习 Leptos 的资源

nightly 备注

大多数示例都假设你正在使用 nightly 版本的 Rust 和 Leptos 的 nightly 功能。要使用 nightly Rust,你可以全局设置工具链或按项目设置。

要将 nightly 设置为所有项目的默认工具链(如果尚未设置,还可以添加将 Rust 编译为 WebAssembly 的功能)

rustup toolchain install nightly
rustup default nightly
rustup target add wasm32-unknown-unknown

但是,如果你只想在你的 Leptos 项目中使用 nightly,请添加包含以下内容的 rust-toolchain.toml 文件

[toolchain]
channel = "nightly"
targets = ["wasm32-unknown-unknown"]

nightly 功能启用了访问和设置信号的函数调用语法,而不是 .get().set()。这导致了一种一致的心理模型,其中访问任何类型的响应式值(信号、memo 或衍生信号)总是表示为函数调用。这只有在 nightly Rust 和 nightly 功能下才有可能。

cargo-leptos

cargo-leptos 是一个构建工具,旨在使构建同时运行在客户端和服务器上的应用程序变得简单,并且具有无缝集成。目前开始一个真正的 Leptos 项目的最佳方式是使用 cargo-leptos 和我们为 ActixAxum 制作的入门模板。

cargo install cargo-leptos
cargo leptos new --git https://github.com/leptos-rs/start
cd [your project name]
cargo leptos watch

打开浏览器到 https://127.0.0.1:3000/

常见问题解答

这个名字是什么意思?

Leptos(λεπτός)是古希腊语中的一个词,意为“薄、轻、精致、细粒度”。对我来说,作为一个经典主义者而不是狗的主人,它唤起了推动框架的轻量级响应式系统。我后来了解到,同一个词也是医学术语“莱姆病”(leptospirosis)的词根,这是一种影响人类和动物的血液感染……我的错。在创建这个框架的过程中没有伤害任何狗。

它准备好用于生产了吗?

人们通常通过这个问题意味着三件事。

  1. API 是否稳定?也就是说,我是否需要从 Leptos 0.1 重写到 0.2,再写到 0.3,然后写到 0.4,或者我现在可以编写它,并在新版本发布时受益于新功能和更新?

API基本已经确定。我们正在添加新功能,但对类型系统和模式的实现非常满意。从架构的角度来看,我不期望代码会因适应未来的版本而发生重大更改。

  1. 有bug吗?

是的,我确信有。你可以从我们的问题跟踪器的状态中看到,bug并不多,并且通常很快就能得到解决。但确实有可能遇到需要框架层面修复的情况,这不一定能立即解决。

  1. 我是消费者还是贡献者?

这可能是一个很大的问题:“生产就绪”意味着一个库具有一定的方向性:你基本上可以使用它,而不需要了解其内部结构或贡献能力。每个人在他们的堆栈中都有这种水平的东西:例如,我(@gbj)目前没有能力或知识去贡献像wasm-bindgen这样的东西:我仅仅依赖它工作。

现在,社区中有几个人在工作内部应用中使用Leptos,他们也成为了重要的贡献者。我认为这是目前正确的生产使用水平。可能缺少您需要的功能,您可能最终会构建它们!但对于内部应用,如果您愿意在过程中构建和贡献缺失的部分,框架现在肯定是可以使用的。

我可以用它来构建原生GUI吗?

当然可以!显然,view宏是用来生成DOM节点,但您可以使用响应式系统轻松地驱动任何使用类似DOM的面向对象、基于事件回调框架的原生GUI工具包。原则是相同的

  • 使用信号、派生信号和memo来创建您的响应式系统
  • 创建GUI小部件
  • 使用事件监听器更新信号
  • 创建效果来更新UI

我准备了一个非常简单的GTK示例,您可以看看我是怎么做的。

为0.7版本开发的新渲染方法支持“通用渲染”,即它可以使用支持一小套6-8个函数的任何渲染库。(这旨在作为典型保留模式、面向对象风格的GUI工具包如DOM、GTK等的层。)这项未来的渲染工作将允许以与Web框架使用的声明性方法非常相似的方式创建原生UI。

这与Yew有什么不同?

Yew是Rust Web UI开发最常用的库,但Yew和Leptos在哲学、方法和性能方面存在一些差异。

  • VDOM与细粒度:Yew建立在虚拟DOM(VDOM)模型之上:状态变化导致组件重新渲染,生成一个新的虚拟DOM树。Yew将其与之前的VDOM进行对比,并应用这些补丁到实际的DOM。组件函数在状态变化时重新运行。Leptos采取完全不同的方法。组件运行一次,创建(并返回)实际的DOM节点,并设置一个响应式系统来更新这些DOM节点。

  • 性能:这具有巨大的性能影响:Leptos在创建和更新UI方面都比Yew快得多。

  • 服务器集成:Yew是在浏览器渲染的单页应用(SPA)是主流时代创建的。虽然Leptos支持客户端渲染,但它也侧重于通过服务器函数和多种HTML服务模式与您的应用程序的后端集成,包括无序流。

  • 这与Dioxus有什么不同?

与Leptos一样,Dioxus是一个使用Web技术构建UI的框架。然而,在方法和功能方面,它们之间存在重大差异。

  • VDOM 与细粒度:虽然 Dioxus 拥有高性能的虚拟 DOM(VDOM),但它仍然使用粗粒度/组件作用域的反应性:改变一个状态值会重新运行组件函数,并将旧的 UI 与新的 UI 进行比较。Leptos 组件使用不同的思维模型,创建(并返回)实际的 DOM 节点,并设置一个反应系统来更新这些 DOM 节点。

  • Web 与桌面优先级:在 Fullstack 模式下,Dioxus 使用 Leptos 服务器函数,但没有相同的基于 <Suspense> 的支持,例如流式 HTML 渲染,或者对整体 Web 性能有同样的关注。Leptos 更倾向于优先考虑整体 Web 性能(流式 HTML 渲染、较小的 WASM 二进制大小等),而 Dioxus 在构建桌面应用程序方面拥有无与伦比的经验,因为您的应用程序逻辑作为一个本机 Rust 二进制文件运行。

  • 这与 Sycamore 有何不同?

Sycamore 和 Leptos 都受到了 SolidJS 的极大影响。到目前为止,Leptos 拥有更大的社区和生态系统,并且发展更为活跃。其他差异

  • 模板 DSL:Sycamore 使用自定义的模板语言为其视图,而 Leptos 使用类似 JSX 的模板格式。
  • 'static 信号:Leptos 的主要创新之一是创建 Copy + 'static 信号,这些信号具有极佳的易用性。Sycamore 正在采用相同的模式,但尚未发布。
  • Perseus 与服务器函数:Perseus 元框架提供了一种有见地的构建包含服务器功能 Sycamore 应用程序的方法。Leptos 则在框架的核心中提供诸如服务器函数等原语。

依赖项

~9–18MB
~238K SLoC