pdfme/pdfme
Pdfme
pdfme is a schema-based PDF generation engine and dynamic document builder. It provides a system for producing PDF documents by merging predefined templates with dynamic input data across different runtime environments.
The project includes a browser-based WYSIWYG PDF editor and template designer, allowing for the arrangement of elements via a drag-and-drop interface. It distinguishes itself through a plugin-based architecture that enables schema extensions and custom rendering logic for new content types.
The capability surface covers dynamic content generation, including variable placeholder injection, automatic page breaks, and dynamic data tables. It also provides tools for vector shape drawing, barcode and QR code generation, custom font embedding, and the construction of interactive form inputs.
Command-line utilities are available for PDF layout inspection and configuration validation to diagnose errors before final document generation.
Features
- Schema-Driven Generation - Renders PDFs by merging JSON layout definitions with dynamic data objects across different runtime environments.
- Visual Layout Editors - Provides a browser-based drag-and-drop visual layout editor for defining PDF templates.
- Automated Document Workflows - Builds input forms and dynamic tables that automatically scale and break across pages based on data volume.
- Dynamic PDF Generators - Provides utilities for creating PDFs with dynamic content, headers, footers, and tables via templates.
- PDF Document Generation - Generates PDF files by merging predefined templates with dynamic input data across different runtimes.
- Text Placeholder Replacements - Provides an engine for replacing defined variable markers within text strings with dynamic data during PDF generation.
- Cross-Platform Rendering Abstractions - Implements an architectural layer that decouples the document's visual layout from the final PDF rendering engine for cross-platform compatibility.
- Schema Extension Systems - Allows the extension of the document schema to support new content types via built-in or custom plugins.
- Coordinate-Based Positioning - Provides a coordinate-based grid system for the precise absolute positioning of elements within PDF templates.
- Rendering Logic Plugins - Allows developers to extend the core engine with custom plugins for new content types and rendering logic.
- Dynamic Data Tables - Provides runtime rendering of structured data as dynamic tables that support automatic page breaking.
- Schema-Based PDF Generators - Generates documents using structured templates and a plugin-based architecture to define how specific data types render.
- Visual Designer Rendering Plugins - Enables the creation of schema plugins that define how specific data types render within the visual PDF designer.
- Dynamic Height Calculation - Automatically calculates element heights to handle content overflow and trigger automatic page breaks.
- Document Layout Design - Provides a specialized visual design tool for creating document layouts using a drag-and-drop interface.
- PDF Template Management - Manages fonts, assets, and custom schemas to ensure brand consistency across generated PDF documents.
- WYSIWYG Editors - Provides a visual drag-and-drop interface for designing PDF layouts where the editor view matches the final generated document.
- Dynamic List Generators - Produces bulleted or numbered lists that support nested indentation and automatic page breaking.
- Dynamic Text Generation - Renders dynamic text and inline Markdown with custom fonts and flexible styling options.
- PDF Document Management - Provides centralized administration of document templates and custom fonts to ensure consistency across generated files.
- Browser-Based PDF Editors - Provides a browser-based editor for visually designing PDF layouts that integrates into frontend frameworks.
- Shape Drawing - Provides tools for drawing programmatic vector shapes including lines, rectangles, and ellipses.
- PDF Image Embedding - Supports embedding raster images in JPEG, PNG, PDF, and SVG formats within the document layout.
- Automatic Layout Engines - Implements an automatic layout engine that calculates element height and manages overflow across page breaks.
- Layout Validators - Includes utilities to validate template configurations and inspect visual alignment to diagnose errors before generation.
- Caching and Memoization - Utilizes caching and memoization to store computationally expensive rendering results and accelerate the generation of multiple documents.
- Content Previewing - Ships a read-only document previewer to verify the visual state of the PDF before final generation.
- Custom Font Libraries - Supports loading and registering custom font files via URLs or binary data to ensure brand consistency.
- Interactive PDF Form Fields - Provides the ability to embed interactive fillable fields and input elements like checkboxes and date pickers into generated PDF documents.
- Template-Driven Input Forms - Creates user interfaces specifically designed to capture the variable values needed to populate a document template.
- Expression Evaluators - Implements an expression engine for calculating values using mathematical operations and variables within read-only fields.
- Static Page Elements - Allows the placement of fixed headers, footers, and other static elements that appear on every page.
- Template-to-Form Generators - Automatically generates user interfaces for data capture by extracting variable placeholders from PDF layout definitions.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
