# Encadré

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

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

- Requested language: `fr-FR`

- Content language: `fr-FR`

- Documentation version: `1.2.0`

- Source: [docs/features/callout.fr-FR.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/callout.fr-FR.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/fr-FR",
      "style": "@univerjs-pro/docs-callout-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

La fonctionnalité d’encadré permet de mettre en valeur les informations importantes d’un document dans des blocs visuellement distincts, avec des icônes et des couleurs personnalisables.

## Introduction

Dans Univer Docs, les encadrés permettent de :

* **Mettre en valeur les informations clés** : attirer l’attention sur des remarques, des avertissements ou des conseils importants.
* **Personnaliser l’apparence** : choisir parmi différentes icônes et palettes de couleurs en fonction du contenu.
* **Organiser le contenu** : structurer le document à l’aide de sections visuellement séparées.

## Mode plugin

### Installation

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

### Utilisation

```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 ++]
```

Si vous disposez d’une licence commerciale Univer, consultez la page [Utiliser une licence côté client](https://docs.univer.ai/fr-FR/server/license.md#in-plugin-mode) pour savoir comment la configurer.

## Prise en charge mobile

Configurez d’abord l’[éditeur mobile](https://docs.univer.ai/fr-FR/guides/docs/getting-started/installation.md#mobile-support). Dans l’initialisation en mode plugin de cette page, remplacez les inscriptions de bureau ci-dessous par les exports mobiles des mêmes paquets **avant d’ouvrir un document**. Conservez modèles, styles, traductions et imports Facade ; n’enregistrez pas les deux variantes.

| Paquet                          | Inscription de bureau       | Inscription mobile                |
| ------------------------------- | --------------------------- | --------------------------------- |
| `@univerjs-pro/docs-callout-ui` | `UniverDocsCalloutUIPlugin` | `UniverDocsCalloutMobileUIPlugin` |

## API Facade

Veillez à importer la façade avant d’utiliser l’API :

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

### Obtenir tous les encadrés

```typescript
const doc = univerAPI.getActiveDocument()
const callouts = doc?.getCallouts() ?? []
```

### Obtenir un encadré par son ID

```typescript
const doc = univerAPI.getActiveDocument()
const callout = doc?.getCallout('callout-block-id')
```

### Insérer un encadré

```typescript
const doc = univerAPI.getActiveDocument()
const callout = doc?.insertCallout({
  startOffset: 12,
  endOffset: 35,
  config: { icon: '💡' },
})
```

### Mettre à jour la configuration d’un encadré

```typescript
const callout = univerAPI.getActiveDocument()?.getCallout('callout-block-id')
callout?.updateConfig({ icon: '⚠️' })
```

### Définir l’apparence d’un encadré

```typescript
const callout = univerAPI.getActiveDocument()?.getCallout('callout-block-id')
callout?.setIcon('📝')
callout?.setBackgroundColor('#FFF4E5')
callout?.setBorder({ color: '#E6A23C', width: 2 })
callout?.setTextColor('#5C3B00')
```

Les modifications d’apparence des Callouts passent par les commandes du document et prennent en charge l’historique et la collaboration. `setTextColor()` colore tout le texte du bloc ; `resetTextColor()` supprime cette surcharge et restaure la couleur héritée du document.

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