Installation et utilisation de base

Cette page décrit comment installer Univer Bases et comment l'exécuter après l'installation. Bases est distribué comme un produit Univer Office SDK et utilise actuellement le mode plugin.

Si les concepts de base de Univer ne sont pas familiers, lisez d'abord Démarrage rapide.

Univer prend en charge deux modes d'intégration : Preset Mode et Plugin Mode. Preset Mode précombine les plugins et réduit le travail de configuration. Si vous avez besoin de personnalisation profonde ou extensions, utilisez le mode Plugin pour que vous puissiez sélectionner et configurer les plugins individuellement.

Configuration en mode plugin

Une application de base de navigateur enregistre généralement l'exécution partagée Univer, le moteur de rendu, le shell UI, le moteur formule, et la licence d'abord, puis le modèle Bases et les plugins UI.

Utilisation d’un gestionnaire de packages

Utilisez un outil de compilation compatible avec les modules ES et le champ exports de package.json.

Installation

Univer construit son UI avec React et utilise RxJS pour les flux de données, et il peut également être intégré dans les applications Vue ou Angular. Assurez-vous que les dépendances react, react-dom et rxjs des pairs1 sont installées. La commande Yarn ci-dessous les ajoute explicitement.

Conserver tous les paquets @univerjs/* et @univerjs-pro/* sur la même version.

Shell
pnpm add @univerjs/core @univerjs/design @univerjs/engine-render @univerjs/ui @univerjs-pro/bases @univerjs-pro/bases-ui @univerjs-pro/engine-formula @univerjs-pro/license

Utilisation

Créer le conteneur avec une hauteur explicite avant d'initialiser Univer:

HTML
<div id="app" style="height: 600px"></div>

Importez les entrées de façade utilisées ci-dessous 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

  • Enregistrer UniverLicensePlugin avant les plugins Bases.
  • Importez les styles CSS de l’interface utilisateur partagée avant ceux de l’interface du produit.
  • Utilisez UniverProFormulaEnginePlugin de @univerjs-pro/engine-formula pour les bases, y compris les formes de tableau de bord. Si vous combinez des produits dans une instance Univer, remplacez toute importation et enregistrement UniverFormulaEnginePlugin au lieu d'enregistrer les deux moteurs de formule.
  1. Importez les styles, les packs locaux et les plugins dont vous avez besoin :

    TypeScript
    import { UniverBasesPlugin } from '@univerjs-pro/bases'import { UniverBasesUIPlugin } from '@univerjs-pro/bases-ui'import BasesUIEnUS from '@univerjs-pro/bases-ui/locale/en-US'import BasesEnUS from '@univerjs-pro/bases/locale/en-US'import { UniverProFormulaEnginePlugin } from '@univerjs-pro/engine-formula'import { UniverLicensePlugin } from '@univerjs-pro/license'import { LocaleType, mergeLocales, Univer, UniverInstanceType } from '@univerjs/core'import DesignEnUS from '@univerjs/design/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-pro/bases-ui/lib/index.css'
  2. Importez les entrées de façade si vous envisagez d'utiliser Facade API2:

    TypeScript
    import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/bases/facade'import '@univerjs-pro/bases-ui/facade'
  3. Créez une instance Univer, enregistrez les plugins et créez une unité de base :

    TypeScript
    const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      DesignEnUS,      UIEnUS,      BasesEnUS,      BasesUIEnUS,    ),  },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverProFormulaEnginePlugin)univer.registerPlugin(UniverLicensePlugin, {  license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverBasesPlugin)univer.registerPlugin(UniverBasesUIPlugin)univer.createUnit(UniverInstanceType.UNIVER_BASE, {})const univerAPI = FUniver.newAPI(univer)

Configuration des plugins

UniverUIPlugin

  • container
    string | HTMLElement
    Élément DOM de montage de l’éditeur ou son identifiant.

UniverLicensePlugin

  • license
    string
    Contenu du fichier de licence côté client.

Méthodes univer.registerPlugin et univer.registerPlugins

univer.registerPlugin enregistre un plugin sur une instance Univer. Appelez-le après la création de l'instance.

La signature est univer.registerPlugin(Plugin, options). Plugin est le plugin à enregistrer, et options constitue un objet de configuration optionnel. Chaque plugin définit ses propres options.

univer.registerPlugins prend un tableau et enregistre plusieurs plugins en un seul appel. Utilisez-le pour garder l'enregistrement de plugin en un seul endroit.

TypeScript
univer.registerPlugins([  UniverRenderEnginePlugin,  [UniverUIPlugin, { container: 'app' }],  UniverProFormulaEnginePlugin,  [UniverLicensePlugin, {    license: process.env.CLIENT_LICENSE_TEXT,  }],  UniverBasesPlugin,  UniverBasesUIPlugin,])

Prise en charge mobile

Le paquet @univerjs-pro/bases-ui actuel n'exporte pas un plugin d'interface mobile dédié. Ni une importation MobileUIPlugin ni une option mobile: true n'existe, donc n'en écrivez pas. Un conteneur étroit ne démontre pas un support tactile complet; testez l'interface utilisateur existante sur les appareils cibles.

Autres versions

En plus des versions stables, Univer publie des canaux alpha et bêta. Ces canaux vous permettent d'essayer de nouvelles fonctionnalités avant leur sortie officielle. De nouvelles fonctionnalités comportent également des risques : ces constructions peuvent contenir des bogues, des fonctionnalités incomplètes ou des fonctionnalités instables, donc évitez-les dans la production lorsque c'est possible.

Version alpha / beta

Lorsque l'équipe Univer complète une nouvelle fonctionnalité ou un changement significatif, elle peut publier une pré-publication sur le canal alpha ou bêta. Installez une compilation alpha ou bêta d'un paquet Univer avec ces commandes :

Shell
pnpm add @univerjs-pro/bases@alpha # Alpha version
pnpm add @univerjs-pro/bases@beta # Beta version

Si vous rencontrez un problème ou si vous avez des commentaires lors d'une construction alpha ou bêta, signalez-le à l'équipe Univer via GitHub Problèmes.

Étapes suivantes

Footnotes

  1. Les peerDependencies sont 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. ↩

  2. 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. ↩

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.