Project Icon

gcss

纯Go实现的CSS生成工具

gcss是一个纯Go实现的CSS生成工具,允许开发者在Go代码中直接定义和管理样式。它提供了服务器端CSS控制的新方法,无需预处理器。gcss支持主题、媒体查询和复杂样式结构,提高了CSS管理的灵活性和可维护性。该工具易于集成到Go项目中,并可与其他CSS框架协同工作。

测试 Go 报告卡

banner

gcss

用纯 Go 编写的 CSS。

动机

这其实只是一种有趣的尝试,看看能否用 Go 来编写 CSS,以及它会是什么样子。我想找到一种方法,可以从服务器端轻松控制 CSS,而不必担心预构建 CSS 来处理变量等问题。我不想使用为 JS 框架编写的 UI 库,也不想使用会给构建过程增加更多步骤的预处理器或 linter。

我可以直接使用 CSS 吗?当然可以,而且我会这样做,但我想看看是否可以用 Go 编写 CSS,因为它正在编译项目的其余部分。

地鼠

它看起来一点也不像 Go 的地鼠,但它是一只地鼠,我喜欢它。这是我在不放弃的情况下从 LM 得到的最好结果,ideogram.ai (1400097641)

下一步

这个项目的下一步是为 CSS 包添加更多功能。这包括在需要时添加对更多 CSS 属性的支持。我不想添加对所有 CSS 功能的支持,因为有些东西在 CSS 中更好,但我确实想能够创建一些可以使用 Go 配置的 UI 组件。

安装

go get github.com/AccentDesign/gcss

快速开始

这里有一个包含完整示例的独立仓库 在此,它会随时间不断发展。

git clone https://github.com/AccentDesign/gcss-starter.git

安装依赖:

# 用于热重载
go install github.com/cosmtrek/air@latest
go mod tidy

运行服务器:

air

使用方法

基本用法

gcss 定义了一个 Style 类型,可用于保存特定 CSS 选择器的属性,例如:

style := gcss.Style{
    Selector: "body",
    Props: gcss.Props{
        BackgroundColor: props.ColorRGBA(0, 0, 0, 128),
    },
}

StyleCSS 函数用于将样式写入 io.Writer

style.CSS(os.Stdout)

这会给你:

body{background-color:rgba(0,0,0,0.50);}

就是这么简单。但你可能会说,单独使用它并不是很有用。

多个样式

那么你可以使用它来定义一个 Styles 类型,用于保存多个 Style 类型:

type Styles []gcss.Style

func (s Styles) CSS(w io.Writer) error {
    // 处理你的错误
    for _, style := range s {
        style.CSS(w)
    }
    return nil
}

styles := Styles{
    {
        Selector: "body",
        Props: gcss.Props{
            BackgroundColor: props.ColorRGBA(0, 0, 0, 128),
        },
    },
    {
        Selector: "main",
        Props: gcss.Props{
            Padding: props.UnitRem(8.5),
        },
    },
}

styles.CSS(os.Stdout)

这会给你:

/* 为了可读性进行了格式化 */
body{
    background-color:rgba(0,0,0,0.50);
}
main{
    padding:8.500rem;
}

需要更多?比如暗色和亮色主题?记住上一个例子,继续往下看。

定义一个 Theme 类型,用于保存特定主题的属性,例如:

type Theme struct {
    MediaQuery string
    Background props.Color
}
func (t *Theme) CSS(w io.Writer) error {
    // 处理错误
    fmt.Fprintf(w, "%s{", t.MediaQuery)
    for _, style := range t.Styles() {
        style.CSS(w)
    }
    fmt.Fprint(w, "}")
}

// Styles 返回主题的样式。
// 可以是任意数量的样式和任意数量的函数
// 你只需要在 CSS 函数中遍历它们。
func (t *Theme) Styles() Styles {
    return Styles{
        {
            Selector: "body",
            Props: gcss.Props{
                BackgroundColor: t.Background,
            },
        },
    }
}

