# rule-describe LLMs.txt

> 供 LLM 快速理解 `@flatbiz/antd/rule-describe` 的使用方式。

## 模块定位

RuleDescribe：FlatBiz antd 扩展模块。

## 导入方式

```ts
import { RuleDescribe } from '@flatbiz/antd/rule-describe';
// 也可以从主入口导入：import { ... } from '@flatbiz/antd';
```

## 公开导出

- `* from ./rule-describe.jsx`
- `RuleDescribe`
- `RuleDataItem`
- `RuleDescribeProps`

## Props / 配置要点

### RuleDataItem

- `title`（可选）：: string | ReactElement
- `desc`（可选）：: string | ReactElement

### RuleDescribeProps

- `title`（可选）：: string
- `showTitleIndex`（可选）：: boolean
- `ruleDataList`（必填）：: RuleDataItem[]
- `titleSign`（可选）：: boolean
- `className`（可选）：: string
- `ruleItemTitleStyle`（可选）：: CSSProperties
- `ruleItemDescStyle`（可选）：: CSSProperties
- `ruleItemStyle`（可选）：: CSSProperties

## 基础示例

```tsx
import { RuleDescribe, type RuleDescribeProps } from '@flatbiz/antd/rule-describe';

const props: RuleDescribeProps = {
  // 按业务传入必要参数
};

<RuleDescribe {...props} />;
```

## 源码索引

- `src/rule-describe/index.ts`
- `src/rule-describe/rule-describe.tsx`

## 给 LLM 的注意事项

- 优先使用 `@flatbiz/antd/rule-describe` 或主入口 `@flatbiz/antd` 的公开导出，不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时，以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数，请读取上方源码索引中的类型定义和 JSDoc。