API de Facade
Aprende a añadir Facade API a tu aplicación para simplificar el uso de Web SDK.
Para cumplir con requisitos complejos, la arquitectura de Univer también es bastante compleja, lo que puede causar algunas dificultades de uso. Para solucionar este problema, proporcionamos una API de Facade más sencilla y fácil de usar.
Este capítulo mostrará en detalle cómo agregar Facade API a su aplicación. En el siguiente capítulo "Características", enumeraremos la API de Facade principal de cada característica. Si desea ver todas las API de Facade, consulte la referencia de API de cada complemento.
Cuation
Algunas API de Facade son asincrónicas, especialmente aquellas que modifican datos, que a menudo devuelven una Promesa. Si necesita recuperar datos inmediatamente después de modificarlos, utilice await o .then(); de lo contrario, puede obtener resultados inesperados. Para saber qué API específicas devuelven Promesas, consulte el manual de referencia de la API correspondiente.
Integración de Facade API en modo complemento
Instalación
Para integrar Facade API en el caso de instalar Univer a través del modo complemento, la implementación de Facade API se distribuye en varios complementos y se monta en el objeto raíz global de Facade API. Esto significa que para aquellos complementos que proporcionan Facade API, puede importar sus implementaciones de Facade API correspondientes según sea necesario.
import { FUniver } from '@univerjs/core/facade'import '@univerjs/ui/facade'import '@univerjs/docs-ui/facade'Cuation
No todos los complementos incluyen un paquete de fachada; especificaremos esto en la documentación de cada característica.
Uso
Facade API es un contenedor alrededor de la instancia de Univer, por lo que debes empaquetar la instancia de Univer con FUniver después de crearla:
import { FUniver } from '@univerjs/core/facade'const univerAPI = FUniver.newAPI(univer)Integración de la API de Facade en modo preestablecido
Si integra Univer con el modo preestablecido, importará automáticamente la API de Facade para las funciones incluidas y devolverá una instancia de API de Facade correspondiente univerAPI cuando cree una instancia de Univer. Puede usarlo directamente.
Precauciones
No todas las API de Facade se pueden llamar inmediatamente; Algunas API deben usarse en etapas específicas del ciclo de vida. Si tiene problemas con la ejecución inmediata, consulte el siguiente método para elegir la etapa del ciclo de vida adecuada para la ejecución:
const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => { if (stage === univerAPI.Enum.LifecycleStages.Rendered) { // Code to be executed when the lifecycle stage is Rendered } if (stage === univerAPI.Enum.LifecycleStages.Steady) { // Code to be executed when the lifecycle stage is Steady }})¿Cómo es esta guía?