README

Yii Framework

jQuery Integration Extension for Yii2

This extension provides the optional jQuery integration layer for Yii Framework 2.0 applications. It supplies jQuery-backed asset bundles, client-side validation scripts, and widget client scripts for every core validator, grid component, and widget that supports the client-script strategy pattern.

Installation

Important

The minimum required PHP version is PHP 8.3.
Requires yiisoft/yii2 22.x.

The preferred way to install this extension is through composer.

Either run

composer require --prefer-dist yiisoft/yii2-jquery:~1.0.0

or add

"yiisoft/yii2-jquery": "~1.0.0"

to the require section of your composer.json file.

Usage

Once the extension is installed, register the bootstrap class in your application configuration:

return [
    'bootstrap' => [
        \yii\jquery\Bootstrap::class,
    ],
    // ...
];

The Bootstrap class configures the DI container with jQuery-based $clientScript defaults for every core validator, grid component, and widget that supports the client-script strategy pattern. No further configuration is required.

Overriding a single validator

You can override the client-script implementation on a per-rule basis by passing the clientScript key in the rule definition:

public function rules(): array
{
    return [
        [
            'email',
            'required',
            'clientScript' => ['class' => MyCustomRequiredClientScript::class],
        ],
    ];
}