# Блок кода

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

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

- Requested language: `ru-RU`

- Content language: `ru-RU`

- Documentation version: `1.2.0`

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

---

#### Package metadata

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

Функция блоков кода позволяет вставлять в документ и отображать в нём форматированные фрагменты кода с подсветкой синтаксиса на базе Prism.js.

## Введение

Блоки кода в Univer Docs позволяют:

* **Вставлять фрагменты кода**: добавлять форматированные блоки кода в любое место документа.
* **Подсвечивать синтаксис**: автоматически выделять элементы кода в зависимости от языка.
* **Выходить из блока и отменять форматирование**: легко завершать или отменять форматирование кода в пустых абзацах.

## Режим плагинов

### Установка

#### npm

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

#### pnpm

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

#### yarn

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

#### bun

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

### Использование

```typescript
import { UniverDocsCodePlugin } from '@univerjs-pro/docs-code' // [!code ++]
import { UniverDocsCodeUIPlugin } from '@univerjs-pro/docs-code-ui' // [!code ++]
import DocsCodeUIEnUS from '@univerjs-pro/docs-code-ui/locale/en-US' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

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

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

univer.registerPlugin(UniverDocsCodePlugin) // [!code ++]
univer.registerPlugin(UniverDocsCodeUIPlugin) // [!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-code-ui` | `UniverDocsCodeUIPlugin` | `UniverDocsCodeMobileUIPlugin` |

## Facade API

Перед использованием API обязательно импортируйте фасад:

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

### Получение всех блоков кода

```typescript
const doc = univerAPI.getActiveDocument()
const codes = doc?.getCodes() ?? []
```

### Вставка блока кода

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

### Выход из блока кода

```typescript
const doc = univerAPI.getActiveDocument()
doc?.exitCode()
```

### Отмена пустого абзаца с кодом

```typescript
const doc = univerAPI.getActiveDocument()
doc?.cancelEmptyCodeParagraph()
```