설치 및 기본 사용법

Univer 보드는 Univer Office SDK의 일부이며 현재 플러그인 모드로 배송됩니다. 이 페이지는 설치 및 첫 번째 편집기를 렌더링하는 데 필요한 단계를 다룹니다.

Univer의 핵심 개념과 비교되지 않은 경우 퀵스타트를 먼저 읽어보십시오.

Univer는 두 가지 통합 모드를 지원합니다. Preset Mode 및 Plugin Mode. Preset Mode는 플러그인의 사전 설정된 설정으로 설정 작업을 줄여줍니다. 깊은 주문화 또는 연장가 필요한 경우 플러그인 모드는 개별적으로 플러그인을 결합하고 구성하기 때문에 적절한 선택입니다.

플러그인 모드로 설정하기

보드는 플러그인 세트로 배포됩니다. 브라우저 편집기는 보통 공유 Univer 실행 시간과 라이센스 플러그인을 먼저 등록하고 문서 및 도면 의존성을 마지막으로 이사회 모델과 UI 플러그인을 실행합니다.

패키지 관리자 사용

구조 공구는 ES 단위를 지원하고 package.json에 있는 exports 분야를 지원해야 합니다.

설치

Univer는 React와 UI를 구축하고 RxJS를 가진 데이터 스트림을 처리합니다. Vue 또는 Angular 응용 프로그램에 포함될 수도 있습니다. react, react-dom 및 rxjs 동료 Dependencies1가 설치됩니다. 해당 원사 명령은 아래 목록에서 명시적으로 나열합니다.

