@mkabatek/pptx-viewer 1.5.2 → 1.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
# pptx-viewer
|
|
1
|
+
# @mkabatek/pptx-viewer
|
|
2
|
+
|
|
3
|
+
> **This is a fork of [ChristopherVR/pptx-viewer](https://github.com/ChristopherVR/pptx-viewer), published as `@mkabatek/pptx-viewer` on npm.**
|
|
4
|
+
> Full credit for the library design, implementation, and documentation goes to the original author.
|
|
5
|
+
> See the [fork changelog](https://github.com/mkabatek/pptx-viewer#fork-changes) for what was changed and why.
|
|
2
6
|
|
|
3
7
|
A full-featured **React** component for viewing, editing, and presenting PowerPoint (.pptx) files in the browser. Built on top of `pptx-viewer-core`, it provides a complete UI with toolbar, inspector panels, slide canvas, animation engine, presentation mode, real-time collaboration, and export capabilities.
|
|
4
8
|
|
|
@@ -74,12 +78,12 @@ This package provides a drop-in React component that turns raw `.pptx` bytes int
|
|
|
74
78
|
## Quick Start
|
|
75
79
|
|
|
76
80
|
```tsx
|
|
77
|
-
import { PowerPointViewer } from 'pptx-viewer';
|
|
78
|
-
import type { PowerPointViewerHandle } from 'pptx-viewer';
|
|
81
|
+
import { PowerPointViewer } from '@mkabatek/pptx-viewer';
|
|
82
|
+
import type { PowerPointViewerHandle } from '@mkabatek/pptx-viewer';
|
|
79
83
|
import { useRef, useEffect, useState } from 'react';
|
|
80
84
|
|
|
81
85
|
// If your project does NOT use Tailwind CSS, import the bundled stylesheet:
|
|
82
|
-
import 'pptx-viewer/styles';
|
|
86
|
+
import '@mkabatek/pptx-viewer/styles';
|
|
83
87
|
|
|
84
88
|
function App() {
|
|
85
89
|
const viewerRef = useRef<PowerPointViewerHandle>(null);
|
|
@@ -150,7 +154,7 @@ Exposed via `ref`. Extends `FileViewerHandle`.
|
|
|
150
154
|
Standalone utility for rendering a DOM element to a Canvas with oklch colour space workaround.
|
|
151
155
|
|
|
152
156
|
```typescript
|
|
153
|
-
import { renderToCanvas } from 'pptx-viewer';
|
|
157
|
+
import { renderToCanvas } from '@mkabatek/pptx-viewer';
|
|
154
158
|
|
|
155
159
|
const canvas = await renderToCanvas(element, options);
|
|
156
160
|
// => HTMLCanvasElement with the rendered content
|
|
@@ -183,8 +187,8 @@ Import the self-contained CSS file that ships with the package. It includes all
|
|
|
183
187
|
|
|
184
188
|
```tsx
|
|
185
189
|
// Import once at your app's entry point
|
|
186
|
-
import 'pptx-viewer/styles';
|
|
187
|
-
// or: import "pptx-viewer/styles.css";
|
|
190
|
+
import '@mkabatek/pptx-viewer/styles';
|
|
191
|
+
// or: import "@mkabatek/pptx-viewer/styles.css";
|
|
188
192
|
```
|
|
189
193
|
|
|
190
194
|
Then optionally customise with the `theme` prop or by setting CSS custom properties in your own stylesheet.
|
|
@@ -219,7 +223,7 @@ If you want full control, define the `--pptx-*` custom properties yourself and s
|
|
|
219
223
|
### `ViewerTheme` reference
|
|
220
224
|
|
|
221
225
|
```typescript
|
|
222
|
-
import type { ViewerTheme } from 'pptx-viewer';
|
|
226
|
+
import type { ViewerTheme } from '@mkabatek/pptx-viewer';
|
|
223
227
|
|
|
224
228
|
const myTheme: ViewerTheme = {
|
|
225
229
|
colors: {
|
|
@@ -263,7 +267,7 @@ import {
|
|
|
263
267
|
defaultCssVars, // Get all default --pptx-* CSS vars
|
|
264
268
|
ViewerThemeProvider, // React context provider (advanced)
|
|
265
269
|
useViewerTheme, // Hook to read current theme from context
|
|
266
|
-
} from 'pptx-viewer';
|
|
270
|
+
} from '@mkabatek/pptx-viewer';
|
|
267
271
|
```
|
|
268
272
|
|
|
269
273
|
### Light theme example
|