# 标注块

- Human documentation: [https://docs.univer.ai/zh-CN/guides/docs/features/callout](https://docs.univer.ai/zh-CN/guides/docs/features/callout)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/docs/features/callout.md](https://docs.univer.ai/zh-CN/guides/docs/features/callout.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

- Source: [docs/features/callout.zh-CN.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/callout.zh-CN.mdx)

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs-pro/docs-callout",
      "facade": "@univerjs-pro/docs-callout/facade"
    },
    {
      "client": "@univerjs-pro/docs-callout-ui",
      "locale": "@univerjs-pro/docs-callout-ui/locale/zh-CN",
      "style": "@univerjs-pro/docs-callout-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

标注块功能允许您在文档中以视觉上醒目的区块高亮显示重要信息，并支持自定义图标和颜色。

## 介绍

在 Univer Docs 中，标注块使您能够：

* **高亮关键信息**：吸引读者对重要说明、警告或提示的注意。
* **自定义外观**：选择不同的图标和配色方案以匹配您的内容。
* **组织内容**：用视觉分隔的区块来结构化您的文档。

## 插件模式

### 安装

#### npm

```bash
npm install @univerjs-pro/docs-callout @univerjs-pro/docs-callout-ui
```

#### pnpm

```bash
pnpm add @univerjs-pro/docs-callout @univerjs-pro/docs-callout-ui
```

#### yarn

```bash
yarn add @univerjs-pro/docs-callout @univerjs-pro/docs-callout-ui
```

#### bun

```bash
bun add @univerjs-pro/docs-callout @univerjs-pro/docs-callout-ui
```

### 使用

```typescript
import { UniverDocsCalloutPlugin } from '@univerjs-pro/docs-callout' // [!code ++]
import { UniverDocsCalloutUIPlugin } from '@univerjs-pro/docs-callout-ui' // [!code ++]
import DocsCalloutUIZhCN from '@univerjs-pro/docs-callout-ui/locale/zh-CN' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

import '@univerjs-pro/docs-callout-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      DocsCalloutUIZhCN, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverDocsCalloutPlugin) // [!code ++]
univer.registerPlugin(UniverDocsCalloutUIPlugin) // [!code ++]
```

如果您拥有 Univer 商业许可证，请参阅[在客户端使用许可证](https://docs.univer.ai/zh-CN/guides/license.md#in-plugin-mode)进行配置。

## Facade API

使用 API 前请确保已导入 facade：

```typescript
import '@univerjs-pro/docs-callout/facade'
```

### 获取所有标注块

```typescript
const doc = univerAPI.getActiveDocument()
const callouts = doc?.getCallouts() ?? []
```

### 根据 ID 获取标注块

```typescript
const doc = univerAPI.getActiveDocument()
const callout = doc?.getCallout('callout-block-id')
```

### 插入标注块

```typescript
const doc = univerAPI.getActiveDocument()
const callout = doc?.insertCallout({
  startOffset: 12,
  endOffset: 35,
  config: { icon: '💡' },
})
```

### 更新标注块配置

```typescript
const callout = univerAPI.getActiveDocument()?.getCallout('callout-block-id')
callout?.updateConfig({ icon: '⚠️' })
```

### 设置标注块外观

```typescript
const callout = univerAPI.getActiveDocument()?.getCallout('callout-block-id')
callout?.setIcon('📝')
callout?.setBackgroundColor('#FFF4E5')
callout?.setBorder({ color: '#E6A23C', width: 2 })
callout?.setTextColor('#5C3B00')
```