Installation et utilisation de base
Univer Boards fait partie du Univer Office SDK et est actuellement livré en mode plugin. Cette page couvre l'installation et les étapes nécessaires pour rendre un premier éditeur.
Si vous n'êtes pas familier avec les concepts de base de Univer, lisez d'abord Démarrage rapide.
Univer prend en charge deux modes d'intégration : Preset Mode et Plugin Mode. Preset Mode réduit le travail de configuration en regroupant un ensemble préconfiguré de plugins. Si vous avez besoin de personnalisation profonde ou extensions, le mode Plugin est le choix approprié, car vous combinez et configurez les plugins individuellement.
Configuration en mode plugin
Un éditeur de navigateur enregistre généralement le Univer d'exécution partagé et le plugin de licence d'abord, puis le document et les dépendances de dessin, et enfin le modèle Board et les plugins UI.
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 interface utilisateur avec React et gère les flux de données avec RxJS; il peut également être intégré dans les applications Vue ou Angular. Confirmez que les dépendances react, react-dom et rxjs des pairs1 sont installées. La commande Yarn ci-dessous les énumère explicitement.
Conservez la même version pour tous les packages @univerjs/* et @univerjs-pro/*.
pnpm add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/drawing-ui @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/ink-ui @univerjs-pro/shape-editor-ui @univerjs-pro/boards @univerjs-pro/boards-uinpm install @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/drawing-ui @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/ink-ui @univerjs-pro/shape-editor-ui @univerjs-pro/boards @univerjs-pro/boards-uiyarn add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/drawing-ui @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/ink-ui @univerjs-pro/shape-editor-ui @univerjs-pro/boards @univerjs-pro/boards-ui react react-dom rxjsbun add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/drawing-ui @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/ink-ui @univerjs-pro/shape-editor-ui @univerjs-pro/boards @univerjs-pro/boards-uiUtilisation
Créer le conteneur avant d'initialiser Univer, et lui donner une hauteur explicite:
<div id="app" style="height: 600px"></div>Importez les entrées de façade utilisées sur cette page avant d'appeler FUniver.newAPI(univer). Chargez la @univerjs/design CSS d'abord, puis la @univerjs/ui CSS, et le produit CSS le dernier.
Attention
- Enregistrez
UniverLicensePlugindevant les plugins Board. - Importez les fichiers CSS communs de l’interface avant ceux propres au produit.
- Enregistrez les plugins d'éléments optionnels avant d'ouvrir un instantané qui contient ces types d'éléments.
UniverBoardsUIPluginchargeUniverProFormulaEnginePluginautomatiquement pour les formes. Si la même instanceUniverenregistre égalementUniverFormulaEnginePlugin, installez@univerjs-pro/engine-formulaet remplacez l'importation et l'immatriculation de ce moteur parUniverProFormulaEnginePlugindans le code d'initialisation.
Importez les styles, les packs de paramètres régionaux et les plugins requis :
TypeScriptimport { UniverBoardsPlugin } from '@univerjs-pro/boards'import { UniverBoardsUIPlugin } from '@univerjs-pro/boards-ui'import BoardsUIEnUS from '@univerjs-pro/boards-ui/locale/en-US'import { UniverInkUIPlugin } from '@univerjs-pro/ink-ui'import InkUIEnUS from '@univerjs-pro/ink-ui/locale/en-US'import { UniverLicensePlugin } from '@univerjs-pro/license'import { LocaleType, mergeLocales, Univer, UniverInstanceType } from '@univerjs/core'import DesignEnUS from '@univerjs/design/locale/en-US'import { UniverDocsPlugin } from '@univerjs/docs'import { UniverDocsUIPlugin } from '@univerjs/docs-ui'import DocsUIEnUS from '@univerjs/docs-ui/locale/en-US'import { UniverDrawingPlugin } from '@univerjs/drawing'import { UniverDrawingUIPlugin } from '@univerjs/drawing-ui'import DrawingUIEnUS from '@univerjs/drawing-ui/locale/en-US'import { UniverRenderEnginePlugin } from '@univerjs/engine-render'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/docs-ui/lib/index.css'import '@univerjs/drawing-ui/lib/index.css'import '@univerjs-pro/ink-ui/lib/index.css'import '@univerjs-pro/boards-ui/lib/index.css'Importez l'entrée de façade si la Facade API2 est requise:
TypeScriptimport { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/boards/facade'Créez une instance Univer, enregistrez les plugins et créez une unité Board :
TypeScriptconst univer = new Univer({ locale: LocaleType.EN_US, locales: { [LocaleType.EN_US]: mergeLocales( DesignEnUS, UIEnUS, DocsUIEnUS, DrawingUIEnUS, InkUIEnUS, BoardsUIEnUS, ), },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverDocsPlugin)univer.registerPlugin(UniverDocsUIPlugin)univer.registerPlugin(UniverDrawingPlugin)univer.registerPlugin(UniverDrawingUIPlugin)univer.registerPlugin(UniverInkUIPlugin)univer.registerPlugin(UniverLicensePlugin, { license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverBoardsPlugin)univer.registerPlugin(UniverBoardsUIPlugin)univer.createUnit(UniverInstanceType.UNIVER_BOARD, {})const univerAPI = FUniver.newAPI(univer)
Configuration des plugins
UniverUIPlugin
containerstring | HTMLElementÉlément DOM de montage de l’éditeur ou son identifiant.
UniverLicensePlugin
licensestringContenu du fichier de licence côté client.
Méthodes univer.registerPlugin et univer.registerPlugins
univer.registerPlugin ajoute un plugin à l'instance Univer. Appelez-le après la création de l'instance.
L'appel prend la forme univer.registerPlugin(Plugin, options), où Plugin est le plugin à enregistrer et options la configuration optionnelle qui varie d'un plugin à un autre.
univer.registerPlugins accepte un tableau et enregistre plusieurs plugins en un seul appel, qui conserve la liste des plugins en une seule place.
univer.registerPlugins([ UniverRenderEnginePlugin, [UniverUIPlugin, { container: 'app' }], UniverDocsPlugin, UniverDocsUIPlugin, UniverDrawingPlugin, UniverDrawingUIPlugin, UniverInkUIPlugin, [UniverLicensePlugin, { license: process.env.CLIENT_LICENSE_TEXT, }], UniverBoardsPlugin, UniverBoardsUIPlugin,])FUniver.newAPI(univer) retourne l'objet univerAPI, qui est Univer Facade API. Utilisez-le pour créer des cartes et pour fonctionner sur des éléments de carte.
Prise en charge mobile
Ces exemples nécessitent des paquets SDK exportant les plugins mobiles ci-dessous. Gardez toutes les dépendances @univerjs/* et @univerjs-pro/* à la même version.
1.0.0-rc.0 n’exporte pas UniverBoardsMobileUIPlugin. Utilisez une version compilée incluant cette entrée mobile avant de suivre cet exemple.
Pour les commandes tactiles dans les cartes Univer, utilisez le plugins d'interface utilisateur mobiles.3 Choisissez le mode UI avant de créer l'éditeur.
Dans l'exemple de mode plugin ci-dessus, remplacer ces importations et enregistrements d'interface utilisateur avant createUnit(). Ne les ajoutez pas à un éditeur de bureau qui a déjà commencé. Gardez les modèles plugins, moteurs, fichiers locaux, CSS et importations Facade. Les classes de bureau et mobile sont nommées exportations de même entrée du colis .
UniverMobileUIPlugin
containerstring | HTMLElementÉlément DOM de montage de l’éditeur ou son identifiant.disableAutoFocustrueValeur par défaut:trueEmpêche l'éditeur de se concentrer au démarrage.
import { UniverBoardsMobileUIPlugin } from '@univerjs-pro/boards-ui'import { UniverDocsMobileUIPlugin } from '@univerjs/docs-ui'import { UniverDrawingMobileUIPlugin } from '@univerjs/drawing-ui'import { UniverMobileUIPlugin } from '@univerjs/ui'univer.registerPlugin(UniverMobileUIPlugin, { container: 'app' })univer.registerPlugin(UniverDocsMobileUIPlugin)univer.registerPlugin(UniverDrawingMobileUIPlugin)univer.registerPlugin(UniverBoardsMobileUIPlugin)Correspondance des plugins
Enregistrez seulement les fonctionnalités que vous utilisez, et gardez leurs plugins modèles et dépendances requises. Une exportation d'interface utilisateur mobile ne signifie pas que les interfaces de bureau et mobiles ont les mêmes contrôles. Les fonctionnalités Pro nécessitent toujours la licence appropriée. Si une fonctionnalité a besoin d'un moteur, l'intégrer sur le côté de l'application avec Univer Server SDK.
| Paquet | Inscription de bureau | Inscription mobile |
|---|---|---|
@univerjs/ui | UniverUIPlugin | UniverMobileUIPlugin |
@univerjs/docs-ui | UniverDocsUIPlugin | UniverDocsMobileUIPlugin |
@univerjs/drawing-ui | UniverDrawingUIPlugin | UniverDrawingMobileUIPlugin |
@univerjs-pro/boards-ui | UniverBoardsUIPlugin | UniverBoardsMobileUIPlugin |
@univerjs/thread-comment-ui | UniverThreadCommentUIPlugin | UniverThreadCommentMobileUIPlugin |
@univerjs-pro/shape-editor-ui | UniverShapeEditorUIPlugin | UniverShapeEditorMobileUIPlugin |
@univerjs-pro/chart-ui | UniverChartUIPlugin | UniverChartMobileUIPlugin |
@univerjs-pro/exchange-client | UniverExchangeClientPlugin | UniverExchangeClientMobileUIPlugin |
@univerjs-pro/boards-chart-ui | UniverBoardsChartUIPlugin | UniverBoardsChartMobileUIPlugin |
@univerjs-pro/boards-mind-ui | UniverBoardsMindUIPlugin | UniverBoardsMindMobileUIPlugin |
@univerjs-pro/boards-resources-ui | UniverBoardsResourcesUIPlugin | UniverBoardsResourcesMobileUIPlugin |
@univerjs-pro/boards-table-ui | UniverBoardsTableUIPlugin | UniverBoardsTableMobileUIPlugin |
@univerjs-pro/boards-thread-comment-ui | UniverBoardsThreadCommentUIPlugin | UniverBoardsThreadCommentMobileUIPlugin |
Conteneur et interactions tactiles
Donnez au conteneur une hauteur explicite et configurer le port de vue de la page. 100dvh suit la hauteur du port de vue dynamique. Test de défilement, pincez le zoom, la sélection de texte, l'accès au presse-papiers et le clavier à l'écran dans les navigateurs mobiles cibles.
UniverMobileUIPlugin par défaut sur disableAutoFocus: true, de sorte que l'éditeur ne se concentre pas automatiquement pendant l'initialisation.
<meta name="viewport" content="width=device-width, initial-scale=1" /><div id="app" style="height: 100dvh"></div>Packages de fonctionnalités facultatives
Ajouter un paquet de fonctionnalités lorsque l'éditeur de carte a besoin du type d'élément correspondant:
pnpm add @univerjs-pro/boards-table @univerjs-pro/boards-table-uipnpm add @univerjs-pro/boards-mind @univerjs-pro/boards-mind-uiPour des exemples d'inscription, voir Tableau, Cartes mentales et Importation et exportation.
Autres versions
En plus des versions stables, Univer publie également des canaux alpha et bêta. Ils fournissent un accès précoce aux fonctionnalités qui n'ont pas été expédiées officiellement. Le compromis est plus risqué : ces constructions peuvent contenir des bogues, des fonctionnalités inachevées ou un comportement instable.
Version alpha / beta
Lorsque l'équipe de développement Univer complète une nouvelle fonctionnalité ou un changement significatif, elle peut pré-libérer le travail sur le canal alpha ou bêta. Installez une construction alpha ou bêta d'un paquet Univer avec la commande suivante :
pnpm add @univerjs-pro/boards@alpha # Alpha version
pnpm add @univerjs-pro/boards@beta # Beta versionnpm install @univerjs-pro/boards@alpha # Alpha version
npm install @univerjs-pro/boards@beta # Beta versionyarn add @univerjs-pro/boards@alpha # Alpha version
yarn add @univerjs-pro/boards@beta # Beta versionbun add @univerjs-pro/boards@alpha # Alpha version
bun add @univerjs-pro/boards@beta # Beta versionSi un problème survient avec une construction alpha ou bêta, ou si vous avez des commentaires, signalez-le à l'équipe de développement 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 applicative des plugins enregistrés. Importer une entrée Facade ajoute des méthodes API, mais n’enregistre pas le plugin fonctionnel lui-même. ↩
-
Un plugin UI mobile sélectionne les commandes tactiles et les services mobiles à l’initialisation. Il ne détecte pas automatiquement l’appareil et ne change pas le mode d’une instance lors du redimensionnement. Pour changer de mode, conservez l’état du document, détruisez l’ancienne instance et initialisez les plugins choisis. ↩
Que pensez-vous de ce guide ?