Skip to content

Commit 4405279

Browse files
committed
docs: update readmes
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
1 parent b6db10f commit 4405279

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@ SPDX-License-Identifier: AGPL-3.0-or-later
55

66
# PDF Elements
77

8-
A Vue 2 component for rendering PDFs with draggable and resizable element overlays.
8+
A Vue 3 component for rendering PDFs with draggable and resizable element overlays.
99

1010
**[Demo](https://libresign.github.io/pdf-elements/)** · [Examples](examples/)
1111

12+
## Development
13+
14+
- `npm run dev` - Run the demo with Vite
15+
- `npm run build` - Build the library (ESM + types)
16+
- `npm run build:demo` - Build the demo to `dist-demo`
17+
1218
## API
1319

1420
### Props
@@ -28,6 +34,23 @@ A Vue 2 component for rendering PDFs with draggable and resizable element overla
2834
| `ignoreClickOutsideSelectors` | Array | `[]` | CSS selectors that keep the selection active when clicking outside the element |
2935
| `pageCountFormat` | String | `'{currentPage} of {totalPages}'` | Format string for page counter |
3036
| `autoFitZoom` | Boolean | `false` | Automatically adjust zoom to fit viewport on window resize |
37+
| `pdfjsOptions` | Object | `{}` | Options passed to PDF.js `getDocument` (advanced) |
38+
39+
### PDF.js options
40+
41+
`pdfjsOptions` is forwarded to PDF.js `getDocument(...)` and can be used to tune performance.
42+
43+
Example:
44+
45+
```ts
46+
<PDFElements
47+
:pdfjs-options="{
48+
disableFontFace: true,
49+
disableRange: true,
50+
disableStream: true,
51+
}"
52+
/>
53+
```
3154

3255
### Events
3356

0 commit comments

Comments
 (0)