Skip to content

Commit a8d0591

Browse files
committed
Update Render Plugin Docs
Updated the Render Plugin documentation for Svelte, React, and Vue. Each plugin-render.mdx includes a performance warning callout recommending the use of the Tiling Plugin for large documents and high zoom levels.
1 parent 22658ed commit a8d0591

3 files changed

Lines changed: 24 additions & 0 deletions

File tree

website/src/content/docs/react/headless/plugins/plugin-render.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@ description: Provides the essential <RenderLayer /> component for visually rende
44
searchable: true
55
---
66

7+
import { Callout } from '@/components/callout'
8+
79
# Render Plugin
810

911
The Render Plugin is the visual heart of the PDF viewer. It is responsible for taking the raw PDF data from the core engine and "painting" it onto the screen. It supports high-fidelity rendering of text, images, vector graphics, and form widgets.
1012

1113
This plugin works seamlessly in multi-document environments, allowing you to render pages from different documents simultaneously using specific `documentId` references.
1214

15+
<Callout type="warning" title="Performance Warning">
16+
Rendering large documents or using high zoom levels with only the Render Plugin can lead to high memory usage and browser crashes, especially on mobile devices.
17+
18+
For production applications, we strongly recommend using the [Tiling Plugin](./plugin-tiling) alongside the Render Plugin. The Tiling Plugin breaks pages into smaller chunks, significantly reducing memory usage while maintaining high fidelity at any zoom level.
19+
</Callout>
20+
1321
## Installation
1422

1523
The plugin is available as a separate NPM package and is essential for any visual viewer.

website/src/content/docs/svelte/headless/plugins/plugin-render.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@ description: Provides the essential <RenderLayer /> component for visually rende
44
searchable: true
55
---
66

7+
import { Callout } from '@/components/callout'
8+
79
# Render Plugin
810

911
The Render Plugin is the visual heart of the PDF viewer. It is responsible for taking the raw PDF data from the core engine and "painting" it onto the screen. It supports high-fidelity rendering of text, images, vector graphics, and form widgets.
1012

1113
This plugin works seamlessly in multi-document environments, allowing you to render pages from different documents simultaneously using specific `documentId` references.
1214

15+
<Callout type="warning" title="Performance Warning">
16+
Rendering large documents or using high zoom levels with only the Render Plugin can lead to high memory usage and browser crashes, especially on mobile devices.
17+
18+
For production applications, we strongly recommend using the [Tiling Plugin](./plugin-tiling) alongside the Render Plugin. The Tiling Plugin breaks pages into smaller chunks, significantly reducing memory usage while maintaining high fidelity at any zoom level.
19+
</Callout>
20+
1321
## Installation
1422

1523
The plugin is available as a separate NPM package and is essential for any visual viewer.

website/src/content/docs/vue/headless/plugins/plugin-render.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@ description: Provides the essential <RenderLayer /> component for visually rende
44
searchable: true
55
---
66

7+
import { Callout } from '@/components/callout'
8+
79
# Render Plugin
810

911
The Render Plugin is the visual heart of the PDF viewer. It is responsible for taking the raw PDF data from the core engine and "painting" it onto the screen. It supports high-fidelity rendering of text, images, vector graphics, and form widgets.
1012

1113
This plugin works seamlessly in multi-document environments, allowing you to render pages from different documents simultaneously using specific `documentId` references.
1214

15+
<Callout type="warning" title="Performance Warning">
16+
Rendering large documents or using high zoom levels with only the Render Plugin can lead to high memory usage and browser crashes, especially on mobile devices.
17+
18+
For production applications, we strongly recommend using the [Tiling Plugin](./plugin-tiling) alongside the Render Plugin. The Tiling Plugin breaks pages into smaller chunks, significantly reducing memory usage while maintaining high fidelity at any zoom level.
19+
</Callout>
20+
1321
## Installation
1422

1523
The plugin is available as a separate NPM package and is essential for any visual viewer.

0 commit comments

Comments
 (0)