@broadpaper/editor
v0.4.0
Published
BroadPaper visual report designer. Framework-neutral mount API; React inside.
Maintainers
Readme
@broadpaper/editor
The BroadPaper report designer: a visual, embeddable, white-labelled report editor.
Part of BroadPaper — an embeddable visual report designer and PDF renderer. Your users design the report in your application; BroadPaper owns the layout, the branding, the pagination and the output.
Install
npm install @broadpaper/editorThe designer your users lay reports out in, mounted into an element you own:
import { createReportDesigner } from "@broadpaper/editor";
const designer = createReportDesigner(element, {
dataSources,
template,
onChange: (next) => save(next)
});React inside, but exposed as a plain mount function, so it embeds in anything — and
@broadpaper/react and
@broadpaper/angular are thin wrappers
over this same API.
It is themeable down to the chrome, and setting features.whiteLabel removes the BroadPaper
mark from the toolbar, because it is meant to look like part of your product rather than a guest
in it. Below 820px it becomes a different
layout — side panels turn into drawers — measured from the element rather than the window,
since an embedded designer in a narrow pane has the same problem as a phone.
Licensing
BroadPaper is free to evaluate, with no trial clock and nothing behind a feature gate. Install it, use every feature and evaluate it against your real data for as long as you like. Production use needs a licence.
In the software, the only difference without a licence is that generated PDFs carry an evaluation mark, and a licence removes it. Contractually, the licence is also what permits production use. No seats, no activation, no machine binding, no telemetry, and no call home at any point.
Documentation
Support
Paid licences include email support at [email protected].
Copyright © 2026 Codingbadger Creative Limited. See LICENSE in this package, and THIRD-PARTY-NOTICES.md for the components it ships with.
