#ui #web-apps #website #ui-framework #component #material

bin+lib webui

早期开发 专为快速构建具有原生 Material UI 标准支持的网站而设计的网站 UI 框架和组件库

89 个版本

0.10.5 2024 年 6 月 15 日
0.8.3 2024 年 5 月 6 日
0.7.11 2024 年 1 月 30 日
0.6.2 2023 年 4 月 15 日
0.3.23 2022 年 11 月 9 日

#93WebAssembly

Download history 1280/week @ 2024-04-26 133/week @ 2024-05-03 12/week @ 2024-05-10 3/week @ 2024-05-17 1/week @ 2024-05-24 269/week @ 2024-06-14 23/week @ 2024-06-21 5/week @ 2024-07-05 532/week @ 2024-07-26 39/week @ 2024-08-02

每月 571 次下载

MIT 许可证

35KB
580

Web UI

WebUI 版本:0.10.5

查看演示和文档网站 - webui.stoicdreams.com

查看 Rust WebUI 文档 - docs.rs/webui

在 crates.io 上查看 - crates.io/crates/webui

在 GitHub 上查看 - github.com/StoicDreams/WebUI

Stoic Dreams Discord

关于

webui 是一个用于快速轻松构建 WebAssembly SPA 网站的网站框架。

目标

  • 最小化启动新网站项目时的样板代码。
  • 遵循 Material UI 标准。
  • 提供强大的组件系统,用于处理常见的显示类型、用户输入和交互以及数据处理。

开发才刚刚开始,因此我们不推荐在此阶段用于任何超出实验性的目的。

入门

以下说明假设您至少对 Rust 语言和生态系统有些许了解。

如果您是 Rust 语言的新手,请通过阅读 《Rust 语言圣经》 来了解该语言。

此项目是在 Mac 上设置的,因此目前尚未在 Windows 或 Linux 机器上验证说明,尽管预计在此范围内不会有太大差异。

安装所需的开发依赖项

按照 这里 的说明安装适合您系统的 Rust。

确保 Rust 是最新的

rustup update

安装 Trunk 可执行文件 - 这将用于在浏览器中测试本地运行的网站。

cargo install trunk wasm-bindgen-cli

添加 waxm 构建目标

rustup target add wasm32-unknown-unknown

特性

在开始之前,了解 WebUI 提供的可选特性非常重要。

这些特性可以通过功能标志来启用。一些特性仅适用于用于设置核心 WebUI 框架文件的 WebUI 可执行文件,而其他特性仅适用于 WebUI 库,最后一些特性两者都适用。

标志 Lib Exe 详情
tauri X 包括此标志以启用集成到 Tauri 应用程序的功能。

开始一个新的Rust项目

首先,使用cargo创建您的项目。

cargo new name_of_your_app
cd name_of_your_app

验证您的Rust环境是否正确设置。

cargo run

更新您的Cargo.toml文件以包含webui依赖项。

[package]
name = "name_of_your_app"
version = "0.1.0"
edition = "2021"

[dependencies]
webui = "0.10.5"
# Customize with specific feature flags (pages is included by default)
# webui = { version = "0.10.5", features = ["tauri"] }
# webui = { version = "0.10.5", default-features = false }
# Use the direct GitHub reference if you want bleeding edge updates
# webui = { git = "https://github.com/StoicDreams/WebUI", branch = "main" }

安装webui可执行文件 - 这将用于构建您的样板静态文件。

注意:我们建议您通常为您的webui可执行文件设置与您设置webui库相同的特性标志,以确保包含配套的启动文件。尽管如此,WebUI库的版本和Exe版本之间并不共享所有特性。有关在WebUI可执行文件和库之间使用特定特性的更多信息,请参阅上方的特性部分。

# default installation, includes starter pages md files.
cargo install webui

在项目的根目录(不是src)中运行webui以添加静态文件(index.html、css等)

webui

Web UI 文件

请注意,每次您更新到新版本时,都应该运行webui命令,确保更新项目中的webui可执行文件和webui依赖项。

某些文件被认为是静态的,不应手动更新。在更新期间,这些文件将被覆盖。

其他文件被认为是启动文件,您可能需要或希望更新,在更新期间不会覆盖现有文件。如果您想更新到最新的启动文件,那么您将需要删除或重命名现有文件 - 建议重命名文件,例如将.bck后缀添加到文件名,以便在创建新Web UI文件后复制您的自定义设置。

文件 启动 静态 详情
index.html X 更新元数据信息和添加任何用于扩展js/css功能的链接。
app.webmanifest X 更新有关您应用的信息。这对于可安装的SPA应用使用。
robots.txt X 根据需要更新以管理搜索引擎规则。
Logo.svg X 占位符logo。更新为您自己的。
service-worker.js X 基本的文件缓存service worker,对于可安装的SPA应用也是必需的。
service-worker.min.js X 基本文件缓存service worker的压缩版本,对于可安装的SPA应用也是必需的。

运行开发服务器进行测试

从您的项目根目录运行trunk serve --open以在本地运行您的网站。--open标志将在您的默认浏览器中打开您的网站。如果您已经打开了页面,您可以省略--open标志。

trunk serve --open

作者

Erik Gassler - Stoic Dreams - 为明天的软件开发锻造解决方案。

支持 - 如果您想为Stoic Dreams提供支持,请访问Stoic Dreams的GitHub赞助页面

许可

MIT

依赖

~17–33MB
~482K SLoC