pptx-react-viewer
v4.9.0
Published
pptx-viewer for React: a PowerPoint viewer and editor component to render, edit, and export PPTX slides in the browser.
Maintainers
Readme
pptx-react-viewer
A drop-in React component that turns a
.pptxfile into a fully interactive PowerPoint: view, edit, present, collaborate, and export, entirely in the browser.

Slides render with real HTML/CSS (not <canvas>), so text stays crisp at any zoom, is selectable and screen-reader accessible, and every element is directly editable. The parsing/editing engine (pptx-viewer-core) is bundled in, so you install just one package.
▶️ Try the live demo · 📦 npm · 📖 Full docs · 🧩 Core SDK
Install
npm install pptx-react-viewerThen add the React peer dependencies your app uses (react / react-dom may be ^18.2 or ^19; both majors run the full test suite in CI):
npm install react react-dom framer-motion lucide-react react-icons jspdf jszip fast-xml-parser i18next react-i18nextThe package is named
pptx-react-vieweron npm.pptx-viewer-core(the engine) is bundled in, so you don't install it separately unless you want to call the SDK directly. Optional:three(3D models/charts, 3D SmartArt) andyjs/y-websocket/y-webrtc(real-time collaboration) are declared asoptionalDependencies, so npm installs them automatically when possible; the features degrade gracefully if they're absent.
Quick start
import { useState } from 'react';
import { PowerPointViewer } from 'pptx-react-viewer';
// Not using Tailwind? Import the bundled stylesheet once at your app entry:
import 'pptx-react-viewer/styles';
export default function App() {
const [content, setContent] = useState<Uint8Array | null>(null);
// Load any .pptx as bytes (fetch, <input type="file">, drag-drop, …)
const onPick = (e: React.ChangeEvent<HTMLInputElement>) =>
e.target.files?.[0]?.arrayBuffer().then((buf) => setContent(new Uint8Array(buf)));
return (
<div style={{ height: '100vh' }}>
{content ? (
<PowerPointViewer content={content} canEdit />
) : (
<input type='file' accept='.pptx' onChange={onPick} />
)}
</div>
);
}The component fills its parent, so give the parent a height. That's the whole setup: open a file and you have a working viewer/editor.
To read the edited presentation back out as bytes, pass a ref and call getContent():
import { useRef } from 'react';
import { PowerPointViewer, type PowerPointViewerHandle } from 'pptx-react-viewer';
const viewerRef = useRef<PowerPointViewerHandle>(null);
// <PowerPointViewer ref={viewerRef} content={content} canEdit />
const bytes = await viewerRef.current?.getContent(); // Uint8Array of a valid .pptxFeatures
| Feature | Description | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | | View | Render slides with 16 element types: shapes, text, images, tables, 23 chart types, SmartArt, connectors, media, ink, OLE, 3D models, zoom | | Edit | Insert/move/resize/delete elements, edit text inline, modify styles, manage slides | | Present | Fullscreen slideshow with 39 animation presets and 26 motion paths, 57 transitions (including morph), speaker notes, presenter view with timer | | Export | PNG/SVG/PDF/GIF/video/JSON slide export, save-as PPTX | | Collaborate | Real-time multi-user editing (powered by Yjs) with live presence, remote cursors, and user avatars | | Print | Print dialog with handout layouts and notes page formatting with overflow pagination | | Annotate | Pen/highlighter/laser pointer tools during presentations | | Find & Replace | Cross-slide text search with regex support | | Accessibility | Keyboard navigation, alt-text audit panel, screen reader support | | 3D | GLB/GLTF model rendering via Three.js, 3D surface charts, CSS 3D shape/text extrusion |
API reference
PowerPointViewer props
| Prop | Type | Default | Description |
| -------------------------------------------------------------------------- | --------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| content | Uint8Array | required | Raw .pptx file bytes |
| filePath | string | n/a | Optional file path (for display and autosave recovery) |
| fileName | string | n/a | Display name of the open document, shown in the title bar |
| className | string | n/a | Class applied to the root element |
| canEdit | boolean | false | Enable editing mode |
| fonts | ViewerFontSource[] | n/a | Licensed font sources supplied by the host application |
| authorName | string | n/a | Author name for comments/annotations and collaboration presence |
| collaboration | CollaborationConfig | n/a | Yjs real-time collaboration config (server URL, room, role) |
| shareDefaults | { roomId?, userName?, serverUrl? } | n/a | Seed values for the Share dialog fields |
| smartArt3D | boolean | false | Opt-in Three.js 3D SmartArt renderer (needs the optional three dependency; falls back to SVG without it) |
| surfaceChart3D, barChart3D, lineChart3D, areaChart3D, pieChart3D | boolean | false | Independently opt in to interactive Three.js renderers for the matching 3D chart kinds; each falls back to SVG when WebGL is unavailable. |
| ai | PptxAiConfig | n/a | Optional AI assistant configuration. The SDK peers load only when its panel is opened. |
| onOpenFile | () => void | n/a | Host override for File > Open; bypasses the built-in file picker |
| onContentChange | (content: Uint8Array) => void | n/a | Called with freshly serialised .pptx bytes when the content changes |
| onDirtyChange | (isDirty: boolean) => void | n/a | Called when dirty state changes |
| onActiveSlideChange | (index: number) => void | n/a | Called when the active slide changes |
| onModeChange | (mode: ViewerMode) => void | n/a | Called when the viewer mode changes |
| onZoomChange | (zoom: number) => void | n/a | Called when the zoom level changes |
| onSelectionChange | (ids: string[]) => void | n/a | Called when element selection changes |
| onSlideCountChange | (count: number) => void | n/a | Called when the total slide count changes |
| onStartCollaboration | (config: CollaborationConfig) => void | n/a | Called when the user starts a collaboration session from the Share dialog |
| onStopCollaboration | () => void | n/a | Called when the collaboration session stops |
| theme | ViewerTheme | n/a | Theme configuration for customising colours, radius, and CSS vars |
| hiddenActions | ToolbarActionId[] | n/a | Hide individual toolbar buttons and/or ribbon tabs (e.g. ['share', 'broadcast']) instead of the whole toolbar; omitted hides nothing |
| customization | ViewerCustomization | - | Hide, lock or remap any part of the UI (ribbon tabs/buttons, File > Options pages/sections/settings, File tab, context menus, shortcuts, panels, AI/collaboration, dialogs); the same helpers (hideRibbonTab, lockSetting, ...) are on the ref handle. See the UI Customization guide. |
| defaultThemeKey | string | n/a | Initial File > Options > Appearance selection when no persisted preference exists |
| availableThemes | ThemeCatalogEntry[] | n/a | Theme choices offered by File > Options > Appearance (defaults to the built-in catalog) |
| onThemeChange | (key: string) => void | n/a | Host hook for the appearance picker; when set, the host owns persisting the choice |
| defaultLocale | string | n/a | Initial locale code when no persisted preference exists |
| availableLocales | LocaleCatalogEntry[] | n/a | Locale choices offered by File > Options > Language (defaults to the registered i18next locales) |
| onLocaleChange | (code: string) => void | n/a | Host hook for the language picker; when set, the host owns applying/persisting the switch |
| accountAuth | AccountAuthConfig | n/a | Optional sign-in hook point for File > Account (disabled unless enabled: true) |
PowerPointViewerHandle (via ref)
| Method | Signature | Description |
| ----------------------- | ---------------------------- | ---------------------------------------- |
| getContent | () => Promise<Uint8Array> | Serialise current state to .pptx bytes |
| goTo | (index: number) => void | Navigate to a slide by zero-based index |
| goPrev | () => void | Navigate to the previous slide |
| goNext | () => void | Navigate to the next slide |
| undo | () => void | Undo the last editing action |
| redo | () => void | Redo the last undone action |
| canUndo | () => boolean | Whether an undo action is available |
| canRedo | () => boolean | Whether a redo action is available |
| getZoom | () => number | Get the current zoom level (1 = 100%) |
| setZoom | (level: number) => void | Set the zoom level |
| zoomIn | () => void | Zoom in by one step |
| zoomOut | () => void | Zoom out by one step |
| zoomReset | () => void | Reset zoom to 100% |
| getMode | () => ViewerMode | Get the current viewer mode |
| setMode | (mode: ViewerMode) => void | Switch mode programmatically |
| getActiveSlideIndex | () => number | Get the zero-based active slide index |
| getSlideCount | () => number | Get the total number of slides |
| isDirty | () => boolean | Whether the document has unsaved changes |
| getSelectedElementIds | () => string[] | Get IDs of selected elements |
| selectElements | (ids: string[]) => void | Programmatically select elements by ID |
| clearSelection | () => void | Clear the current selection |
The handle implements the full shared PowerPointViewerAPI, so the following
slide/element manipulation methods are also available:
setActiveSlideIndex(index), getSlides(), getSlide(index),
getActiveSlide(), addSlide(afterIndex?), deleteSlides(indexes),
duplicateSlides(indexes), moveSlide(from, to), toggleHideSlides(indexes),
getElements(slideIndex?), getElementById(id, slideIndex?),
addElement(element), updateElement(id, patch), deleteElements(ids), and
duplicateElement(id).
See element insertion
for the addElement contract, including the headless handle, and a core-factory example.
renderToCanvas
Standalone utility for rendering a DOM element to a Canvas (with an oklch colour-space workaround):
import { renderToCanvas } from 'pptx-react-viewer';
const canvas = await renderToCanvas(element, options); // => HTMLCanvasElementViewport fit options
<PowerPointViewer content={content} fitPadding={0} maxFitScale={null} />fitPadding accepts a per-side CSS-pixel number or { horizontal, vertical }.
maxFitScale accepts a positive ceiling or null for unlimited enlargement.
Omission preserves React's 4 px horizontal / 16 px vertical padding and fit
ceiling of 1. These host options do not change the document or user zoom; ruler
space and surrounding chrome remain separate. See the cross-binding defaults.
Composing a custom viewer shell
<PowerPointViewer> bundles a full editor chrome (toolbar, canvas, side panels, dialogs, presentation mode). If you only need the toolbar and slide canvas, with your own layout around them, Toolbar and SlideCanvas are exported as standalone components, and useViewerBuildingBlocks wires up the same state and hooks PowerPointViewer uses internally, mapped into the flat props those two components expect:
import { Toolbar, SlideCanvas, useViewerBuildingBlocks } from 'pptx-react-viewer';
function MyCustomViewer({ content }: { content: Uint8Array }) {
// Also returned: `mode` (current ViewerMode) and `autosaveStatus`
const { toolbarProps, canvasProps, loading, error } = useViewerBuildingBlocks({
content,
canEdit: true,
fitPadding: 0,
maxFitScale: null,
});
if (loading) return <p>Loading…</p>;
if (error) return <p>Failed to load: {error}</p>;
return (
<div style={{ display: 'flex', flexDirection: 'column', height: 540, minHeight: 0 }}>
<Toolbar {...toolbarProps} />
<SlideCanvas {...canvasProps} showRulers={false} />
</div>
);
}The example disables rulers for edge-aligned fitting. Existing ruler offsets are
unchanged when rulers are enabled; fitPadding: 0 does not remove those offsets.
The toolbar also uses part of the host height, so the canvas fits its remaining
viewport rather than the whole 540 px host.
useViewerBuildingBlocks accepts the same content / canEdit / filePath / hiddenActions / onDirtyChange-style inputs as PowerPointViewer, plus onOpenSettings / onOpenHeaderFooter / onOpenShareDialog callbacks (fired by the corresponding toolbar buttons) since this composition doesn't render those dialogs itself. It's an additive alternative, not a replacement: dialogs, presentation-mode overlays, mobile chrome, resizable side panels, and real-time collaboration are all part of PowerPointViewer and are out of scope for these building blocks. Reach for PowerPointViewer when you need the full editor; reach for useViewerBuildingBlocks when you're assembling your own chrome around just the toolbar and canvas.
Styling & theming
The viewer's UI references CSS custom properties (--pptx-*, the shadcn/ui token convention) for every visual token, so it works three ways:
- Tailwind CSS v4 project: the viewer classes resolve through your existing Tailwind tokens. No extra CSS import needed.
- No Tailwind: import the bundled stylesheet once at your app entry:
import 'pptx-react-viewer/styles'; - CSS custom properties: define the
--pptx-*properties yourself for full control.
Override specific values with the theme prop:
<PowerPointViewer
content={bytes}
theme={{
colors: { primary: '#6366f1', background: '#0f172a' },
radius: '0.5rem',
}}
/>All ViewerTheme.colors keys are optional; override only what you need. Helpers defaultThemeColors, defaultRadius, themeToCssVars, defaultCssVars, ViewerThemeProvider, and useViewerTheme are exported for advanced use. See the full docs for the complete token list.
Two ready-made presets ship with the package: vermilionLightTheme (warm paper canvas) and vermilionDarkTheme (dimmed presenter room), the same vermilion brand look as the documentation site:
import { PowerPointViewer, vermilionLightTheme } from 'pptx-react-viewer';
<PowerPointViewer content={bytes} theme={vermilionLightTheme} />;The underlying palettes (vermilionLightColors, vermilionDarkColors) and radius (vermilionRadius) are exported too, so you can spread them into your own variant.
Localization (i18n)
UI labels go through i18next / react-i18next with dotted keys such as pptx.statusBar.allSaved. Initialise an i18next instance and wrap your app in I18nextProvider (the demo's demo/i18n.ts shows a minimal config, including a parseMissingKeyHandler that derives Title Case labels for any key you don't explicitly translate). pptx-react-viewer/i18n exports translationsEn (the English dictionary), keyToLabel (the fallback), and a TranslationKey type you can use to type-check a new locale dictionary (Record<TranslationKey, string>) at compile time. Add a new language by supplying a resource bundle under its language code. See the Localization guide for full wiring examples and how to contribute a translation upstream; the live demo's language picker is a working reference.
How it's built
You only need the <PowerPointViewer> component; everything else is internal. Behind it, the logic lives in many small, focused React hooks, and the components themselves just draw what those hooks produce. Slides are rendered as ordinary HTML and CSS (charts as inline SVG, tables as real <table> elements), which is why text stays sharp, selectable, and accessible. For the full component tree, the rendering pipeline, the animation and transition engine, connector routing, collaboration, and a file-by-file map, see the full documentation.
A small curated set of those hooks is exported from pptx-react-viewer/viewer with a stable API; the complete set (80+) is also importable from pptx-react-viewer/internals for advanced integrations. The internals subpath is not covered by semver: prefer the stable root exports. See the Hooks reference for the full list.
The bulk of that cross-framework logic (colour/geometry/connector/animation/chart math, slide
transitions, and more) actually lives in pptx-viewer-shared, an internal package that is
never published to npm. If you need one of those framework-neutral helpers directly, for
example the slide-transition resolver/keyframes (resolveSlideTransition,
resolveTransitionDurationMs, SLIDE_TRANSITION_KEYFRAMES) or the PresentationTransitionOverlay
component behind presentation mode, they are re-exported from pptx-react-viewer/internals too,
so you never need pptx-viewer-shared yourself.
Limitations
CSS-based rendering trades a few visual effects for crisp text, accessibility, and DOM interactivity: backdrop-filter becomes semi-transparent backgrounds and path gradients approximate as elliptical radials, while mix-blend-mode and CSS 3D transforms render natively on screen but flatten in raster export. Text uses fonts available in the browser (embedded fonts are injected when present). Media playback depends on browser codec support. SmartArt is decomposed into editable shapes with a live reflow engine for structural edits. Charts are editable directly on the canvas (hover a mark for its tooltip, click to select, drag it to a new value, double-click the title to rename), except for stacked/percent-stacked, pie, radar, surface and map kinds, which are click-to-select and edited in the inspector data grid. 3D models need the optional Three.js peer. See the full docs for the complete list.
Reference translations
Optional French, Spanish, German, and Simplified Chinese dictionaries ship with this package. Import only the language you need:
import { translationsZhCN } from 'pptx-react-viewer/i18n/zh-CN';The other subpaths are i18n/fr (translationsFr), i18n/es
(translationsEs), and i18n/de (translationsDe). See the
localization guide
for registration and runtime switching. Existing English imports are unchanged.
License
Apache-2.0. Please keep the NOTICE file with redistributions.
