From 220b8a1176ecaaa47d2e6e3ed8bf7be56b93b8c0 Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch> Date: Fri, 16 Dec 2022 17:00:47 +0100 Subject: [PATCH] add docpage for smallbox --- docs/50_Components/Smallbox.md | 47 ++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docs/50_Components/Smallbox.md diff --git a/docs/50_Components/Smallbox.md b/docs/50_Components/Smallbox.md new file mode 100644 index 0000000..a57f687 --- /dev/null +++ b/docs/50_Components/Smallbox.md @@ -0,0 +1,47 @@ +## Smallbox + +Solid colored box to highlight a single value; optional with a link + +### Syntax + +```php +$renderAdminLTE->getSmallbox($aOptions); +``` + +### Return + +{string} html code + +### 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 + +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 +url | optional: url to set a link on the bottom +linktext | used if a url was given: linked text + +### Example + +```php +$renderAdminLTE->getSmallbox(array ( + 'type' => 'info', + 'icon' => 'fas fa-shopping-cart', + 'text' => 'New orders', + 'number' => '150', + 'url' => '#', + 'linktext' => 'More info', +)) +``` -- GitLab