#leptos #server #signal #websocket-client #client-server #actix-web

leptos_server_signal

通过 WebSocket 同步的 Leptos 服务器端信号

9 个版本 (5 个破坏性更新)

0.6.0 2024 年 3 月 27 日
0.5.2 2023 年 10 月 5 日
0.5.1 2023 年 8 月 13 日
0.5.0 2023 年 7 月 18 日
0.1.0 2023 年 5 月 3 日

#299 in WebSocket

Download history 19/week @ 2024-04-27 10/week @ 2024-05-04 8/week @ 2024-05-11 10/week @ 2024-05-18 13/week @ 2024-05-25 21/week @ 2024-06-01 17/week @ 2024-06-08 26/week @ 2024-06-15 18/week @ 2024-06-22 1/week @ 2024-06-29 5/week @ 2024-07-06 7/week @ 2024-07-13 19/week @ 2024-07-20 35/week @ 2024-07-27 5/week @ 2024-08-03 55/week @ 2024-08-10

每月 <114 次下载

MIT 许可证

20KB
290

Leptos 服务器端信号

服务器端信号是 leptos 信号,通过 WebSocket 与服务器端同步。

信号在客户端为只读,可以被服务器写入。这在你需要服务器控制的 UI 实时更新时非常有用。

信号的变化通过 WebSocket 以 json 补丁 的形式发送到客户端。

特性标志

  • ssr: 当在服务器上渲染应用时启用 ssr。
  • actix: 与 Actix Web 框架的集成。
  • axum: 与 Axum Web 框架的集成。

示例

Cargo.toml

[dependencies]
leptos_server_signal = "*"
serde = { version = "*", features = ["derive"] }

[features]
ssr = [
  "leptos_server_signal/ssr",
  "leptos_server_signal/axum", # or actix
]

客户端

use leptos::*;
use leptos_server_signal::create_server_signal;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Serialize, Deserialize)]
pub struct Count {
    pub value: i32,
}

#[component]
pub fn App() -> impl IntoView {
    // Provide websocket connection
    leptos_server_signal::provide_websocket("ws://127.0.0.1:3000/ws").unwrap();

    // Create server signal
    let count = create_server_signal::<Count>("counter");

    view! {
        <h1>"Count: " {move || count.get().value.to_string()}</h1>
    }
}

服务器 (Axum)

#[cfg(feature = "ssr")]
pub async fn websocket(ws: WebSocketUpgrade) -> Response {
    ws.on_upgrade(handle_socket)
}

#[cfg(feature = "ssr")]
async fn handle_socket(mut socket: WebSocket) {
    let mut count = ServerSignal::<Count>::new("counter").unwrap();

    loop {
        tokio::time::sleep(Duration::from_millis(10)).await;
        let result = count.with(&mut socket, |count| count.value += 1).await;
        if result.is_err() {
            break;
        }
    }
}

依赖项

~20–35MB
~575K SLoC