Administrator / realy_old_artbox

Blame view

vendor/kartik-v/yii2-krajee-base/README.md 4.94 KB
Edit Raw Normal View History
583ea05f   andryeyev   + widget-select2 
1
2
3
 
  yii2-krajee-base
  ================
280e92c2   Dmitryi   авторизация через... 
4
 
  [![Latest Stable Version](https://img.shields.io/packagist/v/kartik-v/yii2-krajee-base.svg)](https://packagist.org/packages/kartik-v/yii2-krajee-base)
583ea05f   andryeyev   + widget-select2 
5
6
7
8
9
10
11
12
13
14
15
16
17
 
  [![License](https://poser.pugx.org/kartik-v/yii2-krajee-base/license)](https://packagist.org/packages/kartik-v/yii2-krajee-base)
  [![Total Downloads](https://poser.pugx.org/kartik-v/yii2-krajee-base/downloads)](https://packagist.org/packages/kartik-v/yii2-krajee-base)
  [![Monthly Downloads](https://poser.pugx.org/kartik-v/yii2-krajee-base/d/monthly)](https://packagist.org/packages/kartik-v/yii2-krajee-base)
  [![Daily Downloads](https://poser.pugx.org/kartik-v/yii2-krajee-base/d/daily)](https://packagist.org/packages/kartik-v/yii2-krajee-base)
  
  This is a base library with set of foundation classes and components used by all [Yii2 extensions by Krajee](http://demos.krajee.com). One can use this base library during creation of one's own extensions if needed.
  
  > NOTE: This extension depends on the [yiisoft/yii2-bootstrap](https://github.com/yiisoft/yii2/tree/master/extensions/bootstrap) extension. Check the [composer.json](https://github.com/kartik-v/yii2-krajee-base/blob/master/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](https://github.com/kartik-v/yii2-grid/issues/123). 
  
  ## Latest Release
280e92c2   Dmitryi   авторизация через... 
18
 
  The latest version of the extension is v1.7.8. Refer the [CHANGE LOG](https://github.com/kartik-v/yii2-krajee-base/blob/master/CHANGE.md) for details.
583ea05f   andryeyev   + widget-select2 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
  
  ## Extension Classes
  
  ### [Module](https://github.com/kartik-v/yii2-krajee-base/blob/master/Module.php)
  Extends [Yii Module](https://github.com/yiisoft/yii2/blob/master/framework/base/Module.php) class for Krajee's Yii2 widgets and usage with translation properties enabled. 
  
  ### [Widget](https://github.com/kartik-v/yii2-krajee-base/blob/master/Widget.php)
  Extends [Yii Widget](https://github.com/yiisoft/yii2/blob/master/framework/base/Widget.php) class for Krajee's Yii2 widgets and usage with bootstrap CSS framework. 
  
  ### [InputWidget](https://github.com/kartik-v/yii2-krajee-base/blob/master/InputWidget.php)
  Extends [Yii InputWidget](https://github.com/yiisoft/yii2/blob/master/framework/widgets/InputWidget.php) 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](https://github.com/kartik-v/yii2-krajee-base/blob/master/TranslationTrait.php)
  A trait for handling translation functionality using Yii's i18n components.
  
  ### [WidgetTrait](https://github.com/kartik-v/yii2-krajee-base/blob/master/WidgetTrait.php)
  A trait for Krajee widgets including prebuilt methods for plugin registration.
  	
  ### [AssetBundle](https://github.com/kartik-v/yii2-krajee-base/blob/master/AssetBundle.php)
  Extends [Yii AssetBundle](https://github.com/yiisoft/yii2/blob/master/framework/web/AssetBundle.php) class for Krajee's Yii2 widgets with enhancements for using minimized CSS and JS based on debug mode.
  
  ### [PluginAssetBundle](https://github.com/kartik-v/yii2-krajee-base/blob/master/PluginAssetBundle.php)
  Extension of the above [AssetBundle](https://github.com/kartik-v/yii2-krajee-base/blob/master/AssetBundle.php) to include dependency on Bootstrap javascript plugins.
  
  ### [AnimateAsset](https://github.com/kartik-v/yii2-krajee-base/blob/master/AnimateAsset.php)
  An asset bundle for loading various CSS3 animations and effects.
  
  ### [Html5Input](https://github.com/kartik-v/yii2-krajee-base/blob/master/Html5Input.php)
  A modified input widget for rendering HTML5 inputs with bootstrap styling and input group addons for Krajee's Yii 2 extensions.
  
  ### [Config](https://github.com/kartik-v/yii2-krajee-base/blob/master/Config.php)
  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](http://getcomposer.org/download/).
  
  > Note: Read this [web tip /wiki](http://webtips.krajee.com/setting-composer-minimum-stability-application/) 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.