AppSwitcher documentation improvement (SAP#2669)

y-kkamil · Apr 28, 2022 · cf26d81 · cf26d81
1 parent ceac3f2
commit cf26d81
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/docs/general-settings.md b/docs/general-settings.md
@@ -122,18 +122,43 @@ Take a look at our [i18n](i18n.md) section for an implementation suggestion.
 ### header.logo
 - **type**: icon
 - **description**: defines the top left navigation logo. It has a fixed height of 28px.
+- **example**: 
+```
+ header: {  object / function / Promise
+    logo: 'path/to/image.png'
+  },
+```
 
 ### header.altText
 - **type**: string
 - **description**: adds the HTML `alt` attribute to the logo image.
+- **example**: 
+```
+ header: {  object / function / Promise
+    logo: 'path/to/image.png', 
+    altText: 'alternative text'
+  },
+```
 
 ### header.title
 - **type**: string
 - **description**: defines the top left navigation title.
+- **example**: 
+```
+ header: {  object / function / Promise
+    title: 'Luigi Demo'
+  },
+```
 
 ### header.favicon
 - **type**: icon
 - **description**: defines the favicon. It requires a standard favicon file with the `.ico` extension, and 16x16px or 32x32px dimensions.
+- **example**: 
+```
+ header: {  object / function / Promise
+    favicon: 'path/to/favicon.ico'
+  },
+```
 
 ### responsiveNavigation
 - **description**: allows customizing the navigation display settings. For example, you can define a button which shows or completely hides the left navigation, or a button which collapses the navigation to only show the icons.

diff --git a/docs/navigation-advanced.md b/docs/navigation-advanced.md
@@ -389,7 +389,11 @@ productSwitcher: {
 
 ![App switcher](assets/app-switcher.jpg)
 
-The app switcher is a drop-down in top the navigation which allows you to switch between applications. To use it, add the **appSwitcher** property in your **navigation** object. You may also add any of the parameters listed [here](navigation-parameters-reference.md#app-switcher).
+The app switcher is a dropdown at the top of the navigation which allows you to switch between applications. To use it, you need to:
+1. Define a [header object](general-settings.md#headerlogo) in the `settings:` section of your Luigi configuration.
+2. Add the **appSwitcher** parameter to the **navigation** object.
+
+You may also add any of the parameters listed [here](navigation-parameters-reference.md#app-switcher).
 
 Example:
 

diff --git a/docs/navigation-parameters-reference.md b/docs/navigation-parameters-reference.md
@@ -851,7 +851,9 @@ The product switcher is a pop-up window available in the top navigation bar. It
 
 ## App switcher
 
-The app switcher is a drop-down list available in the top navigation bar. It allows you to switch between application elements displayed in the drop-down. To do so, add the **appSwitcher** parameter to the **navigation** object using the following optional parameters:
+The app switcher is a dropdown list available in the top navigation bar. It allows you to switch between application elements displayed in the dropdown. To use it, you need to:
+1. Define a [header object](general-settings.md#headerlogo) in the `settings:` section of your Luigi configuration.
+2. Add the **appSwitcher** parameter to the **navigation** object using the optional parameters listed below.
 
 ### items
 - **type**: array