Skip to content
Snippets Groups Projects
Commit 0baf167e authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

add docs for infobox

parent 6d878d2e
No related branches found
No related tags found
No related merge requests found
## Infobox
A div box - kind of a tile - to show an icon, text, value; optional with a progress bar.
### Syntax
```php
$renderAdminLTE->getCard($aOptions);
```
### Parameters
* $aOptions - {array} options to describe the element
Styling:
Key | Description
--- | ---
type | one of [none]\|danger\|dark\|info\|primary\|secondary\|success\|warning
shadow | size of shadow; one of [none] (=default: between small and regular)|none|small|regular|large
iconbg | background color or type of icon; use it for default type (type="")
Content:
Key | Description
--- | ---
icon | icon css class; eg. fontawesome "far fa-thumbs-up"
text | visible text
number | Value as string, eg. to format large integers
progressvalue | optional: integer: progress bar; range: 0..100
progresstext | optional: text below progress bar
### Example
```php
$renderAdminLTE->getInfobox(array (
'type' => 'success',
'bgcolor' => '',
'shadow' => '',
'icon' => 'far fa-thumbs-up',
'text' => 'Likes',
'number' => '41,410',
'progressvalue' => 70,
'progresstext' => '70% Increase in 30 Days',
))
```
......@@ -14,7 +14,8 @@ $aComponents=[
'description'=>'Success infobox with progress',
'params'=>[
'type'=>'success',
'bgcolor'=>'',
'iconbg'=>'',
'shadow'=>'',
'icon'=>'far fa-thumbs-up',
'text'=>'Likes',
'number'=>"41,410",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment