Yii Framework Masked input widget Extension
Clone or download

README.md

Yii Framework Masked input widget Extension


This is the Masked Input extension for Yii framework. It provides a masked input widget based on jQuery Input Mask plugin.

For license information check the LICENSE-file.

Latest Stable Version Total Downloads Build Status

Installation

The preferred way to install this extension is through composer.

composer require --prefer-dist yiisoft/yii-masked-input

Usage

To use MaskedInput, you must set the [[mask]] property. The following example shows how to use MaskedInput to collect phone numbers:

echo MaskedInput::widget([
    'name' => 'phone',
    'mask' => '999-999-9999',
]);

You can also use this widget in an [[ActiveForm]] using the [[ActiveField::widget()|widget()]] method, for example like this:

<?= $form->field($model, 'from_date')->widget(yii\widgets\MaskedInput::class, [
    'mask' => '999-999-9999',
]) ?>