# @univerjs-pro/boards-mind

[![npm version](https://img.shields.io/npm/v/@univerjs-pro/boards-mind?style=flat-square)](https://npmjs.com/package/@univerjs-pro/boards-mind)
[![downloads](https://img.shields.io/npm/dm/@univerjs-pro/boards-mind?style=flat-square)](https://npmjs.com/package/@univerjs-pro/boards-mind)

`@univerjs-pro/boards-mind` provides the mind map model, commands, mutations, layout helpers, and OPML representation for Univer Board.

## Package Overview

| Package | UMD global | CSS | Locales | Facade entry |
| --- | --- | :---: | :---: | :---: |
| `@univerjs-pro/boards-mind` | `UniverProBoardsMind` | No | No | No |

## Capabilities

- Registers mind map insertion, node editing, layout, copy and paste, reparenting, collapse, promotion, detach, and translation operations.
- Provides `SetMindMapElementMutation` for applying mind map element changes through the board command pipeline.
- Exposes factories for creating mind map containers, nodes, connectors, and full mind map element groups.
- Provides intrinsic size helpers for mind map nodes so text-driven resizing can stay consistent with board rendering.
- Supports OPML import and export for mind map representations.

## Installation

```sh
pnpm add @univerjs-pro/boards-mind
# or
npm install @univerjs-pro/boards-mind
```

Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.

## Usage

```ts
import { UniverBoardsPlugin } from '@univerjs-pro/boards';
import { UniverBoardsMindPlugin } from '@univerjs-pro/boards-mind';

univer.registerPlugin(UniverBoardsPlugin);
univer.registerPlugin(UniverBoardsMindPlugin);
```

## Integration Notes

Use this package for headless mind map data and command support on boards. Register `@univerjs-pro/boards-mind-ui` when users need toolbar entry points, node controls, floating toolbar UI, drag topology feedback, or the mind map side panel.

## Resources

- [Documentation](https://docs.univer.ai/guides/pro)
- [NPM package](https://npmjs.com/package/@univerjs-pro/boards-mind)