Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

54.4 KB
Raw Blame

Univer Office SDK

Crea tu propia oficina con IA con Univer Office SDK.

Empieza con Sheets y Docs de código abierto y conecta tu propia aplicación o agente.

🚀 Inicio rápido · 📚 Documentación · ⚖️ Comparación de funciones · 🌐 Sitio web · 🎮 Showcase · 🔧 API Reference · 📝 Blog

English · Français · Deutsch · Español · 简体中文 · 繁體中文 · 日本語 · 한국어

Release License Build CodeFactor Codecov

Stars Contributors Issues Last Commit

Discord X: @univerhq Open Collective

Trendshift

Índice

💡 ¿Qué es Univer?

Univer Office SDK: Web, Server, and AI SDKs

Univer es un SDK de ofimática para crear aplicaciones de oficina dentro de tu propio producto. Ofrece edición, cálculo, colaboración y procesamiento de archivos de Office para personas y agentes existentes, con tus datos y permisos. La familia de productos abarca hojas de cálculo, documentos, presentaciones, tablas relacionales, lienzos y PDF.

Univer Office SDK consta de tres partes:

  • Web SDK es la base: modelos de contenido, edición, renderizado, cálculo de fórmulas y APIs Facade (APIs orientadas a la aplicación). Combina sus plugins en un editor integrado o en tu propia aplicación de oficina y reutiliza los modelos de contenido, los comandos y el cálculo para el procesamiento Headless sin un editor interactivo.
  • Server SDK añade servicios de backend para colaboración en tiempo real, historial de edición e importación y exportación de archivos de Office.
  • AI SDK conecta las capacidades de Office con agentes y flujos de trabajo existentes mediante herramientas de contenido e integraciones de ejecución y revisión.

Este repositorio proporciona la arquitectura central y las implementaciones de los motores de Web SDK bajo Apache-2.0: modelos de contenido y formatos de instantáneas, gestión de plugins y dependencias, sistema de comandos, motores de fórmulas y renderizado, APIs Facade, infraestructura de UI y capacidades de edición de Sheets y Docs. Los plugins comerciales de Web SDK, Server SDK y las extensiones comerciales de AI SDK se distribuyen y licencian por separado.

Los agentes pueden utilizar las mismas APIs de código abierto; tu aplicación aporta el modelo y la orquestación de herramientas. El ejemplo de presupuesto muestra cómo editar, calcular y guardar sin depender de AI SDK.

Capacidades de código abierto

Área Capacidades seleccionadas
Sheets · Edición y diseño Estilos de celda, celdas combinadas, texto enriquecido en celdas, paneles inmovilizados, imágenes flotantes y deshacer/rehacer.
Sheets · Datos y cálculo Fórmulas, nombres definidos, filtrado, ordenación, validación de datos, formato condicional, hipervínculos, comentarios y búsqueda y reemplazo.
Docs Edición de texto enriquecido, formato de párrafos, listas, hipervínculos, comentarios e integración de dibujos.

Las funciones se componen mediante plugins y presets; el inicio rápido utiliza únicamente el preset Sheets Core. Las imágenes requieren los plugins de dibujo correspondientes. Consulta la comparación de funciones para conocer la cobertura detallada de las opciones de código abierto y comerciales.

Las demos siguientes muestran el conjunto más amplio de Univer Office SDK, incluidas capacidades comerciales. Van más allá de la configuración de código abierto predeterminada; consulta el alcance en código abierto y extensiones comerciales.

Sheets — Edición y diseño · Datos y cálculo — Abrir demo Docs — Edición de texto enriquecido — Abrir demo
Web App — Aplicaciones basadas en hojas — Abrir demo Univer — Contenido de Office compuesto — Abrir demo
Slides — Abrir demo Relational Tables — Abrir demo
Canvases — Abrir demo PDF — Abrir demo

Volver arriba

🚀 Construye sobre la base de código abierto

Build on open source

Tu objetivo Cómo usar la base de código abierto Por dónde empezar
Integrar Sheets o Docs Añade una superficie de edición de Office a tu aplicación o producto de agentes y conecta tus datos mediante las APIs Facade. Inicio rápido
Procesar contenido sin un editor Reutiliza plugins de contenido, modelos, comandos y cálculo en Node.js para editar, trabajar con instantáneas y automatizar tareas. Guía de Headless
Desarrollar funciones o editores personalizados Reutiliza los motores, componentes de UI, límites entre plugins, inyección de dependencias y sistemas de comandos y deshacer. Sigue las funciones existentes para ampliar Sheets y Docs o desarrollar tus propios editores. Arquitectura de código abierto

