A framework-agnostic, universal document renderer with optional chunked loading
polyrender.wisp.place/
add READMEs for examples
+75
+30
examples/basic/README.md
+30
examples/basic/README.md
···
1
+
# @polyrender/example-basic
2
+
3
+
Vite + vanilla TypeScript example for [`@polyrender/core`](../../packages/core/README.md). Demonstrates file-picker based document viewing with the built-in toolbar.
4
+
5
+
A live demo is coming soon.
6
+
7
+
## Running locally
8
+
9
+
```bash
10
+
# From the monorepo root, build all packages first:
11
+
pnpm build
12
+
13
+
# Then start the Vite dev server:
14
+
cd examples/basic
15
+
pnpm dev
16
+
```
17
+
18
+
To build for production:
19
+
20
+
```bash
21
+
pnpm build
22
+
pnpm preview
23
+
```
24
+
25
+
## What it shows
26
+
27
+
- Opening a local file via a file input
28
+
- Auto-detecting the document format from the filename
29
+
- Rendering with the built-in dark-themed toolbar
30
+
- Configuring the `pdfjs-dist` worker URL via Vite's `?url` import
+23
examples/react/README.md
+23
examples/react/README.md
···
1
+
# @polyrender/example-react
2
+
3
+
Vite + React example for [`@polyrender/react`](../../packages/react/README.md). Demonstrates the `<DocumentViewer>` component and the `useDocumentRenderer` headless hook.
4
+
5
+
> **Note:** This example is still a work in progress. A live demo is coming soon.
6
+
7
+
## Running locally
8
+
9
+
```bash
10
+
# From the monorepo root, build all packages first:
11
+
pnpm build
12
+
13
+
# Then start the Vite dev server:
14
+
cd examples/react
15
+
pnpm dev
16
+
```
17
+
18
+
To build for production:
19
+
20
+
```bash
21
+
pnpm build
22
+
pnpm preview
23
+
```
+22
examples/vanilla/README.md
+22
examples/vanilla/README.md
···
1
+
# @polyrender/example-vanilla
2
+
3
+
Vanilla TypeScript example for [`@polyrender/core`](../../packages/core/README.md), built with esbuild.
4
+
5
+
A hosted version of this example is available at **https://polyrender.wisp.place/**.
6
+
7
+
## Running locally
8
+
9
+
```bash
10
+
# From the monorepo root, build all packages first:
11
+
pnpm build
12
+
13
+
# Then serve the example:
14
+
cd examples/vanilla
15
+
pnpm serve
16
+
```
17
+
18
+
Or use watch mode during development:
19
+
20
+
```bash
21
+
pnpm dev
22
+
```