然后你可以定义一个 `Stylesheet` 类型,用于保存多个 `Theme` 类型:

type Stylesheet struct {
    Dark  *Theme
    Light *Theme
}

func (s *Stylesheet) CSS(w io.Writer) error {
    // 处理错误
    s.Dark.CSS(w)
    s.Light.CSS(w)
    return nil
}

最后,你可以使用 `Stylesheet` 类型将 css 写入 `io.Writer`:

styles := Stylesheet{
    Dark: &Theme{
        MediaQuery: "@media (prefers-color-scheme: dark)",
        Background: props.ColorRGBA(0, 0, 0, 255),
    },
    Light: &Theme{
        MediaQuery: "@media (prefers-color-scheme: light)",
        Background: props.ColorRGBA(255, 255, 255, 255),
    },
}

styles.CSS(os.Stdout)

生成结果如下:

@media (prefers-color-scheme: dark) {
    body{
        background-color:rgba(0,0,0,1.00);
    }
}
@media (prefers-color-scheme: light) {
    body{
        background-color:rgba(255,255,255,1.00);
    }
}

希望这能帮助你开始。接下来就看你的了。

* 也许创建一个接受 `props.Color` 并返回 Style 的按钮函数。
* 或者向 `Stylesheet` 添加额外的 `Styles` 以包含非主题样式。
* 一切都取决于你如何构造 `Stylesheet` 并使用 `gcss.Style` 类型。
* 如果我能创建一个适用于所有用例的 `Stylesheet` 类型,我会这么做,但可能性太多了,所以我把它留给你。

优点

* 从服务器端完全控制 CSS。
* CSS 没有混入(mixins),但你可以创建一个返回 `Style` 类型的函数并重复使用它。
* 保持 css 中没有变量。
* 保持 html 中没有像 `bg-gray-50 text-black dark:bg-slate-800 dark:text-white` 这样的类,并消除了记住添加暗色变体的需要。
* 我最近在一个 html 页面上看到一个按钮组件重复了 10 次,每次在 class 属性中超过 1800 个字符。这是不可维护也不可调试的。
* 保持 css 干净,易于调试,没有像上面那样的覆盖。

示例

有关使用示例,请参见 [examples](./examples) 目录,其中包括:

* [完整示例](./examples/full) - 包括基础、媒体和主题样式的完整示例,使用 `sync.Mutex` 在 `http.HandleFunc` 中缓存 css。
* [CSS 重置](./examples/css-resets) - 一个简单的 css 重置集合示例。
* [Templ 集成](./examples/integration-templ) - 一个如何使用 [templ](https://templ.guide) 包加载 gcss 样式的示例。
* [媒体查询](./examples/media-queries) - 一个如何使用媒体查询的示例。
* [模板函数](./examples/template-function) - 一个如何通过 `template.FuncMap` 和 `template.CSS` 直接将 css 写入模板的示例。
* [写入文件](./examples/to-file) - 一个如何写入文件的示例。
* [写入 HTTP 处理程序](./examples/to-http-handler) - 一个如何写入 http 处理程序的示例。
* [写入标准输出](./examples/to-stdout) - 一个如何写入标准输出的示例。

贡献

如果你想为这个项目做出贡献,请开一个 issue 或提交一个 pull request。我们欢迎所有的贡献和想法。

与其他 CSS 框架混合使用

你可以将 `gcss` 与其他 CSS 框架(如 `tailwindcss`)混合使用,例如:

将 css 文件分为基础和实用工具:

/* base.css */
@tailwind base;

/* utils.css */
@tailwind utilities;

然后在 html 中间添加 `gcss` 样式:

<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="gcss-styles.css">
<link rel="stylesheet" href="utils.css">
尽量通过使用单一类名来保持`gcss`样式的特异性为1,这样可以确保在需要时`tailwindcss`的工具类能够覆盖你的样式。
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号