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

update docs: add screenshots

parent 59ef23fb
No related branches found
No related tags found
1 merge request!4update docs: add screenshots
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
An alert is a colored box with title and text. An alert is a colored box with title and text.
![Alert](../images/examples_alert.png)
### Syntax ### Syntax
```php ```php
...@@ -43,5 +45,5 @@ $renderAdminLTE->getAlert(array ( ...@@ -43,5 +45,5 @@ $renderAdminLTE->getAlert(array (
'title' => 'I need your attention', 'title' => 'I need your attention',
'dismissible' => 1, 'dismissible' => 1,
'text' => 'Please check it. Maybe there is something wrong here.', 'text' => 'Please check it. Maybe there is something wrong here.',
)) ));
``` ```
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
A badge is a small counter or info next to a text info, A badge is a small counter or info next to a text info,
![Badge](../images/examples_badge.png)
### Syntax ### Syntax
```php ```php
...@@ -44,5 +46,5 @@ $renderAdminLTE->getBadge([ ...@@ -44,5 +46,5 @@ $renderAdminLTE->getBadge([
'type'=>'danger', 'type'=>'danger',
'title'=>'Errors: 5', 'title'=>'Errors: 5',
'text'=>'5', 'text'=>'5',
]) ]);;
``` ```
...@@ -3,7 +3,9 @@ ...@@ -3,7 +3,9 @@
An html button tag with formatting. An html button tag with formatting.
You can use any other key that are not named here. Those keys will be rendered as additional html attributes without modification. You can use any other key that are not named here. Those keys will be rendered as additional html attributes without modification.
button
![Button](../images/examples_button.png)
### Syntax ### Syntax
...@@ -40,5 +42,5 @@ $renderAdminLTE->getButton([ ...@@ -40,5 +42,5 @@ $renderAdminLTE->getButton([
'class'=>'primary', 'class'=>'primary',
'text'=>'Click me', 'text'=>'Click me',
'onclick'=>'alert(\'Hello!\');' 'onclick'=>'alert(\'Hello!\');'
]) ]);
``` ```
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
A box with colored left border. It has type, title + text. A box with colored left border. It has type, title + text.
![Callout](../images/examples_callout.png)
### Syntax ### Syntax
```php ```php
...@@ -37,5 +39,5 @@ $renderAdminLTE->getCallout(array ( ...@@ -37,5 +39,5 @@ $renderAdminLTE->getCallout(array (
'type' => 'success', 'type' => 'success',
'title' => 'I am a success callout', 'title' => 'I am a success callout',
'text' => 'This is a gren callout.', 'text' => 'This is a gren callout.',
)) ));
``` ```
...@@ -4,6 +4,8 @@ A div to display boxed content. ...@@ -4,6 +4,8 @@ A div to display boxed content.
It has header, main text and a footer. It has header, main text and a footer.
![Card](../images/examples_card.png)
### Syntax ### Syntax
```php ```php
...@@ -60,5 +62,5 @@ $renderAdminLTE->getCard(array ( ...@@ -60,5 +62,5 @@ $renderAdminLTE->getCard(array (
'tools' => '123', 'tools' => '123',
'text' => 'Hello everybody out there!', 'text' => 'Hello everybody out there!',
'footer' => '© Axel', 'footer' => '© Axel',
)) ));
``` ```
...@@ -2,10 +2,12 @@ ...@@ -2,10 +2,12 @@
A div box - kind of a tile - to show an icon, text, value; optional with a progress bar. A div box - kind of a tile - to show an icon, text, value; optional with a progress bar.
![Infobox](../images/examples_infobox.png)
### Syntax ### Syntax
```php ```php
$renderAdminLTE->getCard($aOptions); $renderAdminLTE->getInfobox($aOptions);
``` ```
### Return ### Return
...@@ -46,5 +48,5 @@ $renderAdminLTE->getInfobox(array ( ...@@ -46,5 +48,5 @@ $renderAdminLTE->getInfobox(array (
'number' => '41,410', 'number' => '41,410',
'progressvalue' => 70, 'progressvalue' => 70,
'progresstext' => '70% Increase in 30 Days', 'progresstext' => '70% Increase in 30 Days',
)) ));
``` ```
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
Solid colored box to highlight a single value; optional with a link Solid colored box to highlight a single value; optional with a link
![Smallbox](../images/examples_smallbox.png)
### Syntax ### Syntax
```php ```php
...@@ -43,5 +45,5 @@ $renderAdminLTE->getSmallbox(array ( ...@@ -43,5 +45,5 @@ $renderAdminLTE->getSmallbox(array (
'number' => '150', 'number' => '150',
'url' => '#', 'url' => '#',
'linktext' => 'More info', 'linktext' => 'More info',
)) ));
``` ```
docs/images/examples_alert.png

68.9 KiB

docs/images/examples_badge.png

59.5 KiB

docs/images/examples_button.png

31.2 KiB

docs/images/examples_callout.png

55.2 KiB

docs/images/examples_card.png

62.1 KiB

docs/images/examples_infobox.png

60.7 KiB

docs/images/examples_smallbox.png

82.2 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment