@broadpaper/editor 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 +69 -0
- package/package.json +25 -4
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# @broadpaper/editor
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@broadpaper/editor)
|
|
4
|
+
[](https://www.broadpaper.com/legal/terms/)
|
|
5
|
+
[](https://www.broadpaper.com/docs/guide/licensing/)
|
|
6
|
+
|
|
7
|
+
The BroadPaper report designer: a visual, embeddable, white-labelled report editor.
|
|
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/editor
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The designer your users lay reports out in, mounted into an element you own:
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { createReportDesigner } from "@broadpaper/editor";
|
|
23
|
+
|
|
24
|
+
const designer = createReportDesigner(element, {
|
|
25
|
+
schemas,
|
|
26
|
+
template,
|
|
27
|
+
onChange: (next) => save(next)
|
|
28
|
+
});
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
React inside, but exposed as a plain mount function, so it embeds in anything — and
|
|
32
|
+
[`@broadpaper/react`](https://www.npmjs.com/package/@broadpaper/react) and
|
|
33
|
+
[`@broadpaper/angular`](https://www.npmjs.com/package/@broadpaper/angular) are thin wrappers
|
|
34
|
+
over this same API.
|
|
35
|
+
|
|
36
|
+
It is themeable down to the chrome and carries no BroadPaper marks, because it is meant to
|
|
37
|
+
look like part of your product rather than a guest in it. Below 820px it becomes a different
|
|
38
|
+
layout — side panels turn into drawers — measured from the element rather than the window,
|
|
39
|
+
since an embedded designer in a narrow pane has the same problem as a phone.
|
|
40
|
+
|
|
41
|
+
## Licensing
|
|
42
|
+
|
|
43
|
+
BroadPaper is **free to evaluate, with no trial clock and nothing behind a feature gate**.
|
|
44
|
+
Install it, use every feature, run it against your real data, in production if you like.
|
|
45
|
+
|
|
46
|
+
The only difference without a licence is that generated PDFs carry an evaluation mark. A
|
|
47
|
+
licence removes it — that is the entire commercial mechanism. No seats, no activation, no
|
|
48
|
+
machine binding, no telemetry, and no call home at any point.
|
|
49
|
+
|
|
50
|
+
- [How licensing works](https://www.broadpaper.com/docs/guide/licensing/)
|
|
51
|
+
- [Pricing](https://www.broadpaper.com/pricing/)
|
|
52
|
+
- [Licence agreement](https://www.broadpaper.com/legal/terms/)
|
|
53
|
+
|
|
54
|
+
## Documentation
|
|
55
|
+
|
|
56
|
+
- [The designer](https://www.broadpaper.com/docs/guide/editor)
|
|
57
|
+
- [Themes and branding](https://www.broadpaper.com/docs/guide/themes)
|
|
58
|
+
- [White labelling](https://www.broadpaper.com/docs/guide/white-labelling)
|
|
59
|
+
- [Custom blocks](https://www.broadpaper.com/docs/guide/custom-blocks)
|
|
60
|
+
- [Full documentation](https://www.broadpaper.com/docs/)
|
|
61
|
+
|
|
62
|
+
## Support
|
|
63
|
+
|
|
64
|
+
Paid licences include email support at [support@broadpaper.com](mailto:support@broadpaper.com).
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
Copyright © 2026 Codingbadger Creative Limited. See [LICENSE](./LICENSE) in this package, and
|
|
69
|
+
[THIRD-PARTY-NOTICES.md](./THIRD-PARTY-NOTICES.md) for the components it ships with.
|
package/package.json
CHANGED
|
@@ -1,8 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@broadpaper/editor",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "BroadPaper visual report designer. Framework-neutral mount API; React inside.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"pdf",
|
|
7
|
+
"pdf-generation",
|
|
8
|
+
"report",
|
|
9
|
+
"reporting",
|
|
10
|
+
"report-designer",
|
|
11
|
+
"document-generation",
|
|
12
|
+
"broadpaper",
|
|
13
|
+
"report-builder",
|
|
14
|
+
"wysiwyg",
|
|
15
|
+
"embeddable",
|
|
16
|
+
"white-label"
|
|
17
|
+
],
|
|
5
18
|
"license": "SEE LICENSE IN LICENSE",
|
|
19
|
+
"homepage": "https://www.broadpaper.com",
|
|
20
|
+
"bugs": {
|
|
21
|
+
"email": "support@broadpaper.com"
|
|
22
|
+
},
|
|
23
|
+
"author": {
|
|
24
|
+
"name": "Codingbadger Creative Limited",
|
|
25
|
+
"url": "https://www.broadpaper.com"
|
|
26
|
+
},
|
|
6
27
|
"type": "module",
|
|
7
28
|
"main": "./dist/index.js",
|
|
8
29
|
"module": "./dist/index.js",
|
|
@@ -34,9 +55,9 @@
|
|
|
34
55
|
"prosemirror-view": "^1.37.1",
|
|
35
56
|
"react": "^19.0.0",
|
|
36
57
|
"react-dom": "^19.0.0",
|
|
37
|
-
"@broadpaper/
|
|
38
|
-
"@broadpaper/renderer": "0.
|
|
39
|
-
"@broadpaper/
|
|
58
|
+
"@broadpaper/core": "0.2.1",
|
|
59
|
+
"@broadpaper/renderer": "0.2.1",
|
|
60
|
+
"@broadpaper/blocks": "0.2.1"
|
|
40
61
|
},
|
|
41
62
|
"devDependencies": {
|
|
42
63
|
"@types/react": "^19.0.2",
|