설치 및 기본 사용법
이 페이지는 Univer 슬라이드를 설치하고 페이지에 편집기를 렌더링하는 방법을 설명합니다. 예를 들어 Web SDK Slides 패키지를 사용합니다. Univer는 슬라이드를 아직 제공하지 않습니다. 응용 프로그램은 플러그인 모드에서 조립됩니다.
Univer의 핵심 개념과 비교되지 않은 경우 퀵스타트를 먼저 읽어보십시오.
Univer는 두 가지 통합 모드를 제공합니다. Preset Mode 및 Plugin Mode. Preset Mode는 조립 작업의 대부분을 제거하는 사전 구성 플러그인 번들을 공급합니다. 각 플러그인이 선택되고 구성되는 플러그인 모드를 사용하여 깊은 주문화 또는 연장 사용 플러그인 모드가 필요합니다.
플러그인 모드로 설정하기
Univer는 플러그인 세트로 슬라이드를 배포합니다. 브라우저 편집기는 일반적으로 공유 Univer 런타임, 라이센스 플러그인, 문서 및 그림 의존성을 등록하고 슬라이드 모델과 UI 플러그인을 등록합니다.
패키지 관리자 사용
구조 공구는 ES 단위를 지원하고 package.json에 있는 exports 분야를 지원해야 합니다.
설치
Univer는 데이터 스트림에 대한 UI 및 RxJS의 React를 사용하고 Vue 또는 Angular 응용 프로그램에 내장 할 수 있습니다. react, react-dom 및 rxjs 피어 의존성1가 설치되어야합니다. 아래의 원사 명령은 명시적으로 포함합니다.
모든 @univerjs/* 및 @univerjs-pro/* 패키지는 같은 버전에서 유지해야합니다.
pnpm add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/slides @univerjs-pro/slides-uinpm install @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/slides @univerjs-pro/slides-uiyarn add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/slides @univerjs-pro/slides-ui react react-dom rxjsbun add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/drawing @univerjs/engine-render @univerjs/ui @univerjs-pro/license @univerjs-pro/slides @univerjs-pro/slides-ui사용법
컨테이너를 만들고 Univer를 초기화하기 전에 명시적 높이를 부여하십시오.
<div id="app" style="height: 600px"></div>FUniver.newAPI(univer)를 호출하기 전에 다음 단계에 사용되는 정면 항목을 가져옵니다. @univerjs/design CSS를 먼저 가져 와서 @univerjs/ui의 CSS 및 제품 CSS가 지속됩니다.
주의
- 모든 슬라이드 플러그인 전에
UniverLicensePlugin등록. - UI CSS 전에 공유 UI CSS를 가져옵니다.
- 인쇄, 테이블, 차트 및 수입 / 수출과 같은 옵션 패키지를 추가하면 제품이 필요합니다.
UniverSlidesUIPlugin는 모양을 위해 그것의 자신의에UniverProFormulaEnginePlugin를 적재합니다. 동일한Univer인스턴스가 또한UniverFormulaEnginePlugin을 등록하고@univerjs-pro/engine-formula설치하고 초기화 부호에UniverProFormulaEnginePlugin와 엔진의 수입 그리고 등록을 대체하십시오. 공식 엔진을 둘 다 등록하지 마십시오.
stylesheets, locale packs 및 필요한 플러그인 가져 오기 :
TypeScriptimport { UniverLicensePlugin } from '@univerjs-pro/license'import { UniverSlidesPlugin } from '@univerjs-pro/slides'import { UniverSlidesUIPlugin } from '@univerjs-pro/slides-ui'import SlidesUIEnUS from '@univerjs-pro/slides-ui/locale/en-US'import SlidesEnUS from '@univerjs-pro/slides/locale/en-US'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 { 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-pro/slides-ui/lib/index.css'Facade API2를 사용하려면 외관 항목을 가져와야합니다.
TypeScriptimport { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/slides/facade'Univer 인스턴스를 생성하고 플러그인을 등록하고 슬라이드 유닛을 만듭니다.
TypeScriptconst univer = new Univer({ locale: LocaleType.EN_US, locales: { [LocaleType.EN_US]: mergeLocales( DesignEnUS, UIEnUS, DocsUIEnUS, SlidesEnUS, SlidesUIEnUS, ), },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app',})univer.registerPlugin(UniverDocsPlugin)univer.registerPlugin(UniverDocsUIPlugin)univer.registerPlugin(UniverDrawingPlugin)univer.registerPlugin(UniverLicensePlugin, { license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverSlidesPlugin)univer.registerPlugin(UniverSlidesUIPlugin)univer.createUnit(UniverInstanceType.UNIVER_SLIDE, {})const univerAPI = FUniver.newAPI(univer)
univerAPI는 FUniver.newAPI(univer)가 Univer의 Facade API입니다. 이 응용 프로그램은 프레젠테이션을 만들고 슬라이드 API를 호출하는 데 사용됩니다.
플러그인 설정
UniverUIPlugin
containerstring | HTMLElement편집기를 마운트할 DOM 요소 또는 요소 ID입니다.
UniverLicensePlugin
licensestring클라이언트 라이선스 파일의 내용입니다.
univer.registerPlugin 및 univer.registerPlugins 메서드
univer.registerPlugin를 호출하면 Univer 인스턴스를 생성하여 단일 플러그인을 등록합니다.
서명은 univer.registerPlugin(Plugin, options)입니다. Plugin는 플러그인 클래스이며 options은 플러그인의 구성을 보유하고 있습니다.
univer.registerPlugins는 배열을 받아들이고 하나의 호출에서 여러 플러그인을 등록합니다. 이 양식은 플러그인 목록이 한 곳에서 유지되어야 할 때 편리합니다.
univer.registerPlugins([ UniverRenderEnginePlugin, [UniverUIPlugin, { container: 'app', }], UniverDocsPlugin, UniverDocsUIPlugin, UniverDrawingPlugin, [UniverLicensePlugin, { license: process.env.CLIENT_LICENSE_TEXT, }], UniverSlidesPlugin, UniverSlidesUIPlugin,])선택적 기능 패키지
편집기가 대응 기능을 필요로 할 때 기능 패키지를 설치하십시오.
pnpm add @univerjs-pro/slides-printpnpm add @univerjs-pro/slides-table @univerjs-pro/slides-table-uipnpm add @univerjs-pro/chart-ui @univerjs-pro/slides-chart @univerjs-pro/slides-chart-uipnpm add @univerjs-pro/slides-exchange-client등록 예제는 제품정보, (주), 팟캐스트 및 수입 및 수출에서 제공됩니다.
선택적 플러그인 지연 로드
플러그인 모드는 또한 기능 플러그인이 제품을 필요로 할 때만 로드 될 수 있습니다:
univer.createUnit(UniverInstanceType.UNIVER_SLIDE, {})import('@univerjs-pro/slides-chart').then(({ UniverSlidesChartPlugin }) => { univer.registerPlugin(UniverSlidesChartPlugin)})서버 측 사용법
Node.js에서 모델 플러그인을 등록하고 브라우저 UI 플러그인을 omit:
univer.registerPlugin(UniverSlidesPlugin)모델 플러그인은 헤드리스 스냅 샷 처리를 수행합니다. 협업 또는 파일 변환 API를 노출하면 해당 Server SDK 모듈가 필요합니다. 이 플러그인을 등록하면 해당 서비스를 만들 수 없습니다.
모바일 지원
이 예제는 아래 나열된 모바일 플러그인을 내보내는 SDK 패키지가 필요합니다. 모든 @univerjs/* 및 @univerjs-pro/* 의존성은 같은 버전에 남아 있어야 합니다.
1.0.0-rc.0는 UniverSlidesMobileUIPlugin를 수출하지 않습니다. 예를 들어,이 모바일 항목이 포함 된 빌드를 선택하십시오.
Univer 슬라이드의 터치 컨트롤은 모바일 UI 플러그인.3 편집기를 만들기 전에 UI 모드를 결정한다.
위의 플러그인 모드 예에서 제품 설명는 createUnit() 이전에 UI 가져 오기 및 등록을 가져옵니다. 이미 초기화 된 데스크톱 편집기에 추가하지 마십시오. 모델 플러그인, 엔진, 로컬 파일, CSS 및 Facade 가져 오기를 유지하십시오. 데스크탑 및 모바일 클래스는 동일한 패키지 항목에서 수출을 지명합니다.
UniverMobileUIPlugin
containerstring | HTMLElement편집기를 마운트할 DOM 요소 또는 요소 ID입니다.disableAutoFocustrue기본값:true시작할 때 편집기에 자동으로 포커스를 주지 않습니다.
import { UniverSlidesMobileUIPlugin } from '@univerjs-pro/slides-ui'import { UniverDocsMobileUIPlugin } from '@univerjs/docs-ui'import { UniverMobileUIPlugin } from '@univerjs/ui'univer.registerPlugin(UniverMobileUIPlugin, { container: 'app' })univer.registerPlugin(UniverDocsMobileUIPlugin)univer.registerPlugin(UniverSlidesMobileUIPlugin)플러그인 대응표
사용 기능만 등록하고 모델 플러그인 및 필수 종속성을 유지하십시오. 모바일 UI 수출은 데스크톱 및 모바일이 동일한 컨트롤을 제공한다는 것을 의미하지 않습니다. Pro 기능은 여전히 적절한 라이센스가 필요합니다. 백엔드가 Univer Server SDK와 애플리케이션 측면 통합이 필요합니다.
| 패키지 | 데스크톱 등록 | 모바일 등록 |
|---|---|---|
@univerjs/ui | UniverUIPlugin | UniverMobileUIPlugin |
@univerjs/docs-ui | UniverDocsUIPlugin | UniverDocsMobileUIPlugin |
@univerjs-pro/slides-ui | UniverSlidesUIPlugin | UniverSlidesMobileUIPlugin |
@univerjs/drawing-ui | UniverDrawingUIPlugin | UniverDrawingMobileUIPlugin |
@univerjs/thread-comment-ui | UniverThreadCommentUIPlugin | UniverThreadCommentMobileUIPlugin |
@univerjs-pro/shape-editor-ui | UniverShapeEditorUIPlugin | UniverShapeEditorMobileUIPlugin |
@univerjs-pro/chart-ui | UniverChartUIPlugin | UniverChartMobileUIPlugin |
@univerjs-pro/exchange-client | UniverExchangeClientPlugin | UniverExchangeClientMobileUIPlugin |
@univerjs-pro/slides-chart-ui | UniverSlidesChartUIPlugin | UniverSlidesChartMobileUIPlugin |
@univerjs-pro/slides-print | UniverSlidesPrintPlugin | UniverSlidesPrintMobilePlugin |
@univerjs-pro/slides-table-ui | UniverSlidesTableUIPlugin | UniverSlidesTableMobileUIPlugin |
@univerjs-pro/slides-thread-comment-ui | UniverSlidesThreadCommentUIPlugin | UniverSlidesThreadCommentMobileUIPlugin |
컨테이너와 터치 조작
컨테이너는 명시된 높이와 페이지 뷰포트가 구성되어야 합니다. 100dvh는 동적 뷰포트 높이를 따릅니다. 스크롤, pinch 급상승, 텍스트 선택, 클립보드 액세스 및 대상 모바일 브라우저의 온 스크린 키보드를 테스트합니다. 데스크톱 편집기를 모바일 플러그인으로 전환하지 않습니다.
UniverMobileUIPlugin는 disableAutoFocus: true에 기본적으로, 그래서 편집기는 초기화 도중 자동적으로 집중하지 않습니다.
<meta name="viewport" content="width=device-width, initial-scale=1" /><div id="app" style="height: 100dvh"></div>기타 릴리스
Univer는 알파 / 베타 채널을 배포하여 안정적인 출시를 함께합니다. 그들은 더 높은 위험 비용으로 공식 출시 전에 사용할 수있는 새로운 기능을 만듭니다. 이 버전은 버그, 불완전한 기능, 또는 불안정한 기능을 포함 할 수 있으므로 가능한 생산에서 피해야 합니다.
Alpha / Beta 릴리스
Univer 팀은 새로운 기능 또는 중요한 변화를 완료하면 알파 또는 베타 채널에 작업을 미리 릴리스 할 수 있습니다. 다음과 같이 Univer 패키지의 알파 / 베타 버전을 설치하십시오.
pnpm add @univerjs-pro/slides@alpha # Alpha version
pnpm add @univerjs-pro/slides@beta # Beta versionnpm install @univerjs-pro/slides@alpha # Alpha version
npm install @univerjs-pro/slides@beta # Beta versionyarn add @univerjs-pro/slides@alpha # Alpha version
yarn add @univerjs-pro/slides@beta # Beta versionbun add @univerjs-pro/slides@alpha # Alpha version
bun add @univerjs-pro/slides@beta # Beta versionGitHub 문제를 통해 알파 / 베타 버전에서 Univer 팀에 대한 문제 및 피드백을보고하십시오.
다음 단계
- Facade API를 통해 슬라이드를 운영하는 방법을 알아보세요.
- 라이선스 설정
- Server SDK 통합
- 기능 섹션에서 필요한 기능 플러그인을 추가하세요.
Footnotes
-
peerDependencies는 호스트 프로젝트가 호환되는 버전으로 제공해야 하는 의존성입니다. 이를 통해 Univer와 애플리케이션이 React 같은 라이브러리를 공유합니다. ↩ -
Facade는 등록된 플러그인의 기능을 애플리케이션에서 사용하는 API입니다. Facade 진입점을 가져오면 API 메서드가 추가되지만 기능 플러그인 자체가 등록되지는 않습니다. ↩
-
모바일 UI 플러그인은 초기화할 때 터치 컨트롤과 모바일 서비스를 선택합니다. 기기를 자동 감지하거나 창 크기 변경 시 기존 인스턴스의 모드를 바꾸지 않습니다. 모드를 변경하려면 문서 상태를 보존하고 기존 인스턴스를 폐기한 뒤 선택한 플러그인 조합으로 초기화하세요. ↩
이 가이드는 어떠셨나요?