# Выноски

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

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

- Requested language: `ru-RU`

- Content language: `ru-RU`

- Documentation version: `1.2.0`

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

---

#### Package metadata

```json
{
  "mobile": true,
  "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/ru-RU",
      "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 DocsCalloutUIEnUS from '@univerjs-pro/docs-callout-ui/locale/en-US' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

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

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

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

Если у вас есть коммерческая лицензия Univer, ознакомьтесь с разделом [Использование лицензии в клиенте](https://docs.univer.ai/ru-RU/server/license.md#in-plugin-mode), чтобы настроить её.

## Поддержка мобильных устройств

Сначала настройте [мобильный редактор](https://docs.univer.ai/ru-RU/guides/docs/getting-started/installation.md#mobile-support). В коде инициализации режима плагинов на этой странице замените указанные настольные регистрации мобильными экспортами тех же пакетов **до открытия документа**. Сохраните модели, стили, локализации и импорты Facade; не регистрируйте оба варианта.

| Пакет                           | Настольная регистрация      | Мобильная регистрация             |
| ------------------------------- | --------------------------- | --------------------------------- |
| `@univerjs-pro/docs-callout-ui` | `UniverDocsCalloutUIPlugin` | `UniverDocsCalloutMobileUIPlugin` |

## 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')
```

Внешний вид Callout изменяется командами документа с отменой, повтором и совместной работой. `setTextColor()` задаёт цвет всего текста блока; `resetTextColor()` снимает переопределение и восстанавливает цвета, унаследованные от документа.

```ts
const callout = univerAPI.getActiveDocument()?.getCallout('callout-block-id')
callout?.resetTextColor()
```