From 6fd5810ec1738783f3475ddaaa3f53449b73f95c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Borna=20Goj=C5=A1i=C4=87?=
<69301624+bornagojsic@users.noreply.github.com>
Date: Mon, 4 Sep 2023 12:52:53 +0200
Subject: [PATCH 1/4] added docs for customFavicon and customCSS
---
docs/integrations/communication/web.md | 30 +++++++++++++++++++++++++-
1 file changed, 29 insertions(+), 1 deletion(-)
diff --git a/docs/integrations/communication/web.md b/docs/integrations/communication/web.md
index 228efd4..71d5edd 100644
--- a/docs/integrations/communication/web.md
+++ b/docs/integrations/communication/web.md
@@ -125,7 +125,7 @@ You can show the screens you create using `ArmoryAPI.show()`, which takes the us
public static Show show(String connectionId, List<HistoryItem> history, Screen... screens)
public static Show show(String connectionId, String firstScreen, List<HistoryItem> history, Screen... screens)
public static Show show(String connectionId, List<HistoryItem> history, Map<String, Object> configuration, Screen... screens)
- public static Show show(String connectionId, String firstScreen, List<HistoryItem> history, Map<String, Object> configuration, Screen... screens)
+ public static Show show(String connectionId, String firstScreen, List<HistoryItem> history, Map<String, Object> configuration, Screen... screens)
public static Show show(String connectionId, List<HistoryItem> history, List<Screen> screens)
public static Show show(String connectionId, String firstScreen, List<HistoryItem> history, List<Screen> screens)
public static Show show(String connectionId, List<HistoryItem> history, Map<String, Object> configuration, List<Screen> screens)
@@ -134,6 +134,34 @@ You can show the screens you create using `ArmoryAPI.show()`, which takes the us
+
+How to use Map<String, Object> configuration
+
+ -
+
Add a custom favicon:
+
+
+ ```java
+ Map configuration = new HashMap<>("customFaviconPath", yourCustomFaviconPath);
+ ArmoryAPI.show(connectionId, configuration, screens);
+ ```
+
+ yourCustomFaviconPath - a path to the favicon from /services/armory/public
+
+
+ -
+
Add custom CSS:
+
+
+ ```java
+ Map configuration = new HashMap<>("customFaviconPath", yourCustomFaviconPath);
+ ArmoryAPI.show(connectionId, configuration, screens);
+ ```
+
+ yourCustomCSS - a string that contains the CSS that is applied globally
+
+
+
Finally, here are some examples that show how the two different ways of building screens are used in rules. First one is covering the manual way, while the other is covering the configuration file way.
From 01f1b67050c3d198add7016b6e481a443c3adbeb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Borna=20Goj=C5=A1i=C4=87?=
<69301624+bornagojsic@users.noreply.github.com>
Date: Wed, 6 Sep 2023 13:59:19 +0000
Subject: [PATCH 2/4] changed from dropdown to subheader
---
docs/integrations/communication/web.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/integrations/communication/web.md b/docs/integrations/communication/web.md
index 71d5edd..53e3e3c 100644
--- a/docs/integrations/communication/web.md
+++ b/docs/integrations/communication/web.md
@@ -134,8 +134,7 @@ You can show the screens you create using `ArmoryAPI.show()`, which takes the us
-
-How to use Map<String, Object> configuration
+### How to use Map<String, Object> configuration
-
+
+### Examples
Finally, here are some examples that show how the two different ways of building screens are used in rules. First one is covering the manual way, while the other is covering the configuration file way.
From 265cf03ffcee73c325ecbe7c2cd823e39fbdb23f Mon Sep 17 00:00:00 2001
From: hlupek
Date: Fri, 8 Sep 2023 14:44:37 +0200
Subject: [PATCH 3/4] Updated docs for custom favicon and css for each flow
---
docs/integrations/communication/web.md | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/docs/integrations/communication/web.md b/docs/integrations/communication/web.md
index 53e3e3c..c536435 100644
--- a/docs/integrations/communication/web.md
+++ b/docs/integrations/communication/web.md
@@ -134,10 +134,12 @@ You can show the screens you create using `ArmoryAPI.show()`, which takes the us
+
### How to use Map<String, Object> configuration
-
+You can use the configuration map as an argument in the ArmoryAPI.show() to customize every flow individually like this:
-
Add a custom favicon:
+ If you store a path to a custom favicon - yourCustomFaviconPath in configuration like here:
```java
@@ -145,19 +147,20 @@ You can show the screens you create using `ArmoryAPI.show()`, which takes the us
ArmoryAPI.show(connectionId, configuration, screens);
```
- yourCustomFaviconPath - a path to the favicon from /services/armory/public
+ the screens in that flow will be shown with a custom favicon you've chosen.
-
Add custom CSS:
+ Same goes for custom CSS for your screens. When you store a string containing CSS - yourCustomCSS like so:
```java
- Map configuration = new HashMap<>("customFaviconPath", yourCustomFaviconPath);
+ Map configuration = new HashMap<>("customCSS", yourCustomCSS);
ArmoryAPI.show(connectionId, configuration, screens);
```
- yourCustomCSS - a string that contains the CSS that is applied globally
+ you can differentiate the look of that particular flow from the rest of the project.
@@ -365,7 +368,7 @@ This component is used for collecting user's input, especially in cases where yo
- `type` is used for setting the input type, different versions can be found [here](https://www.w3schools.com/tags/att_input_type.asp)
- `value` is used for setting the default value of the input and can be additionally edited from the user's side
- `required` is used for setting whether the input is required or not
- - `label` is used for setting the label text, which will be shown directly above the input and serves as an description of the specific input field
+ - `label` is used for setting the label text, which will be shown directly above the input and serves as a description of the specific input field
#### SubmitButton
@@ -481,7 +484,7 @@ This component is used in cases where you need users to select multiple values f
- text: "Teamwork"
value: "teamwork"
- text: "Creativity"
- value: "creativeity"
+ value: "creativity"
- text: "Detail oriented"
value: "flexible"
```
From 8032b1f0723647af440db5cf3932f42644ba366a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Borna=20Goj=C5=A1i=C4=87?=
<69301624+bornagojsic@users.noreply.github.com>
Date: Mon, 11 Sep 2023 10:33:57 +0200
Subject: [PATCH 4/4] minor context changes
---
docs/integrations/communication/web.md | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/docs/integrations/communication/web.md b/docs/integrations/communication/web.md
index c536435..9f2a96b 100644
--- a/docs/integrations/communication/web.md
+++ b/docs/integrations/communication/web.md
@@ -135,8 +135,10 @@ You can show the screens you create using `ArmoryAPI.show()`, which takes the us
-### How to use Map<String, Object> configuration
-You can use the configuration map as an argument in the ArmoryAPI.show() to customize every flow individually like this:
+### Flow configuration
+
+You can use the configuration map as an argument in the ArmoryAPI.show() to customize every flow individually like this:
+
+You can use any other implementation of the ArmoryAPI.show() method, as long as you pass the configuration map as an argument.
+
### Examples
Finally, here are some examples that show how the two different ways of building screens are used in rules. First one is covering the manual way, while the other is covering the configuration file way.