Encadré

Informations sur les plugins

Un callout sépare un morceau d'information du texte environnant. L'icône et les couleurs sont configurables, donc une note, un avertissement et une pointe peuvent chacun avoir une apparence distincte.

Introduction

Dans Univer Docs, les blocs d'appel servent trois objectifs :

  • Ils attirent l'attention sur une note, un avertissement ou un conseil.
  • Ils appliquent l'icône et les couleurs sélectionnées pour le bloc, de sorte que son apparence correspond au contenu.
  • Ils divisent un document en sections qui sont visuellement séparées et lues indépendamment.

Mode plugin

Installation

Shell
pnpm add @univerjs-pro/docs-callout @univerjs-pro/docs-callout-ui

Utilisation

TypeScript
import { UniverDocsCalloutPlugin } from '@univerjs-pro/docs-callout'import { UniverDocsCalloutUIPlugin } from '@univerjs-pro/docs-callout-ui'import DocsCalloutUIEnUS from '@univerjs-pro/docs-callout-ui/locale/en-US'import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import '@univerjs-pro/docs-callout-ui/lib/index.css'const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      DocsCalloutUIEnUS,     ),  },})univer.registerPlugin(UniverDocsCalloutPlugin)univer.registerPlugin(UniverDocsCalloutUIPlugin)

Si votre application utilise Univer sous une licence commerciale, configurez-la comme décrit dans Utilisation de la licence dans le client.

Prise en charge mobile

Configurez d'abord le éditeur mobile. Dans la configuration en mode plugin de cette page, remplacez les enregistrements de bureau énumérés ci-dessous par les exportations mobiles des mêmes paquets, et faites le remplacement avant d'ouvrir un document . Gardez les modèles plugins, styles, locaux et importations Facade, et ne enregistrez pas les deux variantes.

PaquetInscription de bureauInscription mobile
@univerjs-pro/docs-callout-uiUniverDocsCalloutUIPluginUniverDocsCalloutMobileUIPlugin

API Facade

Importez la façade avant d'appeler 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 sont appliquées par les commandes document, de sorte qu'ils soient annulés, refaits et que la collaboration les reçoive. setTextColor() applique une couleur à tous les textes de l'appel; appelez resetTextColor() pour supprimer cette suppression et restaurer les couleurs texte héritées du document.

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

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.