Filament Signature Pad

https://github.com/savannabits/filament-signature-pad
Admin
Filament Signature Pad is a PHP package that adds a signature capture field to FilamentPHP forms in...
Tokens:369
Snippets:6
Trust Score:7.7
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Publish FilamentPHP Assets

Source: https://github.com/savannabits/filament-signature-pad/blob/main/README.md

After installing the Signature Pad package, run this command to publish Filament's assets, ensuring that the plugin's necessary files are available in the public directory.

```bash
php artisan filament:assets
```

--------------------------------

### Install Signature Pad for FilamentPHP via Composer

Source: https://github.com/savannabits/filament-signature-pad/blob/main/README.md

This command installs the `coolsam/signature-pad` package into your PHP project using Composer, making it available for use with FilamentPHP.

```bash
composer require coolsam/signature-pad
```

--------------------------------

### Using and Configuring SignaturePad Field in Filament Forms

Source: https://github.com/savannabits/filament-signature-pad/blob/main/README.md

These PHP snippets demonstrate how to integrate and customize the SignaturePad field within your Filament forms. The first example shows basic instantiation, while the second illustrates various configuration options like background color, pen color, stroke properties, and hiding download buttons.

```php
use Coolsam\SignaturePad\Forms\Components\Fields\SignaturePad;

SignaturePad::make('my_signature'),
```

```php
SignaturePad::make('signature')
    ->backgroundColor('white') // Set the background color in case you want to download to jpeg
    ->penColor('blue') // Set the pen color
    ->strokeMinDistance(2.0) // set the minimum stroke distance (the default works fine)
    ->strokeMaxWidth(2.5) // set the max width of the pen stroke
    ->strokeMinWidth(1.0) // set the minimum width of the pen stroke
    ->strokeDotSize(2.0) // set the stroke dot size.
    ->hideDownloadButtons() // In case you don't want to show the download buttons on the pad, you can hide them by setting this option.
```

--------------------------------

### Run Package Tests

Source: https://github.com/savannabits/filament-signature-pad/blob/main/README.md

This Composer command executes the test suite for the `coolsam/signature-pad` package, verifying its functionality and ensuring stability.

```bash
composer test
```

--------------------------------

### Publish Signature Pad Configuration File

Source: https://github.com/savannabits/filament-signature-pad/blob/main/README.md

Use this command to publish the default configuration file for the `coolsam/signature-pad` package, enabling customization of its settings.

```bash
php artisan vendor:publish --tag="signature-pad-config"
```

--------------------------------

### Publish Signature Pad Translations

Source: https://github.com/savannabits/filament-signature-pad/blob/main/README.md

This command publishes the translation files specific to the `coolsam/signature-pad` package, allowing for localization of the Signature Pad field within your FilamentPHP application.

```bash
php artisan vendor:publish --tag="signature-pad-translations"
```
Tokens:
Raw