技能檔案

Tdesign Create Component

Name: Tdesign Create Component
Author: Tencent

This skill should be used when creating a new TDesign React component. It provides a complete SOP for scaffolding components in the packages/components or packages/pro-components directories, including file structure, code patterns, and registration steps.

Tencent943 星標2026年3月16日

職業
分類: Frontend

技能內容

TDesign 组件创建脚手架

本技能提供 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）为例：

相關技能

Tdesign Create Component | Skills Pool

packages/components/example-component/
├── index.ts                    # 组件入口
├── ExampleComponent.tsx        # 组件主文件
├── type.ts                     # 类型定义（由 API 平台生成）
├── defaultProps.ts             # 默认属性（由 API 平台生成）
├── example-component.md        # 中文文档
├── example-component.en-US.md  # 英文文档
├── style/
│   ├── index.js               # Less 样式入口
│   └── css.js                 # CSS 样式入口
├── _example/
│   └── base.tsx               # 基础示例
├── _usage/                    # Live Demo 配置（可选）
│   └── props.json
└── __tests__/
    └── vitest-example-component.test.tsx

import _ExampleComponent from './ExampleComponent';

import './style/index.js';

export type { ExampleComponentProps } from './ExampleComponent';
export * from './type';

export const ExampleComponent = _ExampleComponent;
export default ExampleComponent;

import React, { forwardRef } from 'react';
import classNames from 'classnames';
import useConfig from '../hooks/useConfig';
import useDefaultProps from '../hooks/useDefaultProps';
import { TdExampleComponentProps } from './type';
import { exampleComponentDefaultProps } from './defaultProps';

export interface ExampleComponentProps extends TdExampleComponentProps {
  // 扩展属性（如原生 HTML 属性）
}

const ExampleComponent = forwardRef<HTMLDivElement, ExampleComponentProps>(
  (originProps, ref) => {
    // 1. 合并默认属性
    const props = useDefaultProps(originProps, exampleComponentDefaultProps);
    const { className, style, ...restProps } = props;

    // 2. 获取前缀配置
    const { classPrefix } = useConfig();
    const componentClass = `${classPrefix}-example-component`;

    // 3. 计算类名
    const rootClassName = classNames(componentClass, className);

    // 4. 渲染
    return (
      <div ref={ref} className={rootClassName} style={style}>
        {/* 组件内容 */}
      </div>
    );
  }
);

ExampleComponent.displayName = 'ExampleComponent';

export default ExampleComponent;

/* eslint-disable */

/**
 * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
 * */

import { TNode, StyledProps } from '../common';

export interface TdExampleComponentProps extends StyledProps {
  /**
   * 组件内容
   */
  children?: TNode;
  /**
   * 是否禁用
   * @default false
   */
  disabled?: boolean;
}

/**
 * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
 * */

import { TdExampleComponentProps } from './type';

export const exampleComponentDefaultProps: TdExampleComponentProps = {
  disabled: false,
};

import '../../_common/style/web/components/example-component/index.less';

import '../../_common/style/web/components/example-component/index.css';

import React from 'react';
import { ExampleComponent } from 'tdesign-react';

export default function ExampleComponentBase() {
  return <ExampleComponent>基础用法</ExampleComponent>;
}

import { render } from '@testing-library/react';
import ExampleComponent from '../ExampleComponent';

describe('ExampleComponent', () => {
  it('renders correctly', () => {
    const { container } = render(<ExampleComponent />);
    expect(container.firstChild).toHaveClass('t-example-component');
  });

  it('supports disabled state', () => {
    const { container } = render(<ExampleComponent disabled />);
    expect(container.firstChild).toHaveClass('t-is-disabled');
  });
});

// 在文件末尾添加
export * from './example-component';

{
  title: '基础组件',
  type: 'component',
  children: [
    // ... 其他组件
    {
      title: 'ExampleComponent 示例组件',
      name: 'example-component',
      path: '/react/components/example-component',
      component: () => import('tdesign-react/example-component/example-component.md'),
    },
  ],
}

---

Tdesign Create Component

TDesign 组件创建脚手架

触发条件

SOP 流程

Step 1: 确定组件类型和目标目录

Step 2: 创建组件目录结构

Tdesign Create Component

TDesign 组件创建脚手架

触发条件

SOP 流程

Step 1: 确定组件类型和目标目录

Step 2: 创建组件目录结构

Step 3: 编写组件入口文件 (index.ts)

Step 4: 编写组件主文件（标准模式）

Step 5: 编写类型定义文件 (type.ts)

Step 6: 编写默认属性文件 (defaultProps.ts)

Step 7: 编写样式入口文件

Step 8: 编写基础示例 (_example/base.tsx)

Step 9: 编写测试文件

Step 10: 注册组件到导出入口

Step 11: 注册组件到站点配置

Step 12: 编写组件文档 (example-component.md)

Extract Errors

Frontend Patterns

Coding Standards

Coding Standards

Coding Standards

Frontend Patterns