Installation et utilisation de base
Univer PDFs fait partie du Univer Office SDK et ne fournit pas encore de préréglage, donc une application PDF est assemblée en mode plugin.
Univer prend en charge deux modes d'intégration : le mode préréglé et le mode plugin. Le mode prérégulé fournit un paquet préconfiguré de plugins, ce qui réduit la quantité de câblage. Si vous avez besoin de personnalisation profonde ou extensions, utilisez le mode plugin, où chaque plugin est sélectionné et configuré individuellement.
Configuration en mode plugin
Utilisation d’un gestionnaire de packages
L'outil de construction doit prendre en charge les modules ES et le champ exports dans package.json.
Installation
Univer construit son UI avec React et ses flux de données avec RxJS, et il peut également être intégré dans une application Vue ou Angular. Vérifiez que les dépendances react, react-dom et rxjs des pairs1 sont installées. La commande Yarn ci-dessous les ajoute explicitement.
Conservez la même version pour tous les packages @univerjs/* et @univerjs-pro/*.
pnpm add @univerjs/core @univerjs/design @univerjs/ui @univerjs-pro/license @univerjs-pro/pdfs @univerjs-pro/pdfs-uinpm install @univerjs/core @univerjs/design @univerjs/ui @univerjs-pro/license @univerjs-pro/pdfs @univerjs-pro/pdfs-uiyarn add @univerjs/core @univerjs/design @univerjs/ui @univerjs-pro/license @univerjs-pro/pdfs @univerjs-pro/pdfs-ui react react-dom rxjsbun add @univerjs/core @univerjs/design @univerjs/ui @univerjs-pro/license @univerjs-pro/pdfs @univerjs-pro/pdfs-uiConservez tous les packages @univerjs/* et @univerjs-pro/* à la même version.
Utilisation
Créer le conteneur avec une hauteur explicite avant d'initialiser Univer:
<div id="app" style="height: 600px"></div>Importez les entrées de façade utilisées ci-dessous avant d'appeler FUniver.newAPI(univer). Importez d'abord @univerjs/design CSS, puis @univerjs/ui SCC et le produit CSS.
Importez les styles d'interface utilisateur partagés avant le style d'interface UI PDF, et fusionnez les paquets locaux que l'application permet:
TypeScriptimport { UniverLicensePlugin } from '@univerjs-pro/license'import { UniverPdfsPlugin } from '@univerjs-pro/pdfs'import { UniverPdfsUIPlugin } from '@univerjs-pro/pdfs-ui'import PdfsUIEnUS from '@univerjs-pro/pdfs-ui/locale/en-US'import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import { FUniver } from '@univerjs/core/facade'import DesignEnUS from '@univerjs/design/locale/en-US'import { UniverUIPlugin } from '@univerjs/ui'import UIEnUS from '@univerjs/ui/locale/en-US'import '@univerjs/design/lib/index.css'import '@univerjs/ui/lib/index.css'import '@univerjs-pro/pdfs-ui/lib/index.css'Importez l'entrée PDF Facade2. Cette importation d'effets secondaires ajoute les méthodes et les enums PDF à
FUniver:TypeScriptimport '@univerjs-pro/pdfs/facade'Créez l'environnement d'exécution, enregistrez explicitement l'ensemble des plugins, puis créez un PDF :
TypeScriptconst univer = new Univer({ locale: LocaleType.EN_US, locales: { [LocaleType.EN_US]: mergeLocales( DesignEnUS, UIEnUS, PdfsUIEnUS, ), },})univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverLicensePlugin, { license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverPdfsPlugin)univer.registerPlugin(UniverPdfsUIPlugin)const univerAPI = FUniver.newAPI(univer)univerAPI.createPdf({ name: 'Untitled PDF' })
Configuration des plugins
UniverUIPlugin
containerstring | HTMLElementÉlément DOM où monter l’éditeur, ou son identifiant.
UniverLicensePlugin
licensestringContenu du fichier de licence client.
Méthodes univer.registerPlugin et univer.registerPlugins
Après la création de l'instance Univer, appelez univer.registerPlugin pour y enregistrer un plugin.
L'appel a le formulaire univer.registerPlugin(Plugin, options). Plugin est le plugin à enregistrer et options constitue un objet de configuration optionnel. Chaque plugin définit ses propres options.
Pour enregistrer plusieurs plugins à la fois, passez un tableau à univer.registerPlugins. Cela maintient la gestion des plugins en un seul endroit.
univer.registerPlugins([ [UniverUIPlugin, { container: 'app' }], [UniverLicensePlugin, { license: process.env.CLIENT_LICENSE_TEXT, }], UniverPdfsPlugin, UniverPdfsUIPlugin,])Prise en charge mobile
Le paquet @univerjs-pro/pdfs-ui actuel n'exporte pas un plugin d'interface mobile dédié. Il ne fournit ni une importation MobileUIPlugin ni une option mobile: true, donc n'essayez pas d'utiliser non plus. Un conteneur étroit ne prouve pas que le support tactile est complet; évalue l'interface utilisateur existante sur les appareils cibles.
Worker de miniatures facultatif
Les vignettes de page rendent sur le thread principal sans configuration supplémentaire. Pour les documents plus grands, les transmettre à un travailleur de module dédié via thumbnailWorkerURL.
Créez un point d'entrée de worker tel que pdf-thumbnail.worker.ts :
import { UniverPdfsUIWorkerPlugin } from '@univerjs-pro/pdfs-ui/worker'import { Univer } from '@univerjs/core'const univer = new Univer()univer.registerPlugin(UniverPdfsUIWorkerPlugin)Passez l'URL du travailleur lors de l'enregistrement du plugin PDF UI:
UniverPdfsUIPlugin
thumbnailWorkerURLstring | URL | WorkerGénère les miniatures des pages dans un Worker du navigateur.
univer.registerPlugin(UniverPdfsUIPlugin, { thumbnailWorkerURL: new Worker(new URL('./pdf-thumbnail.worker.ts', import.meta.url), { type: 'module' }),})L'option accepte également une URL sous forme de chaîne ou un Worker existant. Si les workers ou OffscreenCanvas ne sont pas disponibles, l'affichage des miniatures revient au thread principal.
Édition collaborative
@univerjs-pro/pdfs-editor ne fait pas partie d'une pile locale seulement, et il ne peut pas fonctionner indépendamment. Installez et enregistrez la pile complète @univerjs-pro/collaboration, @univerjs-pro/collaboration-client et @univerjs-pro/collaboration-client-ui comme décrit dans Collaboration puis installez et enregistrez le plugin du cycle de vie de l'éditeur PDF.
Utilisation avec Node.js
Un service Node.js peut enregistrer UniverPdfsPlugin sans aucun paquet d'interface utilisateur de navigateur. Ajoutez la pile de collaboration au-dessus seulement lorsque le service doit charger ou synchroniser des unités PDF persistantes.
Autres versions
Outre les versions stables, Univer maintient des canaux alpha et bêta qui fournissent un accès aux fonctionnalités qui ne sont pas encore officiellement publiées. Plus de fonctionnalités signifient aussi plus de risque : ces versions peuvent contenir des bugs, des fonctionnalités incomplètes ou des fonctionnalités instables, donc évitez-les dans la production si possible.
Version alpha / beta
Lorsque l'équipe Univer complète une nouvelle fonctionnalité ou un changement significatif, elle peut pré-libérer le changement vers le canal alpha ou bêta. Installez une version alpha ou bêta d'un paquet avec :
pnpm add @univerjs-pro/pdfs@alpha # Alpha version
pnpm add @univerjs-pro/pdfs@beta # Beta versionnpm install @univerjs-pro/pdfs@alpha # Alpha version
npm install @univerjs-pro/pdfs@beta # Beta versionyarn add @univerjs-pro/pdfs@alpha # Alpha version
yarn add @univerjs-pro/pdfs@beta # Beta versionbun add @univerjs-pro/pdfs@alpha # Alpha version
bun add @univerjs-pro/pdfs@beta # Beta versionSi un problème survient ou si vous avez des commentaires lors de l'utilisation d'une version alpha ou bêta, signalez-le à l'équipe Univer par l'intermédiaire de GitHub Problèmes.
Étapes suivantes
Footnotes
-
Les
peerDependenciessont des dépendances que l’application hôte doit fournir dans une version compatible. Elles permettent de partager des bibliothèques comme React avec Univer. ↩ -
Facade est l'API face à l'application sur les plugins enregistrés. Importer une entrée Facade ajoute des méthodes d'API; il n'enregistre pas le plugin de fonctionnalité lui-même. ↩
Que pensez-vous de ce guide ?