# x-mind-preview LLMs.txt

> 供 LLM 快速理解 `@flatbiz/antd/x-mind-preview` 的使用方式。

## 模块定位

额外的数据，用于使用时自定义渲染

## 导入方式

```ts
import { XMindPreview } from '@flatbiz/antd/x-mind-preview';
// 也可以从主入口导入：import { ... } from '@flatbiz/antd';
```

## 公开导出

- `useCallbackRef`
- `* from ./x-mind-preview.jsx`
- `TXMindTreeItem`
- `XMindPreview`
- `IXMindPreviewProps`

## Props / 配置要点

### TXMindTreeItem

- `data`（可选）：: { text: string; uid: string; extraData?: TPlainObject; }；节点文本
- `children`（必填）：: TXMindTreeItem[]；子节点

### IXMindPreviewProps

- `data`（可选）：: TXMindTreeItem
- `className`（可选）：: string
- `style`（可选）：: CSSProperties
- `renderNode`（可选）：: (node: TXMindTreeItem) => { width?: number; height?: number; reactNode: ReactNode; } | void；自定义节点渲染内容： 默认情况 xmind 会自动计算节点的宽高， 自定义渲染react组件，因为初始拿不到宽高，所以要返回一个节点宽高 - 默认宽高 200 22 - 返回值为空则使用默认渲染 @param node @returns

## 使用规则与行为

- 节点文本
- 全局唯一id
- 额外的数据，用于使用时自定义渲染
- 子节点
- 自定义节点渲染内容： 默认情况 xmind 会自动计算节点的宽高， 自定义渲染react组件，因为初始拿不到宽高，所以要返回一个节点宽高 - 默认宽高 200 22 - 返回值为空则使用默认渲染 @param node @returns
- 防止dom id重复，id在一个组件内需要时唯一的
- 数据更新重置状态
- 只有第一次渲染的时候更新画布位置

## 基础示例

```tsx
import { XMindPreview, type IXMindPreviewProps } from '@flatbiz/antd/x-mind-preview';

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

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

## 源码索引

- `src/x-mind-preview/_hooks/use-callback-ref.tsx`
- `src/x-mind-preview/index.ts`
- `src/x-mind-preview/type.ts`
- `src/x-mind-preview/x-mind-preview.tsx`

## 给 LLM 的注意事项

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