# 引用块

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

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

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

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

---

#### Package metadata

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

引用块功能允许您在文档中插入和格式化引用文本，并应用与普通内容不同的视觉样式。

## 介绍

在 Univer Docs 中，引用块使您能够：

* **格式化引用文本**：为引文应用独特的样式。
* **嵌套内容**：在引用块中包含富文本内容。
* **轻松退出**：快速从空段落退出引用格式。

## 插件模式

### 安装

#### npm

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

#### pnpm

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

#### yarn

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

#### bun

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

### 使用

```typescript
import { UniverDocsQuotePlugin } from '@univerjs-pro/docs-quote' // [!code ++]
import { UniverDocsQuoteUIPlugin } from '@univerjs-pro/docs-quote-ui' // [!code ++]
import DocsQuoteUIZhCN from '@univerjs-pro/docs-quote-ui/locale/zh-CN' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

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

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

univer.registerPlugin(UniverDocsQuotePlugin) // [!code ++]
univer.registerPlugin(UniverDocsQuoteUIPlugin) // [!code ++]
```

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

## Facade API

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

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

### 获取所有引用块

```typescript
const doc = univerAPI.getActiveDocument()
const quotes = doc?.getQuotes() ?? []
```

### 插入引用块

```typescript
const doc = univerAPI.getActiveDocument()
const quote = doc?.insertQuote({
  startOffset: 12,
  endOffset: 35,
})
```

### 设置引用线颜色

```typescript
const quote = univerAPI.getActiveDocument()?.getQuote('quote-block-id')
quote?.setLineColor('#5B5FC7')
```

### 设置引用文字颜色

```typescript
const quote = univerAPI.getActiveDocument()?.getQuote('quote-block-id')
quote?.setTextColor('#242424')
```