README

This extension provides a Signature Pad widget for Yii framework 2.0.

It wraps the INTELOGIE/signature_pad library.

Latest Stable Version

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist diggindata/yii2-signaturepad

or add

"diggindata/yii2-signaturepad": "@dev"

to the require section of your composer.json, then run composer update.

Usage

In your form model, declare an attribute:

    public $signature;

    public function rules()
    {
        return [
            ...
            ['signature', 'safe'],
        ];
    }

In your form view file, include the widget:

    <?= SignaturePadWidget::widget([
        'model' => $model,
        'attribute' => 'signature',
        'options' => ['style' => 'min-width:300px;min-height:200px;'],
        'showSaveAsJpg' => false,
    ]) ?>

Attributes

model - The form instance, either a yii\db\ActiveRecord or a yii\base\Model instance

attribute - the model's attribute name

showSaveAsJpg - Whether to show the Accept (JPG) and Save (JPG) buttons

showSaveAsPng - Whether to show the Accept (PNG) and Save (PNG) buttons