kartik-v/yii2-krajee-base

Base library and foundation components for all Yii2 Krajee extensions.

v1.8.8 2017-02-22 05:58 UTC

README

Stable Version Unstable Version License Total Downloads Monthly Downloads Daily Downloads

This is a base library with set of foundation classes and components used by all Yii2 extensions by Krajee. One can use this base library during creation of one's own extensions if needed.

NOTE: This extension depends on the yiisoft/yii2-bootstrap extension. Check the composer.json for this extension's requirements and dependencies.

Why this extension?

To ensure a leaner code base / foundation component for use in all Krajee extensions (e.g. yii2-widgets, yii2-datecontrol, yii2-grid, yii2-dynagrid etc.). This should allow most developers to plug and play components only they need, without needing the complete suite of widgets. For example, this mitigates this issue.

Latest Release

The latest version of the extension is v1.8.9. Refer the CHANGE LOG for details.

Extension Classes

Module

Extends Yii Module class for Krajee's Yii2 widgets and usage with translation properties enabled.

Widget

Extends Yii Widget class for Krajee's Yii2 widgets and usage with bootstrap CSS framework.

InputWidget

Extends Yii InputWidget class for Krajee's Yii2 widgets and usage with bootstrap CSS framework. With release v1.3.0, the Input widget automatically now attaches the following HTML5 data attribute for each input that registers jQuery plugins via registerPlugin method:

  • data-krajee-{name} the client options of the plugin. The tag {name} will be replaced with the registered jQuery plugin name (e.g. select2, typeahead etc.).

TranslationTrait

A trait for handling translation functionality using Yii's i18n components.

WidgetTrait

A trait for Krajee widgets including prebuilt methods for plugin registration.

AssetBundle

Extends Yii AssetBundle class for Krajee's Yii2 widgets with enhancements for using minimized CSS and JS based on debug mode.

PluginAssetBundle

Extension of the above AssetBundle to include dependency on Bootstrap javascript plugins.

AnimateAsset

An asset bundle for loading various CSS3 animations and effects.

Html5Input

A modified input widget for rendering HTML5 inputs with bootstrap styling and input group addons for Krajee's Yii 2 extensions.

Config

A global configuration and validation helper class for usage across Krajee's Yii 2 extensions.

Installation

The preferred way to install this extension is through composer.

Note: Read this web tip /wiki on setting the minimum-stability settings for your application's composer.json.

Either run

$ php composer.phar require kartik-v/yii2-krajee-base "dev-master"

or add

"kartik-v/yii2-krajee-base": "dev-master"

to the require section of your composer.json file.

License

yii2-krajee-base is released under the BSD 3-Clause License. See the bundled LICENSE.md for details.