用途
tdesign-create-component 是 TDesign React 的组件创建脚手架技能,用于在创建新的 TDesign React 组件时提供完整 SOP 流程。触发场景包括:创建新的 TDesign 组件、初始化组件脚手架、添加新的基础组件或高阶组件。
SOP 流程概览
Step 1:确定组件类型和目标目录
基础组件放在 packages/components/,用于通用 UI 组件(button、input、select 等);高阶组件放在 packages/pro-components/,用于业务/AIGC 组件(chat、copilot 等)。
Step 2:创建组件目录结构
以 example-component(PascalCase: ExampleComponent)为例,目录包含:index.ts 组件入口、ExampleComponent.tsx 组件主文件、type.ts 类型定义(由 API 平台生成)、defaultProps.ts 默认属性(由 API 平台生成)、example-component.md 中文文档、example-component.en-US.md 英文文档、style/index.js(Less 样式入口)、style/css.js(CSS 样式入口)、_example/base.tsx 基础示例、_usage/props.json(可选,Live Demo 配置)、__tests__/vitest-example-component.test.tsx 测试文件。
Step 3:编写组件入口文件 index.ts
入口文件导入组件、导入样式,导出类型与默认组件。
Step 4:编写组件主文件(标准模式)
使用 forwardRef + useDefaultProps 标准模式,配合 classNames 与 useConfig()。流程为:合并默认属性、获取 classPrefix 前缀配置、计算类名、渲染。设置 displayName 后默认导出。
Step 5:编写类型定义文件 type.ts
该文件由 API 平台生成,不应手动编辑;临时开发可先写简化版本,后续由 API 平台覆盖。文件头注释说明为脚本自动生成文件。
Step 6:编写默认属性文件 defaultProps.ts
同样由 API 平台生成,不应手动编辑,文件头注释说明为脚本自动生成文件。
Step 7:编写样式入口文件
style/index.js 引用 Less 源文件,style/css.js 引用编译后 CSS。
Step 8:编写基础示例 _example/base.tsx
从 tdesign-react 导入组件并渲染基础用法。
Step 9:编写测试文件
位置为 __tests__/vitest-example-component.test.tsx,使用 @testing-library/react 的 render 进行渲染测试,校验根类名与 disabled 状态类。
Step 10:注册组件到导出入口
编辑 packages/components/index.ts,添加 export * from './example-component';。
Step 11:注册组件到站点配置
编辑 packages/tdesign-react/site/site.config.mjs,在基础组件 children 中追加标题、name、path 与 component 配置。
Step 12:编写组件文档
组件文档采用 Markdown + {{ xxx }} 占位符机制,占位符在站点构建时自动解析为 _example/xxx.tsx 中导出的 React 组件。基础组件使用双层拼接:文档主体(跨框架通用)位于 packages/common/docs/web/api/<component>.md,包含使用说明文本和 {{ xxx }} 示例占位符;框架入口(React 特有)位于 packages/components/<component>/<component>.md,以 :: BASE_DOC :: 开头自动引入上层文档主体,后面追加 React 特有的 API 表格。当 <component>.md 以 :: BASE_DOC :: 开头时,文档的使用说明和示例占位符不在该文件中,而在 packages/common/docs/web/api/<component>.md 里。映射规则:每个 {{ xxx }} 对应 _example/xxx.tsx,文件必须默认导出一个 React 组件,占位符名称必须与文件名(不含扩展名)完全一致;新增示例时必须同时创建 .tsx 文件并添加对应占位符。
关键规范引用
执行时应参考:CSS 命名规范(.codebuddy/specs/css-naming-spec.md),前缀使用 t-,BEM 命名 t-[component]__[element]--[modifier],状态类 t-is-*;API 设计规范(.codebuddy/specs/api-design-spec.md),使用 TNode 类型定义可定制内容,事件命名使用 on 前缀,size 属性固定三档 small/medium/large;构建产物规范(.codebuddy/specs/build-output-spec.md),确保 style/ 目录正确配置。
常见模式
受控/非受控模式使用 useControlled;TNode 渲染使用 parseTNode;静态方法组件(如 Message)使用 forwardRefWithStatics 挂载静态方法。
检查清单
创建完成后确认:组件目录结构完整;使用 forwardRef + useDefaultProps 标准模式;使用 useConfig() 获取前缀,未硬编码 t-;type.ts 和 defaultProps.ts 标记为自动生成;已注册到 index.ts 和 site.config.mjs;基础示例可正常运行;测试文件可通过。
限制
资料未提供该技能的具体安装方式、收费或价格信息、支持的平台范围以及实际使用效果说明。