Coordina las ediciones y deshacer/rehacer entre funciones. Insertar una fila dentro de un rango de filtro modifica tanto el contenido base como el rango de filtro; deshacer debe restaurar ambos. Cada función aporta sus propios cambios y datos para deshacer, y el comando combina su ejecución e historial. El recorrido por la arquitectura explica cómo ampliar estos flujos de edición.

Inicio rápido: un editor de hojas de cálculo de código abierto

En una aplicación de navegador con un empaquetador como Vite:

pnpm add @univerjs/presets @univerjs/preset-sheets-core

Crea el contenedor antes de inicializar Univer:

<div id="app" style="height: 100vh"></div>
import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'
import UniverPresetSheetsCoreEnUS from '@univerjs/preset-sheets-core/locales/en-US'
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'
import '@univerjs/preset-sheets-core/lib/index.css'

const { univerAPI } = createUniver({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(UniverPresetSheetsCoreEnUS),
  },
  presets: [
    UniverSheetsCorePreset({
      container: 'app',
    }),
  ],
})

univerAPI.createWorkbook({})

Tu página ya contiene un editor de hojas de cálculo. Usa el objeto univerAPI devuelto para trabajar con su contenido. Este ejemplo utiliza paquetes de código abierto y no necesita una licencia comercial de Univer ni Server SDK.

En frameworks de componentes, conserva la instancia de univer devuelta por createUniver y llama a univer.dispose() cuando se desmonte el componente. Consulta la guía del ciclo de vida.

Los presets componen plugins y registran sus APIs Facade. Para tener control manual, consulta el ejemplo de Plugin Mode más abajo. La guía de instalación cubre ambos modos, las dependencias de pares y las integraciones con frameworks.

