Skip to content

Commit 13b428d

Browse files
committed
Update miniApps documentation
Add Apendix C explaining the manifest.json structure
1 parent e7067df commit 13b428d

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,14 @@ The jsonObject payload that the miniApp wants to write into a log is the third l
6262

6363
### Appendix C: Fields of the manifest.json file
6464

65-
- To be explained
65+
- “name” \- Name of the miniApp
66+
- “description” \- Description of the miniApp
67+
- “icon” \- Path to the icon of the miniApp
68+
- “init” \- The function that should be called when the miniApp starts
69+
- “id” \- The miniApp’s unique identifier
70+
- “cssFile” \- Path to the miniApp’s CSS file
71+
- “scripts” \- Array of JavaScript files used by the miniApp
72+
- “htmlFile” \- Path to the miniApp’s HTML file
73+
- “scenario” \- List of scenarios in miniApp (note: each scenario must have a corresponding div in the html file, said div should start with “div:scenarioName”, each scenario includes the following fields:
74+
- “menu” \- How the menu should look like, a JSON dictionary including each menu button and the function it should call
75+
- “display” \- The ids of the different html elements that are meant to be displayed when that scenario is active

0 commit comments

Comments
 (0)