2个不稳定版本
0.2.0 | 2024年2月20日 |
---|---|
0.1.0 | 2023年12月7日 |
在 进程宏 中排名 2109
在 3 个crate中使用(通过 rcss)
68KB
1.5K SLoC
RCSS - Rust应用程序中的可重用CSS。
RCSS 允许你直接在Rust代码中编写样式,大多数情况下无需引号。
let css = css!{
.container {
background-color: black;
}
#id {
color: red;
}
button {
border: 1px solid black;
}
};
assert!(css.container.starts_with("container"));
RCSS 使用 LightningCSS(浏览器级CSS预处理器)解析和生成CSS代码。它可以打包所有CSS到静态文件中,或者生成内联CSS内容。
它使用与JS世界中的 css_modules 相似的方法,以类型安全的方式公开CSS类。对于不使用类名的选择器,它使用作用域样式方法(添加具有唯一名称的自定义类)。
使用RCSS定义的样式可以在其他组件中扩展和重用。
// Declare a public module name foo;
css!{
@rcss(pub struct Foo);
.container {
color: green;
background-color: black;
}
};
// Component define what type of css it needs.
fn hello_world<C>(css: C) -> String
C: rcss::ScopeChain<Root = Foo>
{
// use ScopeChain to include style chain. Checkout rcss-layers for details.
format!(r#"<div class="{}">Hello</div>"#, css.container)
}
...
// Extend style from module foo, typecheck that no new classes, ids or types are added.
let css = css!{
@rcss(extend ::path::to::Foo);
.container {
background-color: red;
}
};
let html = hello_world(css);
为了更好地控制级联并避免冲突,RCSS 提供了可以将扩展样式保存到CSS rcss-layers
crate的 @layer
。
使用方法
[dependencies]
rcss = "0.2"
RCSS 并不专注于任何特定的Web框架,即使没有框架也可以使用,只需要使用 format!
,但要使其更方便,这个仓库还将包括与流行的Web框架的集成。目前,只有一个集成crate:为 leptos 的 rcss-leptos
与leptos一起使用
要使用rcss与leptos,将以下内容添加到你的 Cargo.toml
[dependencies]
rcss = "0.2"
rcss-leptos = "0.2"
然后在组件中,你可以使用 css!
宏来定义样式。
use rcss::css;
use leptos::*;
#[component]
fn hello_world() -> Node {
let css = css!{
.container {
background-color: black;
color: white;
}
};
rcss_leptos::register_style(css.clone());
view! {
<div class=css.container>Hello</div>
}
}
更多示例可以在 examples/leptos
目录中找到。
打包CSS
RCSS可以将所有CSS打包到一个静态文件中。要这样做,可以在 build.rs
中使用 rcss-bundler
crate。
[build-dependencies]
rcss-bundler = "0.2"
fn main() {
rcss_bundler::bundle_build_rs();
}
默认情况下,打包器会将CSS保存到 $OUT_DIR/styles.css
。然而,这可以通过 cargo metadata 进行自定义。
[package.metadata.rcss]
output-path = "style/counters.css" # Path to save styles
disable-styles = false # If set to true will force `rcss-macro` to remove style strings from macro output.
注意:如果在第一次构建后添加了 rcss-bundler
,则 rcss-macro
可以忽略 disable-styles
。可以使用以下命令强制 cargo 重新构建 rcss-macro
: cargo clean -p rcss-macro
或 cargo clean -p rcss-macro --target-dir target/front
(如果是 cargo-leptos)。
已知问题
-
应仅从一个根 crate 中使用
rcss-bundler
。如果您有多个使用rcss-bundler
的 crate,或者工作空间在一个目标目录中共享多个根 crate 的构建工件,则会导致配置冲突。例如,如果一个根 crate 设置了disable-styles=true
而另一个没有设置,则rcss-bundler
将抛出警告并使用disable-styles=false
为所有工作空间/crate。 -
目前,CSS 解析错误尚未完全集成到 Rust 诊断消息中,因此如果存在无效的 CSS 语法,它将仅抛出一个通用错误,而不会突出显示错误的精确位置。
-
宏中的未引用文本有一些限制,例如它不能包含单引号
\'
或未完成的括号(如{
或(
)。这是因为 Rust 为宏提供 TokenStream 的方式。 -
未引用的文本与
em
单位和一些以字母 e 开头并以数字结尾的十六进制数(如#0ed
)不兼容,因为 Rust 将它们解析为指数数字字面量,并期望在 e 后面是数字而不是字母 "m"。
对于问题 3-4,可以使用插值作为解决方案 #{"3em"}#
宏实现细节
Rust 中编写函数宏有两种方法。
- 一种是从 proc-macro 处理
TokenStream
。这种方式可以保留原始代码的链接,因此 IDE 和编译器可以显示与原始代码相关的错误,变量可以被解析等等。但是 Rust 中的TokenStream
专门针对 Rust 语法,因此在其中支持外语法更困难。
查看 rstml::RawText 或 rstml::NodeName,这两个结构体都提供了一种解析 HTML 特定语法的方法,例如破折号分隔的标识符或未引用的文本。
- 另一种方法是将宏输入处理为普通字符串。这种方法更灵活,因为您可以使用任何您想要的解析器,但您将失去所有 `TokenStream` 的好处,并必须编写自己的解析器。
与HTML模板不同,在HTML模板中需要以某种方式混合来自Rust和模板的反应性变量 - CSS通常包含静态预定义内容,很少需要在运行时生成。因此,原始代码和IDE之间的链接不太重要。相反,大多数用户只想在他们组件的实现附近编写CSS。
因此,而不是在proc-macro::TokenStream
之上编写自定义解析器,这个库试图将宏调用转换为字符串,并与方便的CSS预处理器一起工作。
依赖项
~12MB
~158K SLoC