@broadpaper/react 0.2.0 → 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.
Files changed (2) hide show
  1. package/README.md +55 -0
  2. package/package.json +25 -5
package/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # @broadpaper/react
2
+
3
+ [![npm](https://img.shields.io/npm/v/@broadpaper/react?color=171511&label=npm)](https://www.npmjs.com/package/@broadpaper/react)
4
+ [![Licence: commercial](https://img.shields.io/badge/licence-commercial-171511)](https://www.broadpaper.com/legal/terms/)
5
+ [![Free to evaluate](https://img.shields.io/badge/evaluate-free%2C%20no%20trial%20clock-4a453c)](https://www.broadpaper.com/docs/guide/licensing/)
6
+
7
+ React components for the BroadPaper report designer and viewer.
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/react
17
+ ```
18
+
19
+ ```tsx
20
+ import { ReportDesigner } from "@broadpaper/react";
21
+
22
+ <ReportDesigner schemas={schemas} template={template} onChange={setTemplate} />
23
+ ```
24
+
25
+ A thin wrapper over `createReportDesigner` — it owns the mount, the teardown and the prop
26
+ updates, and nothing else. The designer's own API is unchanged underneath, so anything the
27
+ wrapper does not expose is still reachable through the instance.
28
+
29
+ ## Licensing
30
+
31
+ BroadPaper is **free to evaluate, with no trial clock and nothing behind a feature gate**.
32
+ Install it, use every feature, run it against your real data, in production if you like.
33
+
34
+ The only difference without a licence is that generated PDFs carry an evaluation mark. A
35
+ licence removes it — that is the entire commercial mechanism. No seats, no activation, no
36
+ machine binding, no telemetry, and no call home at any point.
37
+
38
+ - [How licensing works](https://www.broadpaper.com/docs/guide/licensing/)
39
+ - [Pricing](https://www.broadpaper.com/pricing/)
40
+ - [Licence agreement](https://www.broadpaper.com/legal/terms/)
41
+
42
+ ## Documentation
43
+
44
+ - [React](https://www.broadpaper.com/docs/guide/react)
45
+ - [The designer](https://www.broadpaper.com/docs/guide/editor)
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/react",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "React components for the BroadPaper report designer and preview.",
5
+ "keywords": [
6
+ "pdf",
7
+ "pdf-generation",
8
+ "report",
9
+ "reporting",
10
+ "report-designer",
11
+ "document-generation",
12
+ "broadpaper",
13
+ "react",
14
+ "react-component",
15
+ "embeddable"
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,10 +40,10 @@
20
40
  ],
21
41
  "sideEffects": false,
22
42
  "dependencies": {
23
- "@broadpaper/blocks": "0.2.0",
24
- "@broadpaper/core": "0.2.0",
25
- "@broadpaper/editor": "0.2.0",
26
- "@broadpaper/renderer": "0.2.0"
43
+ "@broadpaper/blocks": "0.2.1",
44
+ "@broadpaper/core": "0.2.1",
45
+ "@broadpaper/renderer": "0.2.1",
46
+ "@broadpaper/editor": "0.2.1"
27
47
  },
28
48
  "peerDependencies": {
29
49
  "react": "^18.2.0 || ^19.0.0",