모든 @univerjs/* 및 @univerjs-pro/* 패키지의 버전을 동일하게 유지하세요.

Shell
pnpm add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/drawing-ui @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/ink-ui @univerjs-pro/shape-editor-ui @univerjs-pro/boards @univerjs-pro/boards-ui

사용법

Univer를 초기화하기 전에 컨테이너를 생성하고 명시된 높이를 부여합니다.

HTML
<div id="app" style="height: 600px"></div>

FUniver.newAPI(univer)를 호출하기 전에이 페이지에 사용되는 정면 항목을 가져옵니다. @univerjs/design CSS를 먼저로드 한 다음 @univerjs/ui의 CSS 및 제품 CSS가 지속됩니다.

주의

  • 보드 플러그인 전에 UniverLicensePlugin를 등록하십시오.
  • 제품 UI CSS보다 먼저 공유 UI CSS를 가져오세요.
  • 해당 요소 유형이 포함 된 스냅 샷을 열어하기 전에 선택 요소 플러그인을 등록하십시오.
  • UniverBoardsUIPlugin는 모양을 위해 UniverProFormulaEnginePlugin를 자동적으로 적재합니다. 동일한 Univer 인스턴스가 또한 UniverFormulaEnginePlugin에 등록하면 @univerjs-pro/engine-formula을 설치하고 초기화 부호에 UniverProFormulaEnginePlugin로 엔진의 수입 및 등록을 대체합니다. 공식 엔진을 둘 다 등록하지 마십시오.
  1. 스타일, 로케일 팩 및 필수 플러그인을 가져옵니다.

    TypeScript
    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'
  2. Facade API2가 필요한 경우 정면 입장을 가져옵니다:

    TypeScript
    import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/boards/facade'
  3. Univer 인스턴스를 생성하고 플러그인을 등록하고 보드 유닛을 만듭니다.

    TypeScript
    const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      DesignEnUS,      UIEnUS,      DocsUIEnUS,      DrawingUIEnUS,      InkUIEnUS,      BoardsUIEnUS,    ),  },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverDocsPlugin)univer.registerPlugin(UniverDocsUIPlugin)univer.registerPlugin(UniverDrawingPlugin)univer.registerPlugin(UniverDrawingUIPlugin)univer.registerPlugin(UniverInkUIPlugin)univer.registerPlugin(UniverLicensePlugin, {  license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverBoardsPlugin)univer.registerPlugin(UniverBoardsUIPlugin)univer.createUnit(UniverInstanceType.UNIVER_BOARD, {})const univerAPI = FUniver.newAPI(univer)

플러그인 설정

UniverUIPlugin

  • container
    string | HTMLElement
    편집기를 마운트할 DOM 요소 또는 해당 요소의 ID입니다.

UniverLicensePlugin

  • license
    string
    클라이언트 라이선스 파일의 내용입니다.

univer.registerPlugin 및 univer.registerPlugins 메서드

univer.registerPlugin는 Univer 인스턴스에 플러그인을 추가합니다. 인스턴스 생성 후 호출하십시오.

전화는 양식 univer.registerPlugin(Plugin, options), 어디 Plugin 등록 플러그인이며 options 플러그인에서 변화하는 옵션 구성입니다.

univer.registerPlugins는 배열을 받아들이고 한 곳에서 플러그인 목록을 유지 한 호출에서 여러 플러그인을 등록합니다.

TypeScript
univer.registerPlugins([  UniverRenderEnginePlugin,  [UniverUIPlugin, { container: 'app' }],  UniverDocsPlugin,  UniverDocsUIPlugin,  UniverDrawingPlugin,  UniverDrawingUIPlugin,  UniverInkUIPlugin,  [UniverLicensePlugin, {    license: process.env.CLIENT_LICENSE_TEXT,  }],  UniverBoardsPlugin,  UniverBoardsUIPlugin,])

FUniver.newAPI(univer)는 univerAPI 객체를 반환합니다. Univer의 Facade API입니다. 보드를 만들고 보드 요소에서 작동하도록 사용하십시오.

모바일 지원

아래 모바일 플러그인을 내보내는 SDK 패키지가 필요합니다. 모든 @univerjs/* 및 @univerjs-pro/* 의존성을 같은 버전으로 맞추세요.

1.0.0-rc.0은 UniverBoardsMobileUIPlugin을 내보내지 않습니다. 아래 예제는 해당 모바일 진입점을 포함하는 빌드에서 사용하세요.

Univer 보드의 터치 지향 제어를 위해 모바일 UI 플러그인.3를 사용하여 편집기를 만들기 전에 UI 모드를 선택하십시오.

위의 플러그인 모드 예에서 제품 설명이 UI 가져 오기 및 createUnit() 전에 등록. 이미 시작된 데스크톱 편집기에 추가하지 마십시오. 모델 플러그인, 엔진, 로컬 파일, CSS 및 Facade 가져 오기를 유지하십시오. 데스크톱 및 모바일 클래스는 동일한 패키지 항목의 수출이라고합니다.

UniverMobileUIPlugin

  • container
    string | HTMLElement
    편집기를 마운트할 DOM 요소 또는 해당 요소의 ID입니다.
  • disableAutoFocus
    true기본값: true
    시작에 초점을 맞추고 편집기를 중지합니다.
TypeScript
import { UniverBoardsMobileUIPlugin } from '@univerjs-pro/boards-ui'import { UniverDocsMobileUIPlugin } from '@univerjs/docs-ui'import { UniverDrawingMobileUIPlugin } from '@univerjs/drawing-ui'import { UniverMobileUIPlugin } from '@univerjs/ui'univer.registerPlugin(UniverMobileUIPlugin, { container: 'app' })univer.registerPlugin(UniverDocsMobileUIPlugin)univer.registerPlugin(UniverDrawingMobileUIPlugin)univer.registerPlugin(UniverBoardsMobileUIPlugin)

플러그인 대응표

이 기능을 사용하여 모델 플러그인 및 필수 종속성을 유지하십시오. 모바일 UI 내보내기는 데스크톱 및 모바일 인터페이스가 동일한 컨트롤이 있다는 것을 의미하지 않습니다. Pro 기능은 여전히 적절한 라이센스가 필요합니다. 기능이 백엔드가 필요하면 Univer Server SDK와 응용 프로그램 측에 통합됩니다.

패키지데스크톱 등록모바일 등록
@univerjs/uiUniverUIPluginUniverMobileUIPlugin
@univerjs/docs-uiUniverDocsUIPluginUniverDocsMobileUIPlugin
@univerjs/drawing-uiUniverDrawingUIPluginUniverDrawingMobileUIPlugin
@univerjs-pro/boards-uiUniverBoardsUIPluginUniverBoardsMobileUIPlugin
@univerjs/thread-comment-uiUniverThreadCommentUIPluginUniverThreadCommentMobileUIPlugin
@univerjs-pro/shape-editor-uiUniverShapeEditorUIPluginUniverShapeEditorMobileUIPlugin
@univerjs-pro/chart-uiUniverChartUIPluginUniverChartMobileUIPlugin
@univerjs-pro/exchange-clientUniverExchangeClientPluginUniverExchangeClientMobileUIPlugin
@univerjs-pro/boards-chart-uiUniverBoardsChartUIPluginUniverBoardsChartMobileUIPlugin
@univerjs-pro/boards-mind-uiUniverBoardsMindUIPluginUniverBoardsMindMobileUIPlugin
@univerjs-pro/boards-resources-uiUniverBoardsResourcesUIPluginUniverBoardsResourcesMobileUIPlugin
@univerjs-pro/boards-table-uiUniverBoardsTableUIPluginUniverBoardsTableMobileUIPlugin
@univerjs-pro/boards-thread-comment-uiUniverBoardsThreadCommentUIPluginUniverBoardsThreadCommentMobileUIPlugin

컨테이너와 터치 조작

컨테이너를 명시한 높이로 설정하고 페이지 뷰포트를 설정합니다. 100dvh는 동적 뷰포트 높이를 따릅니다. 스크롤, pinch 급상승, 텍스트 선택, 클립보드 액세스 및 대상 모바일 브라우저의 온 스크린 키보드를 테스트합니다. 데스크톱 편집기를 축소하면 모바일 플러그인으로 전환하지 않습니다.

UniverMobileUIPlugin는 disableAutoFocus: true에 기본적으로, 그래서 편집기는 초기화 도중 자동적으로 집중하지 않습니다.

HTML
<meta name="viewport" content="width=device-width, initial-scale=1" /><div id="app" style="height: 100dvh"></div>

선택적 기능 패키지

Board Editor가 대응 요소 유형이 필요할 때 기능 패키지를 추가하십시오.

Shell
pnpm add @univerjs-pro/boards-table @univerjs-pro/boards-table-uipnpm add @univerjs-pro/boards-mind @univerjs-pro/boards-mind-ui

등록 예시에는 (주), 지도 보기 및 수입 및 수출를 참조하십시오.

기타 릴리스

안정적인 출시 외에도 Univer도 알파 및 베타 채널을 게시합니다. 그들은 공식적으로 배송되지 않은 기능에 일찍 액세스 할 수 있습니다. 거래 오프는 더 높은 위험입니다. 이 빌드는 버그, 미완성 기능, 또는 불안정한 행동을 포함 할 수 있습니다. 가능한 한 생산에서 그들을 피하십시오.

Alpha / Beta 릴리스

Univer 개발 팀은 새로운 기능 또는 중요한 변화를 완료할 때 알파 또는 베타 채널에 작업을 미리 해제 할 수 있습니다. 다음 명령으로 Univer 패키지의 알파 또는 베타 빌드를 설치하십시오.

Shell
pnpm add @univerjs-pro/boards@alpha # Alpha version
pnpm add @univerjs-pro/boards@beta # Beta version

문제가 알파 또는 베타 빌드로 발생하면 피드백이 발생하거나 GitHub 문제를 통해 Univer 개발 팀에보고하십시오.

다음 단계

Footnotes

  1. peerDependencies는 호스트 프로젝트가 호환되는 버전으로 제공해야 하는 의존성입니다. 이를 통해 Univer와 애플리케이션이 React 같은 라이브러리를 공유합니다. ↩

  2. Facade는 등록된 플러그인의 기능을 애플리케이션에서 사용하는 API입니다. Facade 진입점을 가져오면 API 메서드가 추가되지만 기능 플러그인 자체가 등록되지는 않습니다. ↩

  3. 모바일 UI 플러그인은 초기화할 때 터치 컨트롤과 모바일 서비스를 선택합니다. 기기를 자동 감지하거나 창 크기 변경 시 기존 인스턴스의 모드를 바꾸지 않습니다. 모드를 변경하려면 문서 상태를 보존하고 기존 인스턴스를 폐기한 뒤 선택한 플러그인 조합으로 초기화하세요. ↩

이 가이드는 어떠셨나요?

© 2026 DreamNum Co., Ltd.