在 Next.js 中整合
請先閱讀安裝與基本使用。以下範例透過 Next.js App Router 將 Univer Boards 掛載到具有明確高度的容器中。
在用戶端元件中透過 ssr: false1 動態載入編輯器。只宣告 use client 不會關閉預先渲染。 Next.js.
將 YOUR_CLIENT_LICENSE 替換為用戶端授權內容,不要填寫檔案路徑。 授權設定.
整合步驟
- 在
useEffect中初始化 Univer - 在
useEffect cleanup中銷毀 Univer
範例程式碼
每次掛載使用獨立的子容器,並在外層 React 清理完成後的微任務中銷毀實例,避免在 React 提交期間同步卸載巢狀 React root。
TSX
'use client'import { useEffect, useRef } from 'react'import { UniverBoardsPlugin } from '@univerjs-pro/boards'import { UniverBoardsUIPlugin } from '@univerjs-pro/boards-ui'import BoardsUIzhTW from '@univerjs-pro/boards-ui/locale/zh-TW'import { UniverInkUIPlugin } from '@univerjs-pro/ink-ui'import InkUIzhTW from '@univerjs-pro/ink-ui/locale/zh-TW'import { UniverLicensePlugin } from '@univerjs-pro/license'import { LocaleType, mergeLocales, Univer, UniverInstanceType } from '@univerjs/core'import DesignzhTW from '@univerjs/design/locale/zh-TW'import { UniverDocsPlugin } from '@univerjs/docs'import { UniverDocsUIPlugin } from '@univerjs/docs-ui'import DocsUIzhTW from '@univerjs/docs-ui/locale/zh-TW'import { UniverDrawingPlugin } from '@univerjs/drawing'import { UniverDrawingUIPlugin } from '@univerjs/drawing-ui'import DrawingUIzhTW from '@univerjs/drawing-ui/locale/zh-TW'import { UniverRenderEnginePlugin } from '@univerjs/engine-render'import { UniverUIPlugin } from '@univerjs/ui'import UIzhTW from '@univerjs/ui/locale/zh-TW'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'export default function UniverEditor() { const containerRef = useRef<HTMLDivElement>(null) useEffect(() => { const host = containerRef.current if (!host) return const container = document.createElement('div') container.style.height = '100%' host.append(container) const univer = new Univer({ locale: LocaleType.ZH_TW, locales: { [LocaleType.ZH_TW]: mergeLocales( DesignzhTW, UIzhTW, DocsUIzhTW, DrawingUIzhTW, InkUIzhTW, BoardsUIzhTW, ), }, }) univer.registerPlugin(UniverLicensePlugin, { license: 'YOUR_CLIENT_LICENSE', }) 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, {}) return () => { queueMicrotask(() => { univer.dispose() container.remove() }) } }, []) return <div ref={containerRef} style={{ height: 600 }} />}TSX
'use client'import dynamic from 'next/dynamic'const UniverEditor = dynamic(() => import('./univer-editor'), { ssr: false })export default function Page() { return <UniverEditor />}Footnotes
-
伺服器端渲染(SSR)會在瀏覽器載入頁面前執行渲染程式,此時沒有瀏覽器的
window與 DOM。Client Component 仍可能被預先渲染,因此需單獨停用編輯器元件的 SSR。 ↩
你覺得這篇文檔如何?