Blocs de code
Un bloc de code place le code formaté à l'intérieur d'un document. Syntaxe mise en évidence est fourni par Prism.js.
Introduction
Dans Univer Docs, les blocs de code répondent à quelques besoins communs :
- Un bloc de code formaté peut être inséré n'importe où dans le document.
- Le code est mis en surbrillance automatiquement selon sa langue.
- Un paragraphe de code vide permet à l'utilisateur de quitter le bloc ou d'annuler le formatage du code.
Mode plugin
Installation
pnpm add @univerjs-pro/docs-code @univerjs-pro/docs-code-uinpm install @univerjs-pro/docs-code @univerjs-pro/docs-code-uiyarn add @univerjs-pro/docs-code @univerjs-pro/docs-code-uibun add @univerjs-pro/docs-code @univerjs-pro/docs-code-uiUtilisation
import { UniverDocsCodePlugin } from '@univerjs-pro/docs-code'import { UniverDocsCodeUIPlugin } from '@univerjs-pro/docs-code-ui'import DocsCodeUIEnUS from '@univerjs-pro/docs-code-ui/locale/en-US'import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import '@univerjs-pro/docs-code-ui/lib/index.css'const univer = new Univer({ locale: LocaleType.EN_US, locales: { [LocaleType.EN_US]: mergeLocales( DocsCodeUIEnUS, ), },})univer.registerPlugin(UniverDocsCodePlugin)univer.registerPlugin(UniverDocsCodeUIPlugin)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.
| Paquet | Inscription de bureau | Inscription mobile |
|---|---|---|
@univerjs-pro/docs-code-ui | UniverDocsCodeUIPlugin | UniverDocsCodeMobileUIPlugin |
API Facade
Importez la façade avant d'appeler ces méthodes:
import '@univerjs-pro/docs-code/facade'Obtenir tous les blocs de code
const doc = univerAPI.getActiveDocument()const codes = doc?.getCodes() ?? []Insérer un bloc de code
const doc = univerAPI.getActiveDocument()const code = doc?.insertCode({ startOffset: 12, endOffset: 35,})Quitter un bloc de code
const doc = univerAPI.getActiveDocument()doc?.exitCode()Annuler un paragraphe de code vide
const doc = univerAPI.getActiveDocument()doc?.cancelEmptyCodeParagraph()Polices à chasse fixe pour le code
Le sélectionneur de polices dans la barre d'outils de bloc de code ne liste que les polices enregistrées avec FontCategory.MONOSPACE. La sélection d'une police l'applique à l'ensemble du bloc de code, y compris ses styles de paragraphes.
Pour enregistrer une police monospaced personnalisée, appelez addFonts() :
import { FontCategory } from '@univerjs/ui'import '@univerjs/ui/facade'univerAPI.addFonts([ { value: 'JetBrains Mono', label: 'JetBrains Mono', category: FontCategory.MONOSPACE },])L'enregistrement ajoute seulement une entrée au sélecteur. Le fichier de police lui-même doit être chargé avec CSS ou l'API FontFace du navigateur, comme décrit dans polices personnalisées. Cette méthode fonctionne avec le plugin et l'initialisation prédéfinie.
Que pensez-vous de ce guide ?