Basic concepts
Learn the plugins, snapshots, commands, and Facade API used by Univer Docs. Continue to installation and basic usage for a working editor.
Basic Concepts
Before diving deeper into Univer, please read this document to understand the basic concepts of Univer, which will help you use Univer more smoothly.
The basic concepts include:
- Plugin
- Snapshot
- Command
- Facade API
Plugins
All of Univer's features are provided by plugins, which are the basic building blocks of Univer. Multiple plugins combined together form a Univer application.
The responsibilities of plugins include:
- Implementing features, such as
@univerjs/docs-hyper-link, which provides the hyperlink model and commands for Univer Docs. - Providing some basic capabilities, such as
@univerjs/engine-renderprovides rendering capabilities.
You can combine Univer's plugins to customize a Univer application that meets your requirements and avoid loading unnecessary code. You can also extend Univer's functionality by writing plugins to meet personalized needs.
Related Links
- Hyperlinks to learn how to add a Docs feature in preset or plugin mode.
- Univer Architecture to learn more about Univer's architecture design.
Snapshot
Univer Docs uses IDocumentData as its snapshot format. It describes the document body, document-level styles, headers and footers, drawings, lists, tables, and plugin resources.
The optional resources field stores data defined by plugins.
Caution
Note! Univer's snapshot is only used to store data. It does not reflect the latest document status at runtime! If you want to save the document status as a snapshot, use the method to save the snapshot on the Facade API.
Command
In Univer Docs, changes to document content and formatting are executed through commands. This makes it possible to track changes, implement undo, redo, and collaborative editing, and coordinate related features.
The Facade API prepares the parameters and executes the corresponding Docs commands behind the scenes.
Caution
Do not modify the snapshot directly! This will not take effect and will not trigger the update of views or UI. Please modify data through commands or the Facade API.
Facade API
Due to the high complexity of office applications, Univer's architecture is also very complex. To make it easier for developers to use Univer, we provide the Facade API, which is a wrapper for Univer's first-party plugins, providing simpler interfaces that make it easier for developers to use Univer.
The Facade API is actively being improved. If you have any questions or requirements, please submit an issue on GitHub.
The Facade API is a high-level API that abstracts the underlying details. While it simplifies common tasks, complex features may require understanding Univer's architecture and using the low-level API directly.
Related Links
Preset mode and plugin mode
A preset bundles preconfigured plugins. Both modes expose the same capabilities when they include the same plugins. Use presets for a simpler setup and plugin mode for explicit control over composition and loading.
Keep all Univer dependencies on matching versions. Do not register a plugin again if a preset already includes it.
| Plugin mode | Preset mode |
|---|---|
| Import Facade extensions explicitly | Facade extensions are included |
| Control plugin registration order | The preset manages its included plugins |
| Load plugins when needed | Configured presets load during initialization |
How is this guide?