PHPackages abdallahalyamni/laravel-mpdf-arabic - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [PDF & Document Generation](/categories/documents) 4. / 5. abdallahalyamni/laravel-mpdf-arabic ActiveLibrary[PDF & Document Generation](/categories/documents) abdallahalyamni/laravel-mpdf-arabic =================================== Laravel Mpdf: Using Mpdf in Laravel to generate Pdfs. 1.0.0(2y ago)0176MITPHPPHP ^5.6|^7.0|^8.0 Since Jun 21Pushed 2y agoCompare [ Source](https://github.com/AbdallahAlyamni/laravel-mpdf-arabic)[ Packagist](https://packagist.org/packages/abdallahalyamni/laravel-mpdf-arabic)[ Fund](https://www.paypal.me/mccarlosen)[ RSS](/packages/abdallahalyamni-laravel-mpdf-arabic/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (1)Versions (2)Used By (0) Laravel Mpdf: Generate PDF Files with ease. =========================================== [](#laravel-mpdf-generate-pdf-files-with-ease) Easily generate PDF files using [Laravel's Blade templates](https://laravel.com/docs/blade) and the [MPDF library](https://mpdf.github.io/). This package has been tested since Laravel 5.4. Installation ------------ [](#installation) Run this composer command in your laravel application: ``` composer require carlos-meneses/laravel-mpdf ``` Important Notes: ---------------- [](#important-notes) - Always check the [official MPDF documentation](https://mpdf.github.io/) - mPDF will timeout on [fetching external HTTP resources](https://github.com/mpdf/mpdf#known-server-caveats) when using single-threaded servers such as `php -S` or `artisan serve`. Use a proper webserver for full functionality. To start using Laravel, add the Service Provider and the Facade to your `config/app.php`: > **Note:** This package supports auto-discovery features of Laravel 5.5+, You only need to manually add the service provider and alias if working on Laravel version lower then 5.5. ``` 'providers' => [ // ... Mccarlosen\LaravelMpdf\LaravelMpdfServiceProvider::class ] ``` ``` 'aliases' => [ // ... 'PDF' => Mccarlosen\LaravelMpdf\Facades\LaravelMpdf::class ] ``` Basic Usage ----------- [](#basic-usage) To use Laravel Mpdf add something like this to one of your controllers. You can pass data to a view in `/resources/views`. ``` //.... use PDF; class ReportController extends Controller { public function viewPdf() { $data = [ 'foo' => 'bar' ]; $pdf = PDF::loadView('pdf.document', $data); return $pdf->stream('document.pdf'); } } ``` Config ------ [](#config) You can use a custom file to overwrite the default configuration. Just execute `php artisan vendor:publish --tag=mpdf-config` or create `config/pdf.php` and add this: ``` return [ 'mode' => '', 'format' => 'A4', 'default_font_size' => '12', 'default_font' => 'sans-serif', 'margin_left' => 10, 'margin_right' => 10, 'margin_top' => 10, 'margin_bottom' => 10, 'margin_header' => 0, 'margin_footer' => 0, 'orientation' => 'P', 'title' => 'Laravel mPDF', 'author' => '', 'watermark' => '', 'show_watermark' => false, 'show_watermark_image' => false, 'watermark_font' => 'sans-serif', 'display_mode' => 'fullpage', 'watermark_text_alpha' => 0.1, 'watermark_image_path' => '', 'watermark_image_alpha' => 0.2, 'watermark_image_size' => 'D', 'watermark_image_position' => 'P', 'custom_font_dir' => '', 'custom_font_data' => [], 'auto_language_detection' => false, 'temp_dir' => storage_path('app'), 'pdfa' => false, 'pdfaauto' => false, 'use_active_forms' => false, ]; ``` To override this configuration on a per-file basis use the fourth parameter of the initializing call like this: ``` // ... PDF::loadView('pdf', $data, [], [ 'title' => 'Another Title', 'margin_top' => 0 ])->save($pdfFilePath); ``` Get instance your Mpdf ---------------------- [](#get-instance-your-mpdf) You can access all mpdf methods through the mpdf instance with `getMpdf` method. ``` use PDF; $pdf = PDF::loadView('pdf.document', $data); $pdf->getMpdf()->AddPage(/*...*/); ``` Headers and Footers ------------------- [](#headers-and-footers) If you want to have headers and footers that appear on every page, add them to your `` tag like this: ``` Your Header Content Your Footer Content ``` Now you just need to define them with the name attribute in your CSS: ``` @page { header: page-header; footer: page-footer; } ``` Inside of headers and footers `{PAGENO}` can be used to display the page number. Included Fonts -------------- [](#included-fonts) By default you can use all the fonts [shipped with Mpdf](https://mpdf.github.io/fonts-languages/available-fonts-v6.html). Custom Fonts ------------ [](#custom-fonts) You can use your own fonts in the generated PDFs. The TTF files have to be located in one folder, e.g. `resources/fonts/`. Add this to your configuration file (`/config/pdf.php`): ``` return [ 'custom_font_dir' => base_path('resources/fonts/'), // don't forget the trailing slash! 'custom_font_data' => [ 'examplefont' => [ // must be lowercase and snake_case 'R' => 'ExampleFont-Regular.ttf', // regular font 'B' => 'ExampleFont-Bold.ttf', // optional: bold font 'I' => 'ExampleFont-Italic.ttf', // optional: italic font 'BI' => 'ExampleFont-Bold-Italic.ttf' // optional: bold-italic font ] // ...add as many as you want. ] ]; ``` Now you can use the font in CSS: ``` body { font-family: 'examplefont', sans-serif; } ``` Chunk HTML ---------- [](#chunk-html) For big HTML you might get `Uncaught Mpdf\MpdfException: The HTML code size is larger than pcre.backtrack_limit xxx` error, or you might just get [empty or blank result](https://mpdf.github.io/troubleshooting/known-issues.html#blank-pages-or-some-sections-missing). In these situations you can use chunk methods while you added a separator to your HTML: ``` //.... use PDF; class ReportController extends Controller { public function generate_pdf() { $data = [ 'foo' => 'hello 1', 'bar' => 'hello 2' ]; $pdf = PDF::chunkLoadView('', 'pdf.document', $data); return $pdf->stream('document.pdf'); } } ``` ``` Hello World {{ $foo }} {{ $bar }} ``` Added Support for the Macroable Trait ------------------------------------- [](#added-support-for-the-macroable-trait) You can configure the macro in the `AppServiceProvider` provider file. ``` //... use Mccarlosen\LaravelMpdf\LaravelMpdf; class AppServiceProvider extends ServiceProvider { //... public function boot() { LaravelMpdf::macro('hello', function () { return "Hello, World!"; }); } //... } ``` Now ``` PDF::loadView(/* ... */)->hello(); ``` License ------- [](#license) Laravel Mpdf is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) ### Health Score 25 — LowBetter than 37% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community17 Small or concentrated contributor base Maturity49 Maturing project, gaining track record Bus Factor1 Top contributor holds 53.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 1057d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/34180d029f4fa16c7e34ccf7a43ff58200f410eff9d62d784c642906f07a99c4?d=identicon)[AbdallahAlyamni](/maintainers/AbdallahAlyamni) --- Top Contributors [![mccarlosen](https://avatars.githubusercontent.com/u/8524361?v=4)](https://github.com/mccarlosen "mccarlosen (83 commits)")[![mccarlosen-design](https://avatars.githubusercontent.com/u/273206368?v=4)](https://github.com/mccarlosen-design "mccarlosen-design (20 commits)")[![abumosaab](https://avatars.githubusercontent.com/u/3581324?v=4)](https://github.com/abumosaab "abumosaab (14 commits)")[![pindab0ter](https://avatars.githubusercontent.com/u/5128166?v=4)](https://github.com/pindab0ter "pindab0ter (7 commits)")[![webmasterpacifico](https://avatars.githubusercontent.com/u/22247174?v=4)](https://github.com/webmasterpacifico "webmasterpacifico (5 commits)")[![AbdallahAlyamni](https://avatars.githubusercontent.com/u/31776967?v=4)](https://github.com/AbdallahAlyamni "AbdallahAlyamni (4 commits)")[![finwe](https://avatars.githubusercontent.com/u/195675?v=4)](https://github.com/finwe "finwe (3 commits)")[![danielrona](https://avatars.githubusercontent.com/u/1699775?v=4)](https://github.com/danielrona "danielrona (3 commits)")[![aanfarhan](https://avatars.githubusercontent.com/u/19621476?v=4)](https://github.com/aanfarhan "aanfarhan (2 commits)")[![MortezaPoussaneh](https://avatars.githubusercontent.com/u/49806042?v=4)](https://github.com/MortezaPoussaneh "MortezaPoussaneh (2 commits)")[![mudasserzahid](https://avatars.githubusercontent.com/u/16418084?v=4)](https://github.com/mudasserzahid "mudasserzahid (2 commits)")[![rabrowne85](https://avatars.githubusercontent.com/u/8293543?v=4)](https://github.com/rabrowne85 "rabrowne85 (2 commits)")[![sdon2](https://avatars.githubusercontent.com/u/3636658?v=4)](https://github.com/sdon2 "sdon2 (2 commits)")[![tamer-dev](https://avatars.githubusercontent.com/u/434489?v=4)](https://github.com/tamer-dev "tamer-dev (1 commits)")[![realtebo](https://avatars.githubusercontent.com/u/1268699?v=4)](https://github.com/realtebo "realtebo (1 commits)")[![abronin](https://avatars.githubusercontent.com/u/1532185?v=4)](https://github.com/abronin "abronin (1 commits)")[![ali-alharthi](https://avatars.githubusercontent.com/u/29173253?v=4)](https://github.com/ali-alharthi "ali-alharthi (1 commits)")[![shukriYusof](https://avatars.githubusercontent.com/u/17242638?v=4)](https://github.com/shukriYusof "shukriYusof (1 commits)")[![dsturm](https://avatars.githubusercontent.com/u/384815?v=4)](https://github.com/dsturm "dsturm (1 commits)") --- Tags laravelpdfmpdf ### Embed Badge ![Health badge](/badges/abdallahalyamni-laravel-mpdf-arabic/health.svg) ``` [![Health](https://phpackages.com/badges/abdallahalyamni-laravel-mpdf-arabic/health.svg)](https://phpackages.com/packages/abdallahalyamni-laravel-mpdf-arabic) ``` ### Alternatives [misterspelik/laravel-pdf Generate PDFs in Laravel with this mPDF wrapper. 57164.8k](/packages/misterspelik-laravel-pdf) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)