@broadpaper/renderer 0.1.1 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +55 -0
- package/package.json +24 -4
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# @broadpaper/renderer
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@broadpaper/renderer)
|
|
4
|
+
[](https://www.broadpaper.com/legal/terms/)
|
|
5
|
+
[](https://www.broadpaper.com/docs/guide/licensing/)
|
|
6
|
+
|
|
7
|
+
DOM rendering, measurement and page composition for BroadPaper reports.
|
|
8
|
+
|
|
9
|
+
Part of [**BroadPaper**](https://www.broadpaper.com) — an embeddable visual report designer and PDF renderer.
|
|
10
|
+
Your users design the report in your application; BroadPaper owns the layout, the branding,
|
|
11
|
+
the pagination and the output.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install @broadpaper/renderer
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Turns a resolved document into pages in a browser: rendering virtual nodes to the DOM,
|
|
20
|
+
measuring them, and composing the result into paginated output. `layoutDocument` and
|
|
21
|
+
`layoutDocumentAsync` are the entry points, and `createReportViewer` is the read-only viewer
|
|
22
|
+
for showing a finished report without the designer around it.
|
|
23
|
+
|
|
24
|
+
BroadPaper owns pagination — not the browser, and not the PDF engine. Sections are measured
|
|
25
|
+
as continuous galleys and a pure paginator decides the breaks, so the same document breaks
|
|
26
|
+
in the same places wherever it is drawn.
|
|
27
|
+
|
|
28
|
+
## Licensing
|
|
29
|
+
|
|
30
|
+
BroadPaper is **free to evaluate, with no trial clock and nothing behind a feature gate**.
|
|
31
|
+
Install it, use every feature, run it against your real data, in production if you like.
|
|
32
|
+
|
|
33
|
+
The only difference without a licence is that generated PDFs carry an evaluation mark. A
|
|
34
|
+
licence removes it — that is the entire commercial mechanism. No seats, no activation, no
|
|
35
|
+
machine binding, no telemetry, and no call home at any point.
|
|
36
|
+
|
|
37
|
+
- [How licensing works](https://www.broadpaper.com/docs/guide/licensing/)
|
|
38
|
+
- [Pricing](https://www.broadpaper.com/pricing/)
|
|
39
|
+
- [Licence agreement](https://www.broadpaper.com/legal/terms/)
|
|
40
|
+
|
|
41
|
+
## Documentation
|
|
42
|
+
|
|
43
|
+
- [The read-only viewer](https://www.broadpaper.com/docs/guide/viewer)
|
|
44
|
+
- [Themes and branding](https://www.broadpaper.com/docs/guide/themes)
|
|
45
|
+
- [White labelling](https://www.broadpaper.com/docs/guide/white-labelling)
|
|
46
|
+
- [Full documentation](https://www.broadpaper.com/docs/)
|
|
47
|
+
|
|
48
|
+
## Support
|
|
49
|
+
|
|
50
|
+
Paid licences include email support at [support@broadpaper.com](mailto:support@broadpaper.com).
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
Copyright © 2026 Codingbadger Creative Limited. See [LICENSE](./LICENSE) in this package, and
|
|
55
|
+
[THIRD-PARTY-NOTICES.md](./THIRD-PARTY-NOTICES.md) for the components it ships with.
|
package/package.json
CHANGED
|
@@ -1,8 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@broadpaper/renderer",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "BroadPaper DOM renderer: measurement, page composition, preview and standalone HTML output.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"pdf",
|
|
7
|
+
"pdf-generation",
|
|
8
|
+
"report",
|
|
9
|
+
"reporting",
|
|
10
|
+
"report-designer",
|
|
11
|
+
"document-generation",
|
|
12
|
+
"broadpaper",
|
|
13
|
+
"pagination",
|
|
14
|
+
"preview",
|
|
15
|
+
"dom"
|
|
16
|
+
],
|
|
5
17
|
"license": "SEE LICENSE IN LICENSE",
|
|
18
|
+
"homepage": "https://www.broadpaper.com",
|
|
19
|
+
"bugs": {
|
|
20
|
+
"email": "support@broadpaper.com"
|
|
21
|
+
},
|
|
22
|
+
"author": {
|
|
23
|
+
"name": "Codingbadger Creative Limited",
|
|
24
|
+
"url": "https://www.broadpaper.com"
|
|
25
|
+
},
|
|
6
26
|
"type": "module",
|
|
7
27
|
"main": "./dist/index.js",
|
|
8
28
|
"module": "./dist/index.js",
|
|
@@ -20,9 +40,9 @@
|
|
|
20
40
|
],
|
|
21
41
|
"sideEffects": false,
|
|
22
42
|
"dependencies": {
|
|
23
|
-
"@broadpaper/
|
|
24
|
-
"@broadpaper/
|
|
25
|
-
"@broadpaper/
|
|
43
|
+
"@broadpaper/license": "0.2.1",
|
|
44
|
+
"@broadpaper/core": "0.2.1",
|
|
45
|
+
"@broadpaper/blocks": "0.2.1"
|
|
26
46
|
},
|
|
27
47
|
"scripts": {
|
|
28
48
|
"build": "tsup src/index.ts --format esm --dts --sourcemap --clean --external @broadpaper/core --external @broadpaper/blocks --external @broadpaper/license",
|