Mantén los paquetes coordinados @univerjs/* en la misma versión. Los paquetes comerciales deben usar la misma línea de versiones; los paquetes publicados de forma independiente, como los iconos, siguen su compatibilidad declarada. Consulta la Política de estabilidad de la API.

Conecta tu aplicación al contenido editable

Las APIs Facade son la interfaz de la aplicación para libros, hojas y rangos. Continúa desde el inicio rápido para rellenar un presupuesto, actualizar una cantidad desde el código de la aplicación y leer el total recalculado:

// Wait for formula controllers before editing a newly created workbook.
await new Promise<void>((resolve) => {
  if (univerAPI.getCurrentLifecycleStage() >= univerAPI.Enum.LifecycleStages.Steady) {
    resolve()
    return
  }
  const listener = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {
    if (stage === univerAPI.Enum.LifecycleStages.Steady) {
      listener.dispose()
      resolve()
    }
  })
})

const workbook = univerAPI.getActiveWorkbook()!
const sheet = workbook.getActiveSheet()

sheet.getRange('A1:D4').setValues([
  ['Item', 'Quantity', 'Unit price', 'Amount'],
  ['Seats', 2, 25, '=B2*C2'],
  ['Support', 1, 100, '=B3*C3'],
  ['Total', '', '', '=SUM(D2:D3)'],
])

// An application control or agent can make the same edit.
sheet.getRange('B2').setValue(4)

univerAPI.getFormula().onCalculationResultApplied().then(() => {
  console.log(sheet.getRange('D4').getValue()) // 200
  localStorage.setItem('quotation', JSON.stringify(workbook.save()))
}).catch(console.error)

El editor y tu aplicación trabajan sobre el mismo libro; los cambios en las fórmulas se recalculan automáticamente. workbook.save() devuelve una instantánea JSON que contiene el libro y los datos de sus plugins registrados. Tu aplicación se encarga de la persistencia; este ejemplo usa el almacenamiento del navegador. En una carga posterior de la página, después de la inicialización, restaura la instantánea en lugar de crear un libro vacío:

const saved = localStorage.getItem('quotation')
if (saved) {
  univerAPI.createWorkbook(JSON.parse(saved))
}

Este flujo utiliza únicamente paquetes de código abierto. La persistencia de instantáneas es independiente de la importación y exportación de XLSX, que utiliza capacidades de conversión de archivos distribuidas por separado. Usa las APIs Facade públicas para integrar tu aplicación; los enlaces al código fuente siguientes explican la implementación interna y los puntos de extensión. Consulta la Política de estabilidad de la API antes de depender de un punto de extensión.

Avanzado: componer plugins manualmente (Plugin Mode)

Usa Plugin Mode cuando necesites un control preciso sobre la selección, las dependencias o la carga de plugins. El preset anterior se encarga de esta composición por ti.

Esta inicialización alternativa utiliza el mismo contenedor app y la pila de plugins de navegador del preset Sheets Core sin un Worker. Úsala en lugar de la inicialización con preset y después ejecuta el mismo ejemplo de presupuesto con el objeto univerAPI devuelto.

pnpm add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui \
  @univerjs/engine-formula @univerjs/engine-render @univerjs/network \
  @univerjs/sheets @univerjs/sheets-ui @univerjs/sheets-formula \
  @univerjs/sheets-formula-ui @univerjs/sheets-numfmt \
  @univerjs/sheets-numfmt-ui @univerjs/ui
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { FUniver } from '@univerjs/core/facade'
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 { UniverFormulaEnginePlugin } from '@univerjs/engine-formula'
import FormulaEnUS from '@univerjs/engine-formula/locale/en-US'
import { UniverRenderEnginePlugin } from '@univerjs/engine-render'
import { UniverNetworkPlugin } from '@univerjs/network'
import { UniverSheetsPlugin } from '@univerjs/sheets'
import SheetsEnUS from '@univerjs/sheets/locale/en-US'
import { UniverSheetsFormulaPlugin } from '@univerjs/sheets-formula'
import SheetsFormulaEnUS from '@univerjs/sheets-formula/locale/en-US'
import { UniverSheetsFormulaUIPlugin } from '@univerjs/sheets-formula-ui'
import SheetsFormulaUIEnUS from '@univerjs/sheets-formula-ui/locale/en-US'
import { UniverSheetsNumfmtPlugin } from '@univerjs/sheets-numfmt'
import { UniverSheetsNumfmtUIPlugin } from '@univerjs/sheets-numfmt-ui'
import SheetsNumfmtUIEnUS from '@univerjs/sheets-numfmt-ui/locale/en-US'
import { UniverSheetsUIPlugin } from '@univerjs/sheets-ui'
import SheetsUIEnUS from '@univerjs/sheets-ui/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/docs-ui/lib/index.css'
import '@univerjs/sheets-ui/lib/index.css'
import '@univerjs/sheets-formula-ui/lib/index.css'
import '@univerjs/sheets-numfmt-ui/lib/index.css'
import '@univerjs/network/facade'
import '@univerjs/docs/facade'
import '@univerjs/docs-ui/facade'
import '@univerjs/engine-formula/facade'
import '@univerjs/sheets/facade'
import '@univerjs/ui/facade'
import '@univerjs/sheets-ui/facade'
import '@univerjs/sheets-formula/facade'
import '@univerjs/sheets-numfmt/facade'
import '@univerjs/sheets-formula-ui/facade'

const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      DesignEnUS,
      DocsUIEnUS,
      FormulaEnUS,
      SheetsEnUS,
      SheetsFormulaEnUS,
      SheetsFormulaUIEnUS,
      SheetsNumfmtUIEnUS,
      SheetsUIEnUS,
      UIEnUS,
    ),
  },
})

univer.registerPlugin(UniverNetworkPlugin)
univer.registerPlugin(UniverDocsPlugin)
univer.registerPlugin(UniverRenderEnginePlugin)
univer.registerPlugin(UniverUIPlugin, { container: 'app' })
univer.registerPlugin(UniverDocsUIPlugin)
univer.registerPlugin(UniverFormulaEnginePlugin)
univer.registerPlugin(UniverSheetsPlugin, {
  onlyRegisterFormulaRelatedMutations: false,
})
univer.registerPlugin(UniverSheetsUIPlugin, {
  protectedRangeShadow: true,
})
univer.registerPlugin(UniverSheetsNumfmtPlugin)
univer.registerPlugin(UniverSheetsNumfmtUIPlugin)
univer.registerPlugin(UniverSheetsFormulaPlugin)
univer.registerPlugin(UniverSheetsFormulaUIPlugin)

const univerAPI = FUniver.newAPI(univer)
univerAPI.createWorkbook({})

Los plugins de Docs permiten editar texto enriquecido en hojas de cálculo. Al añadir una función, incluye sus extensiones Facade, paquetes de idioma y estilos de UI correspondientes. Libera univer cuando se desmonte su contenedor.

Volver arriba

🏗️ Explora la arquitectura de código abierto

Define límites claros para las funciones personalizadas

Univer organiza la lógica de contenido y la interacción de UI en plugins separados. Los plugins de funciones gestionan las reglas y los cambios de contenido; los plugins de UI proporcionan la interfaz y las interacciones con el usuario. Por ejemplo, sheets-filter gestiona los rangos y las reglas de filtrado, mientras que sheets-filter-ui proporciona paneles, menús y atajos.

%%{init: {'htmlLabels': false, 'theme': 'base', 'themeVariables': {'fontFamily': 'Arial, PingFang SC, Microsoft YaHei, sans-serif', 'fontSize': '17px', 'lineColor': '#64748b'}, 'flowchart': {'htmlLabels': false, 'curve': 'linear', 'nodeSpacing': 28, 'rankSpacing': 45, 'padding': 16, 'wrappingWidth': 270}}}%%
%% A layered overview, not a complete dependency graph.
%% Group arrows indicate reuse of the layer below; internal arrows show selected dependencies.
flowchart TD
  subgraph FEATURES["Feature Plugins"]
    direction LR
    FUI["Filter<br/>UI Plugin"]
    VUI["Data Validation<br/>UI Plugin"]
    FILTER["Filter Plugin"]
    VALIDATION["Data Validation Plugin"]
    FUI --> FILTER
    VUI --> VALIDATION
  end

  subgraph PRODUCTS["Product Plugins"]
    direction LR
    SUI["Sheets UI Plugin"]
    SHEETS["Sheets Plugin"]
    SUI --> SHEETS
  end

  subgraph FOUNDATION["Core Framework & Plugins"]
    direction LR
    UI["UI Plugin"]
    FORMULA["Formula Engine Plugin"]
    RENDER["Render Engine Plugin"]
    CORE["Core"]
    UI --> RENDER
    RENDER --> CORE
    FORMULA --> CORE
  end

  FEATURES --> PRODUCTS
  PRODUCTS --> FOUNDATION

  classDef logic fill:#eff6ff,color:#17365f,stroke:#93b4df,stroke-width:1.5px
  classDef ui fill:#f0fdf4,color:#17543a,stroke:#91c8a7,stroke-width:1.5px
  classDef shared fill:#f6f7f9,color:#334155,stroke:#bac3ce,stroke-width:1.5px
  classDef feature fill:#172d50,color:#ffffff,stroke:#172d50
  class FUI,VUI ui
  class FILTER,VALIDATION logic
  class SUI,SHEETS logic
  class UI,FORMULA,RENDER,CORE shared

  style FEATURES fill:#f7fcf9,stroke:#b5d8c1,color:#17543a
  style PRODUCTS fill:#f5f9ff,stroke:#b6cbea,color:#17365f
  style FOUNDATION fill:#fafbfc,stroke:#cbd2dc,color:#334155

Figura 1: tres capas de plugins. Los plugins de funciones se apoyan en los plugins de producto, que reutilizan el framework central y sus plugins. Las flechas entre grupos muestran las dependencias de la capa inferior; Core proporciona modelos de contenido, comandos, inyección de dependencias y gestión del ciclo de vida. Se omiten algunos plugins y dependencias.

Las nuevas funciones mantienen sus reglas en sus propios plugins y cooperan mediante servicios públicos, comandos y puntos de extensión definidos. Los plugins de UI se basan en servicios y componentes de UI compartidos.

Las dependencias son explícitas en dos niveles:

  • Entre plugins: DependentOn declara las dependencias de plugins en tiempo de ejecución. El servicio de plugins las ordena, y las etapas del ciclo de vida separan el registro de dependencias, la inicialización de contenido y la inicialización de UI.
  • Dentro de los plugins: la inyección de dependencias conecta controladores y servicios mediante dependencias declaradas. Las sustituciones admitidas permiten a una aplicación reemplazar una implementación, adaptar un servicio de plataforma o proporcionar un doble de prueba. Los inyectores con ámbito de instancia mantienen separado el estado de la aplicación entre instancias de Univer.

El registro con disposables también permite limpiar comandos, listeners, componentes e iconos cuando se libera su propietario.

El plugin de filtrado y su plugin de UI muestran estos límites en código real.

Dentro de una función: Model, Controller, Service e infraestructura de UI

En el filtrado, sheets-filter se encarga de la lógica de contenido y sheets-filter-ui de la interacción de UI. Cada módulo tiene una responsabilidad concreta.

%%{init: {'htmlLabels': false, 'theme': 'base', 'themeVariables': {'fontFamily': 'Arial, PingFang SC, Microsoft YaHei, sans-serif', 'fontSize': '17px', 'lineColor': '#64748b'}, 'flowchart': {'htmlLabels': false, 'curve': 'linear', 'nodeSpacing': 28, 'rankSpacing': 45, 'padding': 16, 'wrappingWidth': 270}}}%%
%% Every arrow means contains. This is code organization, not execution order.
flowchart LR
  FEATURE["Filter Feature"]
  LOGIC["Filter Plugin"]
  UI["Filter UI Plugin"]
  MODEL["Model"]
  SERVICE["Service"]
  CONTROLLER["Controller"]
  COMMAND["Command / Mutation"]
  FACADE["Facade API"]
  VIEW["View"]
  UICTRL["UI Controller"]
  UISERVICE["UI Service"]
  FEATURE --> LOGIC
  FEATURE --> UI
  LOGIC --> MODEL
  LOGIC --> SERVICE
  LOGIC --> CONTROLLER
  LOGIC --> COMMAND
  LOGIC --> FACADE
  UI --> VIEW
  UI --> UICTRL
  UI --> UISERVICE

  classDef logic fill:#eff6ff,color:#17365f,stroke:#93b4df,stroke-width:1.5px
  classDef ui fill:#f0fdf4,color:#17543a,stroke:#91c8a7,stroke-width:1.5px
  classDef shared fill:#f6f7f9,color:#334155,stroke:#bac3ce,stroke-width:1.5px
  classDef feature fill:#172d50,color:#ffffff,stroke:#172d50
  class FEATURE feature
  class LOGIC,MODEL,SERVICE,CONTROLLER,COMMAND,FACADE logic
  class UI,VIEW,UICTRL,UISERVICE ui

Figura 2: organización del código. Las flechas significan «contiene». Ambos plugins pueden contener Controllers y Services: los Controllers de lógica coordinan los cambios de contenido y las funciones relacionadas; los Controllers de UI conectan menús, atajos e interacciones, y los Services de UI gestionan el estado de los paneles. Estas responsabilidades ofrecen a las nuevas funciones una estructura coherente para su implementación y pruebas.

La infraestructura de UI sigue la misma división. @univerjs/design aporta componentes y estilos compartidos, @univerjs/ui proporciona servicios del entorno de trabajo como menús, atajos, paneles y registro de componentes, y @univerjs/icons aporta iconos. Una función registra sus componentes e iconos, añade menús y conecta su renderizado mediante estos puntos de extensión. Los equipos pueden añadir un panel o una función a la barra de herramientas reutilizando la infraestructura de UI de la aplicación. Consulta la descripción general de UI y el registro de componentes e iconos del plugin de filtrado.

Combina ediciones y deshacer/rehacer entre funciones

Por ejemplo, al insertar filas dentro de un rango de filtro, el plugin de filtrado aporta el cambio de rango correspondiente y sus datos para deshacer. El comando de filas combina la edición base y los cambios de las funciones participantes, los ejecuta y registra conjuntamente su información de deshacer/rehacer. La función de inserción de filas puede usar el mecanismo de extensión compartido mientras el plugin de filtrado conserva sus reglas de actualización de rangos.

El sistema de comandos distingue tres tipos de acción:

  • Command orquesta una acción de negocio y los cambios que requiere.
  • Mutation modifica contenido guardado en una instantánea, con parámetros serializables.
  • Operation modifica estado transitorio, como un panel abierto o la posición de desplazamiento.

Una estructura compartida para deshacer/rehacer. Para una edición que se pueda deshacer, la implementación de la función aporta las mutaciones directas y las mutaciones inversas correspondientes, y el Command las registra mediante IUndoRedoService. Cuando una acción afecta a varias funciones, el Command puede combinar sus cambios y datos para deshacer en un único registro de deshacer/rehacer, para que el usuario pueda deshacer y rehacer la acción completa. Consulta cómo ampliar los comandos.

Las funciones siguen necesitando cooperar. Los interceptores y los manejadores de rangos de referencia dan un lugar definido a esa cooperación. En los puntos de extensión admitidos, los plugins aportan comprobaciones o mutaciones relacionadas; las prioridades de los interceptores controlan el orden cuando la API así lo define.

Ejemplo: comandos, callbacks, coordinación de funciones y deshacer/rehacer
%%{init: {'htmlLabels': false, 'theme': 'base', 'themeVariables': {'fontFamily': 'Arial, PingFang SC, Microsoft YaHei, sans-serif', 'fontSize': '17px', 'lineColor': '#64748b'}, 'flowchart': {'htmlLabels': false, 'curve': 'linear', 'nodeSpacing': 28, 'rankSpacing': 45, 'padding': 16, 'wrappingWidth': 270}}}%%
%% Simplified insert-row example. A command composes mutations and records undo after success.
%% Events may also fire for nested command executions; not every callback is drawn.
flowchart TD
  BEFORE["Before execution<br/>Inspect or cancel"]
  CMD["Insert-row Command"]
  BASE["Row mutations"]
  EXT["Feature extension points<br/>Filter range changes"]
  MODEL["Execute combined mutations"]
  UNDO["Record undo and redo"]
  AFTER["After execution<br/>Notify listeners"]
  BEFORE --> CMD
  CMD --> BASE
  CMD --> EXT
  BASE --> MODEL
  EXT --> MODEL
  MODEL --> UNDO
  UNDO --> AFTER
  classDef entry fill:#f6f7f9,color:#334155,stroke:#bac3ce,stroke-width:1.5px
  classDef core fill:#eff6ff,color:#17365f,stroke:#93b4df,stroke-width:1.5px
  classDef extension fill:#f0fdf4,color:#17543a,stroke:#91c8a7,stroke-width:1.5px
  class BEFORE,AFTER entry
  class CMD,BASE,MODEL,UNDO core
  class EXT extension

Este diagrama simplifica un flujo de inserción de filas. Las ejecuciones de comandos anidados tienen sus propios callbacks; no muestra todos los eventos ni la ruta separada de Operation. Consulta el comando de filas, el controlador de filtrado y el servicio de interceptores.

Estos límites permiten una estrategia práctica de pruebas: probar modelos y servicios de forma independiente, sustituir dependencias externas mediante DI y añadir casos de regresión para acciones combinadas y deshacer/rehacer. Las pruebas del controlador de filtrado ejercitan los cambios de filas y columnas y su efecto en el filtrado.

Conecta aplicaciones y agentes mediante APIs Facade y eventos

El repositorio incluye los modelos de contenido, el motor de fórmulas y el motor de renderizado y diseño en Canvas que utilizan los editores. Son elementos compartidos: el texto enriquecido en hojas de cálculo, por ejemplo, reutiliza el diseño y el renderizado de documentos. Las funciones personalizadas pueden basarse en estos motores en lugar de implementar una pila de contenido independiente. Lee sobre la arquitectura del motor de fórmulas y la arquitectura del motor de renderizado.

Los editores de navegador, las tareas Headless de Node.js y los Workers compuestos adecuadamente pueden reutilizar los plugins de contenido, modelos, comandos y cálculo correspondientes. Consulta Headless Univer y la arquitectura isomórfica.

ICommandService expone callbacks de ejecución para que los plugins observen los comandos antes y después de ejecutarse. Las APIs Facade encapsulan las capacidades subyacentes en objetos de aplicación como FWorkbook, FWorksheet y FRange.

Cada plugin aporta sus propias extensiones Facade, eventos tipados mediante univerAPI.Event y enumeraciones mediante univerAPI.Enum. El código de la aplicación puede descubrir nombres de eventos y constantes desde un único punto de entrada, sin importar servicios privados ni repetir cadenas. Por ejemplo, BeforeCommandExecute puede inspeccionar y cancelar una ejecución; CommandExecuted notifica las ejecuciones a los listeners. Los listeners devuelven disposables, y la cancelación se aplica cuando el evento la admite.

Las extensiones Facade permanecen en los paquetes de sus funciones, de modo que una API de contenido no necesita incorporar APIs de UI ajenas. Consulta el diseño de Facade, los callbacks de comandos y el puente de eventos y el punto de entrada de Enum.

El repositorio ofrece implementaciones de funciones y patrones para ampliarlas. Lee el recorrido por la implementación del filtrado para ver un ejemplo completo, o la Política de estabilidad de la API antes de depender de un punto de extensión.

Volver arriba

🧩 Amplía tu aplicación con Univer Office SDK

Cuando necesites más capacidades listas para integrar, combina los módulos correspondientes de Univer Office SDK: tipos de contenido adicionales, plugins de edición avanzada, colaboración, conversión de archivos y herramientas para agentes. Amplían los mismos modelos de contenido, arquitectura de plugins, sistema de comandos y diseño de Facade presentados anteriormente, por lo que puedes aprovechar tu integración existente.

Parte Cómo amplía la base
Núcleo de Web SDK de código abierto · este repositorio Modelos, motores, plugins, infraestructura de UI y capacidades de Sheets y Docs de código abierto, con sus correspondientes operaciones Headless sobre contenido. Úsalos en aplicaciones comerciales bajo Apache-2.0.
Plugins comerciales de Web SDK Siguen los patrones de Plugin, inyección de dependencias, Command/Mutation y extensión de Facade del núcleo. Añaden gráficos, formas, tablas dinámicas, SmartArt y otras funciones para los tipos de contenido correspondientes.
Server SDK Amplía los mismos modelos de contenido y convenciones de mutaciones con colaboración en tiempo real, historial de revisiones y conversión de archivos de Office. Se integra con la identidad, los permisos y el almacenamiento de tu aplicación.
Extensiones de AI SDK Reutilizan las capacidades Headless y Facade de Web SDK para proporcionar APIs de Node.js y componentes de CLI que se pueden combinar para que los agentes inspeccionen, editen y comprueben contenido, con integraciones de colaboración y revisión de Worktree.

Alcance y licencias

  • Este repositorio: paquetes Apache-2.0 que se pueden usar en aplicaciones comerciales bajo esa licencia, incluidas las capacidades Headless de código abierto para contenido.
  • Extensiones comerciales: los plugins comerciales de Web SDK, Server SDK y las capacidades de AI SDK que van más allá de la base de código abierto se distribuyen y licencian por separado. La evaluación Freemium incluye marcas de agua y límites de funciones.
  • Aplicaciones de referencia: las aplicaciones de código abierto como Univer Workspace tienen sus propias licencias de código fuente. Sus dependencias del SDK conservan sus respectivas licencias.

Consulta la comparación de funciones, incluido su filtro Open source only, para conocer la cobertura detallada, y los planes y licencias para las opciones comerciales.

Cómo los modelos de contenido compartidos conectan la edición, la colaboración y los archivos

Estas capacidades trabajan con instantáneas Unit serializables, entre ellas IWorkbookData de Sheets, IDocumentData de Docs, ISlideData de Slides e IBoardData de los lienzos (llamados Boards en la API). Estos tipos proceden del núcleo y de los respectivos paquetes de producto; las capacidades actuales de Slides y Boards son productos comerciales distribuidos por separado. Las convenciones Unit compartidas permiten a los editores de navegador, servicios de backend y agentes trabajar con el mismo contenido.

Los comandos orquestan las ediciones; las Mutations describen los cambios de contenido. La colaboración agrupa esas mutaciones en changesets, aplica transformación operacional (OT) a los cambios concurrentes y gestiona las revisiones confirmadas y las instantáneas. El historial puede reconstruir una revisión a partir de una instantánea y los changesets posteriores. Lee el diseño de colaboración y la descripción general de Collaboration SDK.

Exchange convierte las estructuras de archivos de Office en instantáneas de contenido de Univer y viceversa. Para formatos OOXML como XLSX, DOCX y PPTX, analiza el archivo y lo transforma en los datos de Sheet, Doc o Slide correspondientes, y genera la representación del archivo al exportar. El contenido convertido puede entrar en los mismos flujos de edición, cálculo, colaboración y agentes. Consulta la importación y exportación de archivos de Office.

Cómo AI SDK ofrece a los agentes las mismas capacidades de contenido

AI SDK se basa en los modelos de contenido Headless, comandos, cálculo y APIs Facade de Web SDK. Expone APIs TypeScript estructuradas y presets opcionales de Commander que las aplicaciones pueden combinar para crear su propia CLI de Office o herramientas para agentes.

  • Comprender, descubrir y editar. La inspección devuelve contenido estructurado. API Reference ayuda al agente a encontrar los símbolos y las firmas de Facade incluidos en su SDK. La ejecución de Facade distingue los modos de lectura y escritura, captura mutaciones y trabaja con sincronización explícita y resultados de commit. Consulta las operaciones de contenido.
  • Comprobar el resultado renderizado. Un Render Runtime de navegador reutiliza el renderizado de Web SDK para obtener capturas. La comprobación del diseño de diapositivas añade resultados estructurados para problemas como texto fuera de página o superpuesto, dando al agente evidencias para otra ronda de edición. Consulta la inspección visual.
  • Editar borradores para revisión humana. Con las capacidades de colaboración y Web correspondientes, los agentes pueden editar y verificar un borrador aislado de Worktree durante varias rondas y entregarlo después a una persona para que lo revise, fusione o reabra. El flujo usa las mismas convenciones de instantáneas, mutaciones y revisiones. Consulta Worktree.

Para llamadas repetidas, los pools de Workers y un daemon opcionales reutilizan las instancias de contenido cargadas y reducen la inicialización repetida. Tu aplicación se encarga de la CLI raíz, los destinos, la autorización y la salida. Explora el catálogo de paquetes de AI SDK para seleccionar las capacidades necesarias.

Volver arriba

🌐 Patrones de aplicación y ecosistema

Univer Workspace: una aplicación de referencia de Office SDK

Para ver una aplicación de referencia completa, empieza por Univer Workspace. Muestra cómo combinar los editores de Univer Office SDK, colaboración, capacidades de archivos, agentes existentes y revisión humana en un espacio de trabajo autoalojable. Sigue sus patrones de integración al crear tu propia aplicación de oficina o espacio de trabajo para agentes.

Una hoja de presupuesto editable en Univer Workspace Una Web App con controles de supuestos junto a su hoja de cálculo editable conectada
Agentes y contenido de Office editable
Reúne conversaciones, edición de hojas de cálculo y contenido de Office en un único espacio de trabajo.
Prueba Workspace · Código fuente y configuración de Workspace
Web App × Sheet · Experimental
Vincula controles a celdas: la aplicación escribe en la hoja y los cambios de la hoja actualizan la aplicación.
Prueba la demo de aplicación basada en hojas

Workspace es de código abierto; sus dependencias del SDK siguen sus respectivas licencias. Consulta la descripción general de Workspace para conocer las aplicaciones conectadas y los flujos de revisión.

Ver una demo de integración del SDK

Ver una demo de integración del SDK

CLI, integraciones de agentes y skills para desarrolladores

Las mismas capacidades del SDK también se pueden combinar con los agentes y las herramientas que ya utilizas:

Proyecto Qué ofrece
Univer CLI Un espacio de trabajo local por línea de comandos para crear, editar, inspeccionar y entregar contenido de Office.
Univer Office for DeepSeek Harness Contenido vinculado, verificación de resultados, cambios versionados y colaboración aislada con Worktree.
Univer Office for WorkBuddy Integración local de Office, vistas previas MCP y revisión de borradores. Versión preliminar para desarrolladores.
Univer Office for OpenClaw Herramientas para crear, revisar y entregar contenido de Office.
Univer SDK Skills Instrucciones que ayudan a los agentes de programación a integrar el SDK, desarrollar plugins e implementar flujos de backend.

Cada repositorio documenta su configuración y sus dependencias del SDK. Explora el ecosistema para encontrar puntos de entrada para agentes, o la documentación para crear tu propia integración.

Volver arriba

📚 Documentación y contribuciones

Gracias a todos los colaboradores que construyen y mejoran Univer. Son bienvenidas las contribuciones a motores, plugins, pruebas, documentación y ejemplos.

🧩 Web SDK · 🖥️ Server SDK · 🤖 AI SDK · 🔧 Referencia de la API · 🎮 Demo en vivo


Edge

Firefox

Chrome

Safari

Electron
>=88 >=90 >=88 >=14.1 >=12

Univer se compila con Chrome 88 como objetivo y busca funcionar con las versiones indicadas arriba.

Compatibilidad en tiempo de ejecución

  • Polyfills: Univer depende de Intl.Segmenter. Añade un polyfill como @formatjs/intl-segmenter si tu navegador o entorno de ejecución no lo proporciona.
  • Herramientas de compilación: recomendamos Vite, esbuild o Webpack 5. Si tu herramienta no admite el campo exports de package.json (habitual en Webpack 4), puede que necesites configurar asignaciones de rutas adicionales.
  • React: la capa de vistas de Univer está construida con React 18, admite React 18 y 19, y ofrece soporte mínimo de compatibilidad para React 16.9+ y 17.
  • Node.js: Headless Univer admite Node.js >=18.17.0. El desarrollo de este monorepo requiere Node.js >=22.18.
Desarrollo en este repositorio

Estructura del repositorio

.
├── packages/      Core packages, engines, document types, UI plugins, and feature plugins
├── examples/      All-in-one Vite workbench used for local browser development
├── common/        Shared internal tooling, storybook, and utilities
├── tests/         Additional integration test projects
└── docs/          Architecture notes, images, and repository-local documentation

Los README de cada paquete están junto a su paquete en packages/.

Desarrollo local

Requisitos:

  • Node.js >=22.18
  • pnpm: usa la versión declarada en packageManager dentro de package.json.
git clone https://github.com/dream-num/univer.git
cd univer
pnpm install
pnpm dev

Comandos útiles:

Comando Finalidad
pnpm dev Iniciar el entorno de desarrollo de Sheets y Docs.
pnpm build Compilar los paquetes del workspace, excluidos los paquetes comunes internos.
pnpm test Ejecutar pruebas unitarias mediante Turbo.
pnpm typecheck Ejecutar las comprobaciones de TypeScript mediante Turbo.
pnpm lint Ejecutar ESLint.
pnpm storybook:dev Iniciar Storybook para desarrollar componentes de UI.

Lee CONTRIBUTING.md antes de abrir un pull request.

Referencias de arquitectura y contribuciones

Volver arriba

💬 Comunidad

Haz preguntas en GitHub Discussions, únete a Discord y sigue X o YouTube. Lee el Código de conducta.

Volver arriba

🔒 Seguridad

Si crees haber encontrado un problema de seguridad, sigue la Política de Seguridad.

Volver arriba

❤️ Patrocinadores

Univer cuenta con el apoyo de la comunidad y patrocinadores. Puedes apoyar el proyecto a través de Open Collective.

Patrocinar el proyecto

Backer 0 Backer 1 Backer 2 Backer 3 Backer 4 Backer 5 Backer 6

Volver arriba

📄 Licencia

Copyright (c) 2021-present DreamNum Co., Ltd.

Los paquetes de código abierto de este repositorio se distribuyen bajo Apache-2.0. Los módulos comerciales del SDK se distribuyen y licencian por separado.

Volver arriba