Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danteb918/livewire-pdf-preview
Composer package to preview Livewire PDF's
https://github.com/danteb918/livewire-pdf-preview
laravel livewire pdf
Last synced: 3 days ago
JSON representation
Composer package to preview Livewire PDF's
- Host: GitHub
- URL: https://github.com/danteb918/livewire-pdf-preview
- Owner: DanteB918
- License: mit
- Created: 2024-12-12T00:22:06.000Z (25 days ago)
- Default Branch: master
- Last Pushed: 2025-01-01T17:24:46.000Z (4 days ago)
- Last Synced: 2025-01-01T18:18:53.147Z (4 days ago)
- Topics: laravel, livewire, pdf
- Language: PHP
- Homepage:
- Size: 937 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/DanteB918/livewire-pdf-preview/releases/)
## Example
## Installation
You can install the package via composer:
```bash
composer require danteb918/livewire-pdf-preview
```
Please skip the next few installation steps if your application already has PDF.js installed.
Next, you must export the package public scripts. To do this run
```bash
php artisan livewire-pdf-preview:install
```
This command will export a `vendor/livewire-pdf-preview` folder under the `public` directory of your app which is used by the `@livewirePdfPreviewScripts` directive.
include the `@livewirePdfPreviewScripts` directive next to your other app scripts
```blade
@livewireScripts
@livewirePdfPreviewScripts
```
## Requirements
This package requires the following packages/libraries to work:
- `Laravel Livewire v3` (https://livewire.laravel.com/)
- `PDF.js` (https://mozilla.github.io/pdf.js/)
Please follow each package/library instructions on how to set them properly in your project.
>Note: if you run the installation command and added the directives, that installs PDF.js.
## Usage
You'll have a livewire component with an upload field, then the canvas, like so:
```blade
```
If you already have PDF.js in your application, you'll have to specify the `pdf.worker.js` path and pass it to the component. This is not required if that JS was set up via the command + `@livewirePdfPreviewScripts` method.
```blade
```
Be sure that your component has the `WithFileUploads` trait, if you are using Livewire file uploads. More information can be found [in the Livewire documentation.](https://livewire.laravel.com/docs/uploads#storing-uploaded-files)
It's preferred to always have the `key` attribute for this component so that it will re-render any time the PDF has been changed.
## Contributing
Feel free to open Pull requests with bug fixes and features. I'll do my best to keep an eye on those.
Feel free to open issues with bug reports or feature requests. Bug fixes will take priority.
I welcome contributions from the community and look forward to working with you to improve this project.
### Contributors
