filament-pdf-viewer - GitLite

KO | EN

gitlite — search

#javascript #react #ai #typescript #android #machine-learning #rust #deep-learning #nodejs #java #windows #cli #kubernetes #open-source

filament-pdf-viewer

(★ 109)

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

File Explorer

Download Latest Version (.zip)

- - bug.yml
  - config.yml
- - run-tests.yml
  - update-changelog.yml
- CONTRIBUTING.md
- dependabot.yml
- FUNDING.yml
- SECURITY.md
- test-results
- form-pdf-viewer.png
- infolist-pdf-viewer.png
- joaopaulolndev-filament-pdf-viewer.jpg
- FilamentPdfViewerServiceProvider.php
- ArchTest.php
- ExampleTest.php
- Pest.php
- TestCase.php
.editorconfig
.gitattributes
.gitignore
CHANGELOG.md
composer.json
LICENSE.md
phpunit.xml.dist
pint.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/joaopaulolndev/filament-pdf-viewer

Downloads the entire project code from GitHub to your computer.

cd filament-pdf-viewer

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require joaopaulolndev/filament-pdf-viewer:^3.0

Type this command into your terminal and run it.

composer test

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Filament package to show pdf document viewer

[![Latest Version on Packagist](https://img.shields.io/packagist/v/joaopaulolndev/filament-pdf-viewer.svg?style=flat-square)](https://packagist.org/packages/joaopaulolndev/filament-pdf-viewer)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/joaopaulolndev/filament-pdf-viewer/run-tests.yml?branch=2.x&label=tests&style=flat-square)](https://github.com/joaopaulolndev/filament-pdf-viewer/actions?query=workflow%3Arun-tests+branch%3A2.x)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/joaopaulolndev/filament-pdf-viewer/fix-php-code-style-issues.yml?branch=2.x&label=code%20style&style=flat-square)](https://github.com/joaopaulolndev/filament-pdf-viewer/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3A2.x)
[![Total Downloads](https://img.shields.io/packagist/dt/joaopaulolndev/filament-pdf-viewer.svg?style=flat-square)](https://packagist.org/packages/joaopaulolndev/filament-pdf-viewer)

FilamentPHP package to show pdf documents with records saved in the database or show documents without a database in the form of your resource.
<div class="filament-hidden">

![Screenshot of Application Feature](https://raw.githubusercontent.com/joaopaulolndev/filament-pdf-viewer/2.x/art/joaopaulolndev-filament-pdf-viewer.jpg)

</div>

## 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](https://laravel.com) and [Filament 5.x](https://filamentphp.com)

## Compatibility

| Package Version | Filament Version |
|-----------------|------------------|
| 1.x             | 3.x              |
| 2.x             | 4.x              |
| 3.x             | 5.x              |

## Installation

You can install the package via composer:

```bash
composer require joaopaulolndev/filament-pdf-viewer:^3.0
```

Optionally, you can publish the views using

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

## Usage in form field

```php
use Joaopaulolndev\FilamentPdfViewer\Forms\Components\PdfViewerField;

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

## Usage in infolist entry

```php
use Joaopaulolndev\FilamentPdfViewer\Infolists\Components\PdfViewerEntry;

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

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

```php
use Joaopaulolndev\FilamentPdfViewer\Infolists\Components\PdfViewerEntry;

public static function infolist(Schema $schema): Schema 
{
    return $schema
        ->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

```php
use Joaopaulolndev\FilamentPdfViewer\Infolists\Components\PdfViewerEntry;

public static function infolist(Schema $schema): Schema 
{
    return $schema
        ->schema([
            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

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [João Paulo Leite Nascimento](https://github.com/joaopaulolndev)
- [Rômulo Ramos](https://github.com/rmsramos)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.