#css #css-parser #rsx #html #parse #macro #parser

rcss-leptos

Rust CSS嵌入库与leptos框架集成

1个不稳定版本

0.2.0 2024年2月20日

#2034 in Web编程

MIT/Apache

54KB
688

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的crate,可以保存扩展样式到CSS @layer

用法

[dependencies]
rcss = "0.2"

RCSS不专注于任何特定的Web框架,即使没有框架也可以使用,只需使用 format!,但为了使其更方便,此仓库还将包括与流行的Web框架的集成。目前,只有一个集成crate:为 leptosrcss-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元数据进行自定义。

[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-macrocargo clean -p rcss-macrocargo clean -p rcss-macro --target-dir target/front(在 cargo-leptos 的情况下)。

已知问题

  1. rcss-bundler 应仅从一个根包中使用。如果您有多个使用 rcss-bundler 的包,或者工作空间在同一个目标目录中共享多个根包的构建工件,则会导致配置冲突。例如,如果一个根包设置了 disable-styles=true,而另一个没有,则 rcss-bundler 将抛出一个警告,并将所有工作空间/包的 disable-styles=false。

  2. 目前,CSS 解析错误尚未完全集成到 rust 诊断消息中,因此如果存在无效的 CSS 语法,它将仅抛出一个通用错误,而不会突出显示错误的确切位置。

  3. 宏中的未引用文本有一些限制,例如不能包含单引号 ' 或未完成的括号(如 {()。这是因为 Rust 提供给宏的 TokenStream 的方式。

  4. 未引用文本与 em 单位和一些以数字开头并以字母 e 开头的十六进制数(如 #0ed)配合使用效果不佳,因为 rust 将它们解析为指数数字字面量,并在 e 后期望一个数字而不是字母 "m"。

对于问题 3-4,可以使用插值作为解决方案,例如 #{"3em"},其中包含带引号的文本。

宏实现细节

在 Rust 中编写函数宏有两种方法。

  • 一种是从 proc-macro 处理 TokenStream。这种方式可以保留原始代码的链接,因此 IDE 和编译器可以显示与原始代码相关的错误,变量可以被解析等等。但是 Rust 中的 TokenStream 专门针对 Rust 语法,因此在其中支持 foreign 语法更困难。

查看 rstml::RawTextrstml::NodeName,这两个结构体都提供了一种处理 HTML 特定语法的 hacky 方法,如连字符分隔的标识符或未引用的文本。

  • 另一种方法是将宏输入作为常规字符串处理。这种方法更灵活,因为您可以使用任何您想要的解析器,但您将失去所有 `TokenStream` 的优势,并必须编写自己的解析器。

与需要某种方式将 Rust 中的反应式变量与模板混合的 HTML 模板不同,CSS 通常包含静态预定义内容,很少需要在运行时生成。因此,原始代码与 IDE 之间的链接不太重要。相反,大多数用户只是希望在组件的实现附近编写它们的 CSS。

因此,不是在 proc-macro::TokenStream 的基础上编写自定义解析器,这个库尝试将宏调用转换为字符串,并使用方便的 CSS 预处理器。

依赖项

~29–41MB
~632K SLoC