README

This is the Semantic UI extension for Yii2. It encapsulates Semantic UI components and plugins in terms of Yii widgets and helper classes, easing the usage of Semantic UI components/plugins into Yii applications.

Install

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist "2amigos/yii2-semantic-ui": "*"

or add

"2amigos/yii2-semantic-ui": "*"

to the require section of your composer.json file.

Usage

We are in the process of building a site for this extensions in the meantime, for example, making use of the Dropdown module widget with a search-in menu feature is as follows:

echo Dropdown::widget([
    'encodeText' => false,
    'text' => '<i class="filter icon"></i><span class="text">Filter posts</span>',
    'icon' => false,
    'displaySearchInput' => true,
    'encodeItemLabels' => false,
    'items' => [
        '<div class="header"><i class="tags icon"></i>Tag Label</div>',
        ['label' => '<div class="ui red empty circular label"></div>Important'],
        ['label' => '<div class="ui blue empty circular label"></div>Announcement']
    ],
    'options' => [
        'class' => 'floating labeled search icon button'
    ],
]
);

Testing

To test the extension, is better to clone this repository on your computer. After, go to the extensions folder and do the following (assuming you have composer installed on your computer:

$ composer install --no-interaction --prefer-source --dev

Once all required libraries are installed then do:

$ phpunit

You can also run tests for specific groups only:

$ phpunit --group=helpers,modules

You can get a list of available groups via phpunit --list-groups.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The BSD License (BSD). Please see License File for more information.

web development has never been so fun
www.2amigos.us

2amigos / yii2-semantic-ui

Maintainers

Details