Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kartik-v/yii2-widget-alert
An extended bootstrap alert and alert block widget for Yii2 (sub repo split from yii2-widgets)
https://github.com/kartik-v/yii2-widget-alert
Last synced: 1 day ago
JSON representation
An extended bootstrap alert and alert block widget for Yii2 (sub repo split from yii2-widgets)
- Host: GitHub
- URL: https://github.com/kartik-v/yii2-widget-alert
- Owner: kartik-v
- License: other
- Created: 2014-11-09T08:44:45.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-10-28T04:02:03.000Z (about 3 years ago)
- Last Synced: 2024-10-29T15:19:14.714Z (10 days ago)
- Language: PHP
- Size: 31.3 KB
- Stars: 28
- Watchers: 4
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
yii2-widget-alert
[](https://packagist.org/packages/kartik-v/yii2-widget-alert)
[](https://packagist.org/packages/kartik-v/yii2-widget-alert)
[](https://packagist.org/packages/kartik-v/yii2-widget-alert)
[](https://packagist.org/packages/kartik-v/yii2-widget-alert)
[](https://packagist.org/packages/kartik-v/yii2-widget-alert)
[](https://packagist.org/packages/kartik-v/yii2-widget-alert)
This extension contains a couple of useful widgets. The `Alert` widget extends the `\yii\bootstrap\Alert` widget with more easy styling and auto fade out options. In addition, it includes a `AlertBlock` widget that groups multiple `\kartik\widget\Alert` or `kartik\widget\Growl` widgets in one single block and renders them stacked vertically on the current page.
You can choose the `TYPE_ALERT` style or the `TYPE_GROWL` style for your notifications. You can also set the widget to automatically read and display session flash
messages (which is the default setting). Alternatively, you can setup and configure your own block of custom alerts.
> NOTE: This extension is a sub repo split of [yii2-widgets](https://github.com/kartik-v/yii2-widgets). The split has been done since 08-Nov-2014 to allow developers to install this specific widget in isolation if needed. One can also use the extension the previous way with the whole suite of [yii2-widgets](http://demos.krajee.com/widgets).
## Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/). Check the [composer.json](https://github.com/kartik-v/yii2-widget-alert/blob/master/composer.json) for this extension's requirements and dependencies. 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.
To install, either run
```
$ php composer.phar require kartik-v/yii2-widget-alert "*"
```
or add
```
"kartik-v/yii2-widget-alert": "*"
```
to the ```require``` section of your `composer.json` file.
> NOTE: Using Growl is optional and it is not automatically installed with this extension. If you want to use it in your project, you need to either run
```
$ php composer.phar require kartik-v/yii2-widget-growl "*"
```
or add
```
"kartik-v/yii2-widget-growl": "*"
```
to the `require` section of your `composer.json` file.
> Refer the [CHANGE LOG](https://github.com/kartik-v/yii2-widget-alert/blob/master/CHANGE.md) for details on changes to various releases.
## Demo
You can refer detailed documentation and demos for [Alert](http://demos.krajee.com/widget-details/alert) and [AlertBlock](http://demos.krajee.com/widget-details/alert-block) widgets on usage of the extension.
## Usage
### Alert
```php
use kartik\alert\Alert;
echo Alert::widget([
'type' => Alert::TYPE_INFO,
'title' => 'Note',
'titleOptions' => ['icon' => 'info-sign'],
'body' => 'This is an informative alert'
]);
```
### AlertBlock
```php
use kartik\alert\AlertBlock;
echo AlertBlock::widget([
'type' => AlertBlock::TYPE_ALERT,
'useSessionFlash' => true
]);
```
## License
**yii2-widget-alert** is released under the BSD-3-Clause License. See the bundled `LICENSE.md` for details.