SuperAPI AI 工具集

gpui-style-guide

编程与开发

查看项目

更新于 11-07 08:34

技能介绍

gpui-style-guide 是一份针对 GPUI Component 项目的代码风格指南,由 gpui-component 在 crates/ui 中的组件实现模式归纳而来,适用于编写新组件、审查代码以及保持与现有组件库风格一致的场景。

用途 该指南用于统一 GPUI 组件的代码写法,帮助开发者在新增或修改组件时沿用既有约定,降低风格差异带来的维护成本。

主要能力 指南给出以下方面的规范:

  1. 组件结构:基础组件模式使用 #[derive(IntoElement)] 定义结构体,包含 id: ElementId、base: Div、style: StyleRefinement,以及配置字段、内容字段和以 Rc<dyn Fn> 表示的回调;有状态组件模式则通过 Entity<State> 持有状态。
  2. Trait 实现:说明 InteractiveElement、StatefulInteractiveElement、Styled、RenderOnce 的实现方式,以及按需实现 Sizable、Selectable、Disableable。
  3. 变体模式:包括枚举变体(如 ButtonVariant)、基于 trait 的变体 API(如 ButtonVariants)和自定义变体结构(如 ButtonCustomVariant)。
  4. Action 与快捷键:通过上下文常量与 init 函数绑定按键,并使用 on_action 处理动作。
  5. Trait 定义:如 SelectItem 及其对 String、SharedString、&'static str 的实现,以及 IconNamed 与 IconName 枚举。
  6. 文档注释:组件和方法使用 /// 注释,说明参数含义。
  7. 导入顺序:依次为外部 crate、crate 内部模块、gpui;字段组织依次为身份、配置、内容、回调。
  8. 常用模式:可选元素使用 Option<AnyElement>,回调函数采用事件参数或状态参数形式,并提供静态处理函数与布尔开关方法的写法。
  9. 渲染与主题:RenderOnce 中组合布局与条件样式,颜色通过 cx.theme() 获取。

使用方式 该资料为风格规范文档,本身不包含安装命令或可执行步骤;使用时按文档中的代码模式编写或审查 crates/ui 下的组件,并可参考 component-examples.md 与 trait-patterns.md 了解完整实现与 trait 设计细节。文档末尾提供新建组件检查清单,列出结构体标注、字段、trait 实现、回调类型、可选子元素、导入和主题颜色等要点。

适用场景 适用于 GPUI Component 项目内新增 UI 组件、代码评审、保持组件库风格一致,以及设计自定义 trait 与变体 API 时参考。

限制 资料未提供收费、价格、平台支持范围或运行时效果等信息;内容以 Rust 与 gpui 代码为主,面向熟悉该框架的开发者。