# コールアウト

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

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

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.2.0`

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

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

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

univer.registerPlugin(UniverDocsCalloutPlugin) // [!code ++]
univer.registerPlugin(UniverDocsCalloutUIPlugin) // [!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-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')
```

コールアウトの外観変更は文書コマンドを通り、履歴と共同編集に対応します。`setTextColor()` は内部の全テキストに色を設定します。`resetTextColor()` で上書きを取り除き、文書から継承した文字色に戻します。

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