Skip to content

DOCXKIT_PREVIEW_RENDER_FAILED: Preview rendering failed ​

The local docx-preview renderer rejected the document.

What to do ​

  1. Check that the input is a valid DOCX ZIP archive.
  2. Inspect the original renderer cause; try opening the same file in Word.

Problem example ​

ts
import { createDocx, createDocxPreview } from 'docx-kit'

const container = document.createElement('div')
document.body.append(container)

const preview = createDocxPreview(container)
try {
  await preview.render(new Blob(['plain text']))
} finally { preview.destroy() }

Corrected example ​

ts
import { createDocx, createDocxPreview } from 'docx-kit'

const container = document.createElement('div')
document.body.append(container)

const preview = createDocxPreview(container)
try {
  await preview.render(await createDocx().p('Hello').toBlob())
} finally { preview.destroy() }

Common causes ​

  • Corrupt archives, unsupported content, or a renderer exception.

Diagnostic fields ​

Example message ​

text
Failed to render DOCX preview

Released under the MIT License.