joaopaulolndev/filament-pdf-viewer

Filament package to show pdf document viewer

v1.0.6 2024-09-26 08:14 UTC

Requires

• php: ^8.1
• filament/filament: ^3.0
• spatie/laravel-package-tools: ^1.15.0

Requires (Dev)

• nunomaduro/collision: ^7.9
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.1
• pestphp/pest-plugin-arch: ^2.0
• pestphp/pest-plugin-laravel: ^2.0

MIT

• João Paulo Leite Nascimento

• laravel
• joaopaulolndev
• filament-pdf-viewer

README

FilamentPHP package to show pdf documents with records saved in the database or show documents without a database in the form of your resource.

Features & Screenshots

• Form Field: Show a pdf document viewer in a form field.
• Infolist Entry: Show a pdf document viewer in a infolist entry.
• Support: Laravel 11 and Filament 3.x

Installation

You can install the package via composer:

composer require joaopaulolndev/filament-pdf-viewer

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-pdf-viewer-views"

Usage in form field

use Joaopaulolndev\FilamentPdfViewer\Forms\Components\PdfViewerField;

public static function form(Form $form): Form
{
    return $form
        ->schema([
            PdfViewerField::make('file')
                ->label('View the PDF')
                ->minHeight('40svh')
        ]);
}

Usage in infolist entry

use Joaopaulolndev\FilamentPdfViewer\Infolists\Components\PdfViewerEntry;

public static function infolist(Infolist $infolist): Infolist 
{
    return $infolist
        ->schema([
            PdfViewerEntry::make('file')
                ->label('View the PDF')
                ->minHeight('40svh')
        ]);
}

Optionally, you can use anothe methods to set the pdf viewer

use Joaopaulolndev\FilamentPdfViewer\Infolists\Components\PdfViewerEntry;

public static function infolist(Infolist $infolist): Infolist 
{
    return $infolist
        ->schema([
            PdfViewerEntry::make('file')
                ->label('View the PDF')
                ->minHeight('40svh')
                ->fileUrl(Storage::url('dummy.pdf')) // Set the file url if you are getting a pdf without database
                ->columnSpanFull()
        ]);
}

Optionally, you can use section to set the pdf viewer

use Joaopaulolndev\FilamentPdfViewer\Infolists\Components\PdfViewerEntry;

public static function infolist(Infolist $infolist): Infolist 
{
    return $infolist
        ->schema([
            \Filament\Infolists\Components\Section::make('PDF Viewer')
            ->description('Prevent the PDF from being downloaded')
            ->collapsible()
            ->schema([
                PdfViewerEntry::make('file')
                    ->label('View the PDF')
                    ->minHeight('40svh')
                    ->fileUrl(Storage::url('dummy.pdf')) // Set the file url if you are getting a pdf without database
                    ->columnSpanFull()
            ]);        
        ]);
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• João Paulo Leite Nascimento
• Rômulo Ramos
• All Contributors

License

The MIT License (MIT). Please see License File for more information.