Blame view

vendor/rmrevin/yii2-fontawesome/README.md 4.78 KB
e9aa73b0   andryeyev   + adminLte
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
  Yii 2 Font Awesome Asset Bundle
  ===============================
  
  This extension provides a assets bundle with [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
  for [Yii framework 2.0](http://www.yiiframework.com/) applications and helper to use icons.
  
  For license information check the [LICENSE](https://github.com/rmrevin/yii2-fontawesome/blob/master/LICENSE)-file.
  
  [![License](https://poser.pugx.org/rmrevin/yii2-fontawesome/license.svg)](https://packagist.org/packages/rmrevin/yii2-fontawesome)
  [![Latest Stable Version](https://poser.pugx.org/rmrevin/yii2-fontawesome/v/stable.svg)](https://packagist.org/packages/rmrevin/yii2-fontawesome)
  [![Latest Unstable Version](https://poser.pugx.org/rmrevin/yii2-fontawesome/v/unstable.svg)](https://packagist.org/packages/rmrevin/yii2-fontawesome)
  [![Total Downloads](https://poser.pugx.org/rmrevin/yii2-fontawesome/downloads.svg)](https://packagist.org/packages/rmrevin/yii2-fontawesome)
  
  Code Status
  -----------
  [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/rmrevin/yii2-fontawesome/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/rmrevin/yii2-fontawesome/?branch=master)
  [![Code Coverage](https://scrutinizer-ci.com/g/rmrevin/yii2-fontawesome/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/rmrevin/yii2-fontawesome/?branch=master)
  [![Travis CI Build Status](https://travis-ci.org/rmrevin/yii2-fontawesome.svg)](https://travis-ci.org/rmrevin/yii2-fontawesome)
  [![Dependency Status](https://www.versioneye.com/user/projects/54119b799e16229fe00000da/badge.svg)](https://www.versioneye.com/user/projects/54119b799e16229fe00000da)
  
  Support
  -------
  [GutHub issues](https://github.com/rmrevin/yii2-fontawesome/issues) or [public chat](https://gitter.im/rmrevin/support).
  
  Installation
  ------------
  
  The preferred way to install this extension is through [composer](https://getcomposer.org/).
  
  Either run
  
  ```bash
  composer require "rmrevin/yii2-fontawesome:2.10.*"
  ```
  
  or add
  
  ```
  "rmrevin/yii2-fontawesome": "2.10.*",
  ```
  
  to the `require` section of your `composer.json` file.
  
  Usage
  -----
  
  In view
  
  ```php
  rmrevin\yii\fontawesome\AssetBundle::register($this);
  
  ```
  
  or as dependency in your main application asset bundle
  
  ```php
  class AppAsset extends AssetBundle
  {
  	// ...
  
  	public $depends = [
  		// ...
  		'\rmrevin\yii\fontawesome\AssetBundle'
  	];
  }
  
  ```
  
  Helper
  ------
  
  ```php
  use rmrevin\yii\fontawesome\FA;
  
  echo FA::icon('home'); // <i class="fa fa-home"></i>
  echo FA::icon(
      'arrow-left', 
      ['class' => 'big', 'data-role' => 'arrow']
  ); // <i class="big fa fa-arrow-left" data-role="arrow"></i>
  
  echo Html::submitButton(
      Yii::t('app', '{icon} Save', ['icon' => FA::icon('check')])
  ); // <button type="submit"><i class="fa fa-check"></i> Save</button>
  
  echo FA::icon('cog')->inverse();    // <i class="fa fa-cog fa-inverse"></i>
  echo FA::icon('cog')->spin();       // <i class="fa fa-cog fa-spin"></i>
  echo FA::icon('cog')->fixedWidth(); // <i class="fa fa-cog fa-fw"></i>
  echo FA::icon('cog')->ul();         // <i class="fa fa-cog fa-ul"></i>
  echo FA::icon('cog')->li();         // <i class="fa fa-cog fa-li"></i>
  echo FA::icon('cog')->border();     // <i class="fa fa-cog fa-border"></i>
  echo FA::icon('cog')->pullLeft();   // <i class="fa fa-cog pull-left"></i>
  echo FA::icon('cog')->pullRight();  // <i class="fa fa-cog pull-right"></i>
  
  echo FA::icon('cog')->size(FA::SIZE_3X);
  // values: FA::SIZE_LARGE, FA::SIZE_2X, FA::SIZE_3X, FA::SIZE_4X, FA::SIZE_5X
  // <i class="fa fa-cog fa-size-3x"></i>
  
  echo FA::icon('cog')->rotate(FA::ROTATE_90); 
  // values: FA::ROTATE_90, FA::ROTATE_180, FA::ROTATE_180
  // <i class="fa fa-cog fa-rotate-90"></i>
  
  echo FA::icon('cog')->flip(FA::FLIP_VERTICAL); 
  // values: FA::FLIP_HORIZONTAL, FA::FLIP_VERTICAL
  // <i class="fa fa-cog fa-flip-vertical"></i>
  
  echo FA::icon('cog')
          ->spin()
          ->fixedWidth()
          ->pullLeft()
          ->size(FA::SIZE_LARGE);
  // <i class="fa fa-cog fa-spin fa-fw pull-left fa-size-lg"></i>
  
  echo FA::stack()
          ->icon('twitter')
          ->on('square-o');
  // <span class="fa-stack">
  //   <i class="fa fa-square-o fa-stack-2x"></i>
  //   <i class="fa fa-twitter fa-stack-1x"></i>
  // </span>
  
  echo FA::stack(['data-role' => 'stacked-icon'])
       ->on((new FA\Icon('square'))->inverse())
       ->icon((new FA\Icon('cog'))->spin());
  // <span class="fa-stack" data-role="stacked-icon">
  //   <i class="fa fa-square-o fa-inverse fa-stack-2x"></i>
  //   <i class="fa fa-cog fa-spin fa-stack-1x"></i>
  // </span>
  
  // autocomplete icons name in IDE
  echo FA::icon(FA::_COG);
  echo FA::icon(FA::_DESKTOP);
  echo FA::stack()
       ->on((new FA\Icon(FA::_SQUARE))->inverse())
       ->icon((new FA\Icon(FA::_COG))->spin());
  ```
  
  ### Set another prefix
  
  ```php
  FA::$cssPrefix = 'awf';
  
  echo FA::icon('home');
  // <i class="awf awf-home"></i>
  echo FA::icon('cog')->inverse();
  // <i class="awf awf-cog awf-inverse"></i>
  ```