@pptx-editor.
v0.3.1 · 4 published subpaths with full TypeScript signatures and JSDoc.
Subpaths
@pptx-editor.dev/pro/drawing
`@pptx-editor.dev/pro/drawing`: advanced drawing rendering.
@pptx-editor.dev/pro/react
`@pptx-editor.dev/pro/react`: the comments pane and the review hooks for the React adapter, and the review module, so a host imports one path, as DOCX Editor's `@docx-editor.dev/pro/react`. `@pptx-editor.dev/core` and `@pptx-editor.dev/react` stay peers, so one engine instance loads.
@pptx-editor.dev/pro/vue
`@pptx-editor.dev/pro/vue`: the comments pane and the review composables for the Vue adapter, and the review module, so a host imports one path, as DOCX Editor's `@docx-editor.dev/pro/vue`. `@pptx-editor.dev/core` and `@pptx-editor.dev/vue` stay peers, so one engine instance loads.
Package root
@pptx-editor.dev/pro: review and realtime collaboration, as EditorModules.
Registering a module is the whole enablement story, as in DOCX Editor's pro package.
Functions (4)
collaborationModulefunctionSource ↗
The collaboration module. Register it with createPptxEditor({ modules: [collaborationModule({ session })] }).
declare function collaborationModule(options: CollaborationModuleOptions): EditorModule;createYjsCollaborationSessionfunctionSource ↗
Create a session over a Y.Doc. Register it with collaborationModule({ session }). Throws CollaborationSchemaError for an invalid document id or identity.
declare function createYjsCollaborationSession(options: YjsCollaborationSessionOptions): YjsCollaborationSession;legacyCommentsfunctionSource ↗
Every legacy comment of every slide, in slide order and then file order.
declare function legacyComments(pkg: PptxPackage): ReviewItem[];reviewModulefunctionSource ↗
The review module. Register it with createPptxEditor({ modules: [reviewModule()] }): the editor snapshot then reports the current slide's comment threads (comments), the slide shows a marker for each thread, and collectReviewItems reads every comment of the deck. Render PptxEditorReview from @pptx-editor.dev/pro/react or /vue for the comments pane.
declare function reviewModule(options?: ReviewModuleOptions): EditorModule;Classes (1)
CollaborationSchemaErrorclassSource ↗
Typed collaboration schema or trust-boundary failure, thrown for invalid factory input. Use code for application logic; detail is diagnostic information.
declare class CollaborationSchemaError extends Error| Member | Type | Summary |
|---|---|---|
| (constructor) | | Constructs a new instance of the `CollaborationSchemaError` class |
| code | CollaborationFailureCode | Stable failure code. Branch on it. |
| detail? | string | undefined | Bounded diagnostic text for logs. Not a parsing contract. |
Interfaces (6)
AwarenessLikeinterfaceSource ↗
The minimal awareness surface the session uses (y-protocols/awareness's Awareness).
interface AwarenessLike| Member | Type | Summary |
|---|---|---|
| clientID | number | This replica's awareness client id. |
| getStates | | Every connected client's state, by client id. |
| off | | Stop listening to state changes. |
| on | | Listen to changes of any client's state. |
| setLocalStateField | | Set one field of this replica's state; peers see it on their next update. |
CollaborationModuleOptionsinterfaceSource ↗
Options of collaborationModule.
interface CollaborationModuleOptions extends ProLicenseOptions| Member | Type | Summary |
|---|---|---|
| session | EditorCollaborationSession | A ready session, for example from `createYjsCollaborationSession`. |
ProLicenseOptionsinterfaceSource ↗
Accepted by every pro entry point.
interface ProLicenseOptions| Member | Type | Summary |
|---|---|---|
| licenseKey? | string | Your license key. Optional: evaluation use is permitted, production use requires a commercial agreement under the EigenPal Pro License (see LICENSE.md). |
ReviewModuleOptionsinterfaceSource ↗
Options of reviewModule.
interface ReviewModuleOptions extends ProLicenseOptions| Member | Type | Summary |
|---|---|---|
| displayModes? | readonly ReviewDisplayMode[] | Display modes to unlock. Default: `final` and `markup`. |
| pane? | ReviewPaneOptions | The comment view settings, as DOCX Editor's `pane` option: `commentMarkers` (`'icon'`, the default, or `'initials'`) sets how a comment marker on the slide looks, and `opening` (`'auto'`, the default, or `'manual'`) sets whether a press on a marker asks for the **Comments** tab of the side panel. An unknown field or value throws a `TypeError`. |
YjsCollaborationSessioninterfaceSource ↗
A session over a Y.Doc.
interface YjsCollaborationSession extends EditorCollaborationSession| Member | Type | Summary |
|---|---|---|
| setConnected | | Report the provider's connection. `false` sets `disconnected` with `transport-disconnected`; edits continue and merge on reconnect. `true` returns to `ready`. Call it from the provider's status event. |
YjsCollaborationSessionOptionsinterfaceSource ↗
Options of createYjsCollaborationSession.
interface YjsCollaborationSessionOptions| Member | Type | Summary |
|---|---|---|
| awareness? | AwarenessLike | Yjs awareness for presence (`new Awareness(doc)` from `y-protocols/awareness`), usually the provider's. Absent, the session lists only the local participant. |
| doc | Y.Doc | The shared document. The host connects it to a provider. |
| documentId | string | The room's document identity. |
| identity | CollaborationIdentity | The local author. |