Integrate in Astro
Start with installation and basic usage. This example uses Astro to mount Univer Boards in a container with an explicit height.
Use a normal <script> to initialize the editor directly in the browser. Run initialization on the first load and on astro:page-load; dispose before astro:before-swap when using ClientRouter. Keep editor imports out of Astro frontmatter. See Astro navigation events.
Integration Steps
- Initialize Univer in
mount()/astro:page-load. - Dispose of Univer in
astro:before-swap.
Example
Astro
<div id="univer-boards" style="height: 600px"></div><script> import { UniverBoardsPlugin } from '@univerjs-pro/boards' import { UniverBoardsUIPlugin } from '@univerjs-pro/boards-ui' import BoardsUIenUS from '@univerjs-pro/boards-ui/locale/en-US' import { UniverInkUIPlugin } from '@univerjs-pro/ink-ui' import InkUIenUS from '@univerjs-pro/ink-ui/locale/en-US' import { UniverLicensePlugin } from '@univerjs-pro/license' import { LocaleType, mergeLocales, Univer, UniverInstanceType } from '@univerjs/core' 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 { UniverDrawingPlugin } from '@univerjs/drawing' import { UniverDrawingUIPlugin } from '@univerjs/drawing-ui' import DrawingUIenUS from '@univerjs/drawing-ui/locale/en-US' import { UniverRenderEnginePlugin } from '@univerjs/engine-render' 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/drawing-ui/lib/index.css' import '@univerjs-pro/ink-ui/lib/index.css' import '@univerjs-pro/boards-ui/lib/index.css' let univerInstance: Univer | undefined function mount() { const container = document.getElementById('univer-boards') if (!container || univerInstance) return const univer = new Univer({ locale: LocaleType.EN_US, locales: { [LocaleType.EN_US]: mergeLocales( DesignenUS, UIenUS, DocsUIenUS, DrawingUIenUS, InkUIenUS, BoardsUIenUS, ), }, }) univer.registerPlugin(UniverLicensePlugin, { license: 'your license.txt', }) univer.registerPlugin(UniverRenderEnginePlugin) univer.registerPlugin(UniverUIPlugin, { container }) univer.registerPlugin(UniverDocsPlugin) univer.registerPlugin(UniverDocsUIPlugin) univer.registerPlugin(UniverDrawingPlugin) univer.registerPlugin(UniverDrawingUIPlugin) univer.registerPlugin(UniverInkUIPlugin) univer.registerPlugin(UniverBoardsPlugin) univer.registerPlugin(UniverBoardsUIPlugin) univer.createUnit(UniverInstanceType.UNIVER_BOARD, {}) univerInstance = univer } function dispose() { univerInstance?.dispose() univerInstance = undefined } mount() document.addEventListener('astro:page-load', mount) document.addEventListener('astro:before-swap', dispose)</script>How is this guide?