# text-symbol-wrapper LLMs.txt

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

## 模块定位

为文字添加符号，例如：必填符号

## 导入方式

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

## 公开导出

- `* from ./symbol.jsx`
- `TextSymbolWrapper` - 为文字添加符号，例如：必填符号
- `TextSymbolWrapperProps`

## Props / 配置要点

### TextSymbolWrapperProps

- `className`（可选）：: string
- `style`（可选）：: CSSProperties
- `symbolType`（可选）：: 'required'；内置图标类型
- `symbol`（可选）：: ReactNode；自定义标记符号，优先级大于 symbolType
- `position`（可选）：: 'before' | 'after'；标记位置，默认：brefore
- `text`（可选）：: string | ReactElement；显示文本
- `symbolStyle`（可选）：: CSSProperties
- `onSymbolClick`（可选）：: (event) => void
- `hiddenSymbol`（可选）：: boolean；只隐藏符号，不隐藏文案
- `gap`（可选）：: number；图标与文字之间的间距

## 使用规则与行为

- 内置图标类型
- 自定义标记符号，优先级大于 symbolType
- 标记位置，默认：brefore
- 显示文本
- 只隐藏符号，不隐藏文案
- 图标与文字之间的间距
- 为文字添加符号，例如：必填符号

## 默认值线索

- `gap => 3`

## 基础示例

```tsx
import { TextSymbolWrapper, type TextSymbolWrapperProps } from '@flatbiz/antd/text-symbol-wrapper';

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

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

## 源码索引

- `src/text-symbol-wrapper/index.ts`
- `src/text-symbol-wrapper/symbol.tsx`

## 给 LLM 的注意事项

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