# text-overflow LLMs.txt

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

## 模块定位

内容溢出截取，并在尾部添加...，被截取的添加Tooltip显示完整数据

## 导入方式

```ts
import { TextOverflow } from '@flatbiz/antd/text-overflow';
// 也可以从主入口导入：import { ... } from '@flatbiz/antd';
```

## 公开导出

- `* from ./text-overflow.jsx`
- `OverflowAuto`
- `OverflowLength`
- `OverflowWidth`
- `TextOverflow` - 内容溢出截取，并在尾部添加...，被截取的添加Tooltip显示完整数据
- `TextOverflowProps`

## 依赖的 antd 能力

`Tooltip`

## Props / 配置要点

### TextOverflowProps

- `text`（必填）：: string | ReactElement；text 为ReactElement类型时，maxLength配置无效
- `maxWidth`（可选）：: number；最大显示宽度
- `maxLength`（可选）：: number；最大显示字数
- `hideTip`（可选）：: boolean；关闭tooltip功能 文字超出后，鼠标移入，不展示全部文字
- `onClick`（可选）：: (e) => void
- `className`（可选）：: string

## 使用规则与行为

- 内容溢出截取，并在尾部添加...，被截取的添加Tooltip显示完整数据
- text 为ReactElement类型时，maxLength配置无效
- 最大显示宽度
- 最大显示字数
- 关闭tooltip功能 文字超出后，鼠标移入，不展示全部文字

## 基础示例

```tsx
import { TextOverflow, type TextOverflowProps } from '@flatbiz/antd/text-overflow';

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

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

## 源码索引

- `src/text-overflow/index.ts`
- `src/text-overflow/overflow-auto.tsx`
- `src/text-overflow/overflow-length.tsx`
- `src/text-overflow/overflow-width.tsx`
- `src/text-overflow/text-overflow.tsx`
- `src/text-overflow/types.ts`

## 给 LLM 的注意事项

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