Gerador de relatórios para Next.js

Instalação

Um único pacote, cinco entradas. Instale o core e adicione peers só quando o recurso correspondente for usado.

Migração para @cosmemilton

Use @cosmemilton/report@0.6.0 com @cosmemilton/ui >=4.1.0. Atualize imports, CSS e CmToastProvider juntos, sem misturar os dois pacotes de UI. Para manter UI 3, continue com cosmemilton-report@0.6.0 e cosmemilton-ui@3 e os imports antigos. As versões antigas continuam disponíveis; a URL deste site e os repositórios GitHub não mudam.

1. Instale o pacote

O core não importa dependências em runtime. PDFKit e pdf-lib já vêm no pacote; os demais recursos usam peers opcionais.

bash
npm i @cosmemilton/report

2. Peers opcionais

Instale apenas os que o seu uso exige.

PeerPara quêQuando instalar

@react-pdf/renderer

Geração de PDF e o preview ao vivo do documentoAo usar a entrada /pdf ou componentes de /client como CmReportPdfPreview

exceljs

Exportação em XLSX (planilha real, com formatação)Ao usar a entrada /xlsx

@cosmemilton/ui + @iconify/react

Editor de layout, designer e preview em telaAo usar componentes de /client como CmReportLayoutEditor e CmReportDesigner

next

Nada em runtime — não é uma dependência real do pacoteA entrada /next usa apenas Response e Request padrão da Web, sem depender do framework
Linhas por página:1-4 de 4
Página 1 de 1

Uso só-servidor

Route handlers que só exportam arquivos não precisam de nenhum peer de UI.

Um route handler não precisa de UI

Se o único objetivo é servir /api/relatorios/[slug].pdf ou .xlsx, importe apenas @cosmemilton/report, @cosmemilton/report/pdf (ou /xlsx) e @cosmemilton/report/next. @cosmemilton/ui e @iconify/react só entram quando alguma tela renderiza CmReportPdfPreview, CmReportLayoutEditor ou CmReportDesigner.

Entradas do pacote

Cada import path carrega só o que precisa — o core nunca puxa PDF, XLSX ou UI de arraste.

EntryConteúdoPeer

@cosmemilton/report

defineReport, resolveReport, dataset, formatadores, serializers CSV/TSV/JSON e registryNenhum

@cosmemilton/report/pdf

createReportDocument, renderReportToBuffer/Stream, createCompositeReportDocument, renderCompositeReportToBuffer/Stream e registerReportFonts@react-pdf/renderer

@cosmemilton/report/xlsx

exportReportToXlsxexceljs

@cosmemilton/report/client

Hooks (useReportExport, useReportViews) e componentes (CmReportLayoutEditor, CmReportGlobalConfigEditor, CmReportPdfPreview, CmReportDesigner)@cosmemilton/ui + @iconify/react (e @react-pdf/renderer para o preview em tela)

@cosmemilton/report/next

renderReportResponse e reportResponse, para route handlers do App RouterNenhum
Linhas por página:1-5 de 5
Página 1 de 1

Provider dos editores

CmReportLayoutEditor, CmReportDesigner e CmReportGlobalConfigEditor precisam de um CmToastProvider ancestral para validações, upload do logotipo e feedback de salvar ou duplicar. O preview isolado dispensa esse provider e mantém seu callback onError.

tsx
import { CmToastProvider } from "@cosmemilton/ui/client";
import "@cosmemilton/ui/styles.css";
import "@cosmemilton/report/styles.css";

// No layout, dentro do seu CmThemeProvider:
<CmToastProvider>
  {children}
</CmToastProvider>;

Próximo passo

Entenda como definição, colunas e formatos se encaixam antes de escrever o primeiro relatório.

Ver conceitos

Testar agora

Cole seus próprios dados e veja o PDF, o editor e as exportações funcionando ao vivo.

Abrir playground