Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webbingbrasil/filament-copyactions
A easy-to-use copy actions for Filament Admin Pages, Tables and Form Fields.
https://github.com/webbingbrasil/filament-copyactions
Last synced: 4 days ago
JSON representation
A easy-to-use copy actions for Filament Admin Pages, Tables and Form Fields.
- Host: GitHub
- URL: https://github.com/webbingbrasil/filament-copyactions
- Owner: webbingbrasil
- Created: 2022-09-03T17:09:59.000Z (about 2 years ago)
- Default Branch: 3.x
- Last Pushed: 2024-04-03T12:16:39.000Z (7 months ago)
- Last Synced: 2024-10-03T13:18:15.889Z (about 1 month ago)
- Language: Blade
- Homepage:
- Size: 104 KB
- Stars: 63
- Watchers: 4
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-filament - webbingbrasil/filament-copyactions - A easy-to-use copy actions for Admin Pages, Tables and Form Fields. (UI)
README
# Filament Copy Actions
> **Note**
> For **Filament 2.x** use **[2.x](https://github.com/webbingbrasil/filament-copyactions/tree/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](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API). Also, the user must be on a secure context (HTTPS) or localhost.
## Installation
```bash
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](https://filamentphp.com/docs/2.x/tables/columns#text-column) and the copy action sends column content to the clipboard and displays a success tooltip.
```php
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:
```php
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](https://filamentphp.com/docs/2.x/tables/actions#setting-a-color).
```php
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](https://filamentphp.com/docs/2.x/tables/actions#setting-a-color).
```php
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.
```php
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](https://filamentphp.com/docs/2.x/tables/actions#setting-a-color).
```php
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.
```php
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](https://github.com/dmandrade)