kartik-v / yii2-icons
Set of icon frameworks for use in Yii Framework 2.0
Installs: 746 738
Dependents: 63
Suggesters: 0
Security: 0
Stars: 71
Watchers: 8
Forks: 27
Open Issues: 5
Language:CSS
Type:yii2-extension
Requires
README
yii2-icons
This extension offers an easy method to setup various icon frameworks to work with Yii Framework 2.0. Most popular and free icon frameworks available are currently supported. This list may be extended in future based on demand and feedback.
- Bootstrap Glyphicons
- Font Awesome
- Unicode Icons: A collection of unicode symbols made available as CSS icons by Krajee
- Elusive Icons
- Typicons
- Web Hosting Hub Glyphs
- JQuery UI Icons
- Socicon Icons: Needs you to add attribution to the icon source.
- Octicons: The Github icons collection.
- Flag-Icons
- Open Iconic Icons
- IcoFont Icons
Demo
You can see a demonstration here and API Code Documentation on usage of this extension with documentation and examples.
Installation
The preferred way to install this extension is through composer.
Note: Check the composer.json for this extension's requirements and dependencies. 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-icons "@dev"
or add
"kartik-v/yii2-icons": "@dev"
to the require
section of your composer.json
file.
Usage
Global Setup
In case you wish to setup one Icon framework globally, set the parameter icon-framework
in the params
array of your Yii Configuration File.
'params' => [ 'icon-framework' => \kartik\icons\Icon::FAS, // Font Awesome Icon framework ]
To initialize the globally setup framework in your view, call this code in your view or view layout file.
use kartik\icons\Icon; Icon::map($this);
Per View Setup
You can also call each icon-framework individually in your view or view layout like below. Map any icon framework within each view as in the example below.
use kartik\icons\Icon; Icon::map($this, Icon::EL); // Maps the Elusive icon font framework
Displaying Icons
After mapping your icon framework with one of the options above, you can display icons using Icon::show
method. Icons can be displayed using one of the options below:
use kartik\icons\Icon; // Option 1: Uses the `icon-framework` setup in Yii config params. echo Icon::show('user'); // Option 2: Specific Icon Call in a view. Additional options can also be passed to style the icon. echo Icon::show('user', ['class'=>'fa-2x', 'framework' => Icon::FAS]);
NOTE: The
kartik\icons\Icon::show
method outputs a HTML formatted text. So in order to display icons in Yii-2 components like Navbar or Nav, you must setencodeLabels
to false.
$items = [ ['label' => Icon::show('home') . 'Home', 'url' => ['/site/index']], ]; // Your other code /* Note you must encodeLabels to false to display icons in labels */ echo \kartik\nav\NavX::widget([ 'items' => $items, 'encodeLabels' => false ]); // Your other code
Displaying Stacked Icons
You can also display stacked icons for frameworks like Font Awesome, where this is supported. For example:
use kartik\icons\Icon; // fa-twitter on fa-square Icon::showStack('twitter', 'square', ['class'=>'fa-lg'], ['framework' => Icon::FAB], ['framework' => Icon::FAR]) // fa-flag on fa-circle Icon::showStack('flag', 'circle', ['class'=>'fa-lg'], ['class'=>'fa-inverse']);
Add Custom Icons
You can add custom icon sets to the list of available frameworks.
use kartik\icons\Icon; // add framework Icon::addFramework('custom', [ 'class' => '\common\icons\CustomIconAsset', 'prefix' => 'custom-icon', ]); // map to view file Icon::map($this, 'custom'); // show the icon echo Icon::show('menu',['framework' => 'custom']);
namespace common\icons; class CustomIconAsset extends \yii\web\AssetBundle { public $sourcePath = '@common/icons/assets/custom'; public $depends = array( 'yii\web\YiiAsset', 'yii\bootstrap4\BootstrapAsset' ); public $css=[ 'css/animation.css', 'css/custom-codes.css', 'css/custom-embedded.css', 'css/custom-ie7.css', 'css/custom-ie7-codes.css', 'css/custom.css', ]; }
The above asset bundle uses files genereted by http://fontello.com/.
License
yii2-icons is released under the BSD-3-Clause License. See the bundled LICENSE.md
for details.