API générale
Les API Facade disponibles dans Univer dépendent du type d'unité actuel et des plugins enregistrés dans l'application. Cette page décrit les API les plus fréquemment utilisées dans une application Docs.
Importation
import { FUniver } from '@univerjs/core/facade'const univerAPI = FUniver.newAPI(univer)Commandes
La plupart des opérations de Univer sont exécutées par le système de commande. Ce chemin d'exécution unifié supporte l'annulation, le redécoupage et la collaboration.
Pour la conception du système de commande, voir Système de commande Univer.
Écoute des commandes
Inscrivez-vous à Event.BeforeCommandExecute pour exécuter le code avant qu'une commande ne s'exécute, et à Event.CommandExecuted pour exécuter le Code après qu'il se termine.
const beforeDisposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, ({ id, params }) => { console.log('Avant la commande :', id, params)})const afterDisposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id, params }) => { console.log('Commande exécutée :', id, params)})Pour empêcher l'exécution d'une commande, définissez event.cancel à true dans un auditeur BeforeCommandExecute.
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => { if (event.id === 'doc.command.set-name') { event.cancel = true }})Chaque auditeur renvoie un IDisposable. Jetez l'objet retourné lorsque l'auditeur n'est plus nécessaire.
beforeDisposable.dispose()afterDisposable.dispose()disposable.dispose()Exécution de commandes
Lorsque l'ID de la commande et ses paramètres sont connus, exécutez la commande avec FUniver.executeCommand. La commande Docs suivante renomme le document actif :
const document = univerAPI.getActiveDocument()if (document) { await univerAPI.executeCommand('doc.command.set-name', { unitId: document.getId(), name: 'Notes du projet', })}API des événements
Les événements sur univerAPI.Event proviennent du noyau Univer et des plugins enregistrés dans l'application. Core fournit des événements de commande et documente les événements du cycle de vie, et les plugins Docs ajoutent leurs propres événements. Confirmez que le plugin fournissant un événement est enregistré avant d'utiliser l'événement.
Le Facade Events référence liste les noms d'événements et les types de paramètres disponibles dans la version actuelle.
Appelez addEvent pour vous abonner, puis éliminez l'objet retourné pour vous désabonner :
const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id }) => { if (id === 'doc.command.set-name') { console.log('Le nom du document a changé') }})// Supprimez l’écouteur lorsqu’il n’est plus nécessairedisposable.dispose()Annulation et rétablissement
await univerAPI.undo()await univerAPI.redo()Presse-papiers système
Après l'enregistrement du plugin UI Docs, copy et paste fonctionnent sur la position actuelle de sélection et de caricature dans le document.
await univerAPI.copy()await univerAPI.paste()Copier et coller dépend de l'API de Clipboard native du navigateur. Ils peuvent échouer lorsque la page n'a pas de focus, lorsque l'appel n'est pas initié par une action de l'utilisateur, ou lorsque la permission de presse-papiers n'est plus disponible. Documentation du presse-papiers MDN.
Interface utilisateur
La page Composants de l'assurance-chômage Docs décrit comment étendre les menus, la barre d'outils et d'autres parties de l'interface Docs.
WebSocket
Une installation prédéfinie expose déjà univerAPI.createSocket(url). En mode plugin, installer @univerjs/network, enregistrer UniverNetworkPlugin et importer son extension Facade avant utilisation.
import { UniverNetworkPlugin } from '@univerjs/network'import '@univerjs/network/facade'univer.registerPlugin(UniverNetworkPlugin)Ensuite, vous pouvez vous abonner à des événements socket, envoyer des messages et fermer la connexion:
const socket = univerAPI.createSocket('wss://example.com/docs')socket.open$.subscribe(() => { socket.send('hello')})socket.message$.subscribe((message) => { console.log('Message WebSocket :', message.data)})socket.error$.subscribe((error) => { console.error('Erreur WebSocket :', error)})socket.close()API des énumérations
Les types d'enum communs sont exposés par univerAPI.Enum:
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_DOC)console.log(univerAPI.Enum.LifecycleStages.Rendered)API des méthodes utilitaires
Les méthodes d'utilité partagées sont exposées par univerAPI.Util :
console.log(univerAPI.Util.tools.isString('Univer Docs')) // trueQue pensez-vous de ce guide ?