hugomyb/filament-media-action

Automatically display your media (video, audio, document, image, ...) with an action

v3.1.1.5 2024-12-17 08:03 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

• Mayonobe Hugo

• laravel
• hugomyb
• filament-media-action

README

Automatically display your media (video, audio, pdf, image, ...) with an action in Filament. The package automatically detects the media extension to display the correct player.

Examples

Installation

You can install the package via composer:

composer require hugomyb/filament-media-action

Optionally, you can publish the view using

php artisan vendor:publish --tag="filament-media-action-views"

Optionally, you can publish the translations using

php artisan vendor:publish --tag="filament-media-action-translations"

Usage

Basic Usage

Like a classic Filament Action, you can use MediaAction anywhere (Forms, Tables, Infolists, Suffix and prefix, ...).

Simply provide the url of your media in the ->media() method. The package will then automatically detect your media extension for display.

MediaAction::make('tutorial')
    ->iconButton()
    ->icon('heroicon-o-video-camera')
    ->media('https://www.youtube.com/watch?v=rN9XI9KCz0c&list=PL6tf8fRbavl3jfL67gVOE9rF0jG5bNTMi')

Available options

Autoplay

You can enable autoplay for video and audio by using the ->autoplay() method.

MediaAction::make('media-url')
    ->media(fn($record) => $record->url)
    ->autoplay()

You can also pass a closure in the method and access $record and $mediaType :

MediaAction::make('media-url')
    ->media(fn($record) => $record->url)
    ->autoplay(fn($record, $mediaType) => $mediaType === 'video')

$mediatype can return "youtube", "audio", "video", "image" or "pdf".

Preload

To control the preload behavior, use the ->preload() method. By default, it is set to true, which means the media will preload automatically. You can set it to false to disable preloading (this is helpful to avoid "Autoplay failed or was blocked" errors in some browsers).

MediaAction::make('media-url')
    ->media(fn($record) => $record->url)
    ->autoplay()
    ->preload(false)

Other options

You can customize the modal as you wish in the same way as a classic action (see https://filamentphp.com/docs/3.x/actions/modals).

If there is an existing record, you can access it by passing a closure to ->media() method.

Example :

MediaAction::make('media-url')
    ->modalHeading(fn($record) => $record->name)
    ->modalFooterActionsAlignment(Alignment::Center)
    ->media(fn($record) => $record->url)
    ->extraModalFooterActions([
        MediaAction::make('media-video2')
            ->media('https://www.youtube.com/watch?v=9GBXqWKzfIM&list=PL6tf8fRbavl3jfL67gVOE9rF0jG5bNTMi&index=3')
            ->extraModalFooterActions([
                MediaAction::make('media-video3')
                    ->media('https://www.youtube.com/watch?v=Bvb_vqzhRQs&list=PL6tf8fRbavl3jfL67gVOE9rF0jG5bNTMi&index=5')
            ]),

        Tables\Actions\Action::make('open-url')
            ->label('Open in browser')
            ->url(fn($record) => $record->url)
            ->openUrlInNewTab()
            ->icon('heroicon-o-globe-alt')
    ])

As shown in the example above, you can chain MediaActions together with ->extraModalFooterActions() method.

Customizing the modal view

You can customize the modal view by publishing the view using :

php artisan vendor:publish --tag="filament-media-action-views"

Then, in the view, you can access :

• $mediaType: To retrieve the type of your media, which can be “youtube”, “audio”, “video”, “image” or “pdf”.
• $media : To retrieve the url of your media

Supported media extensions

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

• Mayonobe Hugo
• All Contributors

License

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