# コードブロック

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

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

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.1.0`

- Source: [docs/features/code.ja-JP.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/code.ja-JP.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/ja-JP",
      "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 DocsCodeUIJaJP from '@univerjs-pro/docs-code-ui/locale/ja-JP' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

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

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

univer.registerPlugin(UniverDocsCodePlugin) // [!code ++]
univer.registerPlugin(UniverDocsCodeUIPlugin) // [!code ++]
```

Univer の商用ライセンスをお持ちの場合は、[クライアントでのライセンス使用](https://docs.univer.ai/ja-JP/server/license.md#in-plugin-mode)を参照してください。

## モバイル対応

まず[モバイルエディター](https://docs.univer.ai/ja-JP/guides/docs/getting-started/installation.md#mobile-support)を設定します。このページのプラグインモードの初期化コードで、以下のデスクトップ登録を同じパッケージのモバイル版に置き換え、**文書を開く前に**完了してください。モデル、スタイル、言語ファイル、Facade は維持し、両方を同時に登録しないでください。

| パッケージ                        | デスクトップの登録                | モバイルの登録                        |
| ---------------------------- | ------------------------ | ------------------------------ |
| `@univerjs-pro/docs-code-ui` | `UniverDocsCodeUIPlugin` | `UniverDocsCodeMobileUIPlugin` |

## Facade API

API を使用する前に facade をインポートしてください：

```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()
```