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

update docs

parent a30c62c1
Branches
No related tags found
1 merge request!14Update renderer class
......@@ -34,6 +34,17 @@ Variable | Description
{{PAGE_FOOTER_RIGHT}} | page: footer on the left |
{{PAGE_FOOTER_LEFT}} | page: footer on the right |
#### No left sidebar
This shows the left sidebar:
`'{{PAGE_LAYOUT}}' =>'layout-navbar-fixed layout-fixed sidebar-mini',`
This hides the left sidebar:
`'{{PAGE_LAYOUT}}' =>'layout-top-nav sidebar-collapse',`
If you don't have any left sidebar then additionally remove the hampurger menu from the top menu.
## Initial example
### Init Renderer class
......
......@@ -6,6 +6,7 @@ For the top navigation and left the basic array looks like this:
```php
return [
['label'=>'='],
['href'=>'#', 'label'=>'Menu A', 'icon'=>'fa-solid fa-home' ],
['href'=>'#', 'label'=>'Menu B', 'icon'=>'fa-solid fa-tv'],
['href'=>'#', 'label'=>'Menu C', 'icon'=>'fa-solid fa-truck-pickup', 'class'=>'active',
......@@ -29,6 +30,8 @@ children | array that contains 2nd Level
For top navigation in thwe 2nd level (below children) define a label value with a single minus character to draw a line:
`['label'=>'-']`
The hamburger menu is rendered by `['label'=>'=']`. Remove this item when you don't want a left sidebar or it is static.
### Show navigation on top
The top navigation is for the placeholder `{{NAVI_TOP}}`.
......
## Tabbed content
Show multiple horizontal tabs and a content container that switches its content by selecting a tab.
### Syntax
```php
$renderAdminLTE->getTabbedContent($aOptions, $asArray=false);
```
### Return
{string} html code or {array}
### Parameters
* $aOptions - {array} options to describe the element
Styling:
Key | Description
--- | ---
asArray | boolean; if true it returns an array for tab list and container to draw them individually
Content:
Key | Description
--- | ---
tabs | tabs {array} key=tab label; value=content
### Example
```php
$renderAdminLTE->getTabbedContent(array (
'tabs' => array(
'one'=>'content of tab one',
'two'=>'content of 2nd tab',
'three'=>'content of 3rd tab',
)
));
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment