From c4d37278736eb97865d378bfce1368d22567e350 Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch>
Date: Fri, 17 Nov 2023 17:20:47 +0100
Subject: [PATCH] update docs
---
docs/30_Page/10_Page_layout.md | 11 ++++++++
docs/30_Page/20_Navigation.md | 3 ++
docs/40_Components/Tabbed_content.md | 41 ++++++++++++++++++++++++++++
3 files changed, 55 insertions(+)
create mode 100644 docs/40_Components/Tabbed_content.md
diff --git a/docs/30_Page/10_Page_layout.md b/docs/30_Page/10_Page_layout.md
index ddcfea6..055e8b8 100644
--- a/docs/30_Page/10_Page_layout.md
+++ b/docs/30_Page/10_Page_layout.md
@@ -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
diff --git a/docs/30_Page/20_Navigation.md b/docs/30_Page/20_Navigation.md
index 9ca7f43..2b4daa9 100644
--- a/docs/30_Page/20_Navigation.md
+++ b/docs/30_Page/20_Navigation.md
@@ -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}}`.
diff --git a/docs/40_Components/Tabbed_content.md b/docs/40_Components/Tabbed_content.md
new file mode 100644
index 0000000..7e0a3eb
--- /dev/null
+++ b/docs/40_Components/Tabbed_content.md
@@ -0,0 +1,41 @@
+## 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',
+ )
+));
+```
--
GitLab