Skip to main content

Development Guide

Community Involvement and Your Role​

pdfme is proud to be an open-source project, supported and driven by our enthusiastic community. Whether you're diving into the codebase or raising your voice in our discussions, your involvement is what makes pdfme thrive.

Not a coder? No problem! From reporting bugs and becoming a sponsor to actively participating in discussions, There are many ways you can contribute. We cherish every form of participation and would be delighted to have you be a part of our development journey.

Bug reports, questions and suggestions​

If you have any bugs, or suggestions for the program or documentation, please see below.

All bug reports and discussions are recorded in GitHub repository.
It is possible that some of the problems or questions have already been solved.

Code Contribution​

Basically we accept PRs for bug fixes. However, we might decide to decline your PR if contains code that add new features. Please remember that pdfme is created to be small and simple as possible. If you have any questions or suggestions, please feel free to send them to GitHub Discussions and we will reply as soon as possible.

For insights on development: How to develop pdfme

Roadmap​

As of writing this page, we just released Version 2 two weeks ago. However, we already have a plan for how we will proceed with the development of the next version.

As we aim for the release of the next version, given our limited resources, we anticipate it being a long-term plan. Therefore, to ensure we do not lose sight of our developmental direction and to address our users who are anticipating new features, we have written this document.

  • V3 Roadmap​

    In this version, we will realize a more customizable pdfme to cater to individual user needs. It will be possible to create custom schemas to cater to various needs and designs that better match user sites. We believe that with this version, users will address niche problems and being open source will further make pdfme a special library.

    • Custom Schema Plugin
      • Allow users to create custom schemas and define PDF and wysiwyg rendering from the outside.
      • Currently built-in schemas will be packaged separately, and improvements will be made individually.
    • Custom Design for UI
      • Allow changes to the accent color (currently it's light blue)
      • Add class names to each UI component to allow customization from the outside.
    • Custom Label for UI
      • Allow users to change the label of the UI component from the outside.
      • Overwrite the any language label with the user's own label

  • V4 Roadmap​

    In this version, we'll try implementing the table.
    To support dynamic data tables, we plan to change from the current method of layering elements over basePdf to a different layout approach.
    As there is no clear implementation method yet, this plan might change if it's deemed too difficult to implement as part of pdfme.

Need technical support?​

If you need technical support, please contact the author via LinkedIn.

Become a sponsor to pdfme​

pdfme is an open source project that is free to use. However, it is not free to develop and maintain pdfme. If you are using pdfme in your business, please consider becoming a sponsor to pdfme. -> sponsoring us