Quickstart
Before installing Univer Slides, learn the four concepts that shape every Slides integration:
- Plugin
- Snapshot and data model
- Command
- Facade API
Basic Concepts
Plugins
Univer Slides is assembled from plugins. UniverSlidesPlugin registers the UNIVER_SLIDE presentation model and its core commands, while UniverSlidesUIPlugin adds the browser editor UI. Add optional packages such as print, tables, charts, or import and export only when your application needs them.
The Slides UI uses Docs, Drawing, and Shape services internally to edit text and graphics. These are technical dependencies of the Slides plugin stack; you do not need prior experience with another Univer product.
Snapshot and data model
One presentation is persisted as an ISlideData snapshot. name and defaultPageSize describe the presentation, slideOrder orders the entries in slides, and optional reusable layers live in masterPages and layoutPages.
Use presentation.save() to read the current snapshot. A snapshot is persistence data, not a live model, so changing the snapshot object after the presentation starts does not update the editor.
Command
Runtime changes are executed through commands. Commands keep model validation, view updates, and undo and redo in the same change pipeline. Slides Facade methods prepare command parameters and execute those commands for you.
Caution
Do not mutate a running presentation's snapshot directly. Use Slides Facade methods or registered commands.
Facade API
Import @univerjs-pro/slides/facade after the core Facade entry to add Slides APIs to FUniver. The entry provides methods such as createPresentation(), getActivePresentation(), and getPresentation().
See Using the Slides Facade API for the complete setup and examples.
Next, continue to Installation & Basic Usage.
How is this guide?