webbingbrasil/filament-copyactions

A easy-to-use copy actions for Filament Admin.

3.0.1 2024-04-03 12:14 UTC

Requires

• php: ^8.0
• filament/filament: ^3.0

MIT

• Danilo Andrade

• laravel
• filament

README

Note For Filament 2.x use 2.x branch

An easy-to-use copy actions for Filament Admin

• Table action to implement dynamic copy content
• Form action to use with any field
• Page action to implement a dynamic copy button on any page
• Custom copy table column to simply copy text content

Note The copy will only work if the user browser supports Clipboard API. Also, the user must be on a secure context (HTTPS) or localhost.

Installation

composer require webbingbrasil/filament-copyactions

Usage

Table Column

Display a table text column with a copy button, the column has all features of the TextColumn and the copy action sends column content to the clipboard and displays a success tooltip.

use Webbingbrasil\FilamentCopyActions\Tables\CopyableTextColumn;

CopyableTextColumn::make('brand.name')
    ->copyMessage('Brand copied to clipboard')
    ->searchable()
    ->sortable()
    ->toggleable()

The column has an option to display a description above or below the text, by default this description is not copied, if you want to copy the description too, use the copyWithDescription method.

Success message

You can customize the success message with the copyMessage method, the default message is Copied!.

Icon Position and Color

You can customize the icon with the icon, iconPosition and iconColor methods.

Only Display Copy Icon

You can display the column hidding the text content and only showing the copy icon:

use Webbingbrasil\FilamentCopyActions\Tables\CopyableTextColumn;

CopyableTextColumn::make('brand.name')->onlyIcon()

Table Action

Display a table action button, you set the content using the copyable method. You can customize the button icon/color using the same methods of the Filament Action.

use Webbingbrasil\FilamentCopyActions\Tables\Actions\CopyAction;

$table
    ->actions([
        CopyAction::make()->copyable(fn ($record) => $record->name),
    ])

Success message

The action will display a copy status, you can customize the success message with the successNotificationMessage method or the error message with the errorNotificationMessage method.

Form Action

Use the CopyAction in your field suffix or prefix if you want to copy a field value. You can customize the button icon/color using the same methods of the Filament Action.

use Webbingbrasil\FilamentCopyActions\Forms\Actions\CopyAction;

Forms\Components\TextInput::make('sku')
    ->label('SKU (Stock Keeping Unit)')
    ->suffixAction(CopyAction::make())
    ->required();
    
Forms\Components\Select::make('shop_brand_id')
    ->relationship('brand', 'name')
    ->prefixAction(CopyAction::make())
    ->searchable();

You can use this form action in any filament field, the action will copy the field value to the clipboard by default, but you can customize the value with the copyable method.

use Webbingbrasil\FilamentCopyActions\Forms\Actions\CopyAction;

Forms\Components\Select::make('shop_brand_id')
    ->relationship('brand', 'name')
    ->prefixAction(CopyAction::make()->copyable(fn ($component) => $component->getOptionLabel()))
    ->searchable();

Success message

The action will display a copy status, you can customize the success message with the successNotificationMessage method or the error message with the errorNotificationMessage method.

Page Action

You can add CopyAction button to any page in filament, just put the action in the actions method of the page. You can customize the button icon/color using the same methods of the Filament Action.

use Webbingbrasil\FilamentCopyActions\Pages\Actions\CopyAction;

protected function getActions(): array
{
    return [
        CopyAction::make()->copyable(fn () => $this->record->name),
    ];
}

The action will display a copy status, you can customize the success message with the successNotificationMessage method or the error message with the errorNotificationMessage method.

CopyAction Tip

By default, CopyAction does not trigger a livewire request, so it only returns the value defined in the copyable method during page rendering.

However, if it is necessary for the copied value to be dynamic at each action trigger, you can use the action() method.

CopyAction::make()->copyable(fn () => $this->voucher)->action(fn() => $this->generateVoucher()),

You can use this technique in actions for form, pages, or tables.

Credits

• Danilo Andrade