-
Notifications
You must be signed in to change notification settings - Fork 1
/
AppData.Schema.json
269 lines (269 loc) · 10.8 KB
/
AppData.Schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"Groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"UniqueId": {
"type": "string",
"description": "Unique identifier of the item, typically refers to the full page type, e.g., 'AppNameSpace.Views.BlankPage'"
},
"Title": {
"type": "string",
"description": "Displayed in both the NavigationViewItem and the GridView Item on the LandingPage"
},
"ApiNamespace": {
"type": "string",
"description": "Not used, leave as default"
},
"SecondaryTitle": {
"type": "string",
"description": "Not used, leave as default"
},
"Subtitle": {
"type": "string",
"description": "Not used, leave as default"
},
"SectionId": {
"type": "string",
"description": "Globally section id of this item"
},
"Description": {
"type": "string",
"description": "Not used, leave as default"
},
"ImagePath": {
"type": "string",
"description": "Used as an image for both GridView and NavigationView items, with the format: 'ms-appx:///Assets/Icon.png'."
},
"IconGlyph": {
"type": "string",
"description": "If specified, this will be used in the NavigationViewItem instead of ImagePath. Format can be a Unicode string like 'E709' or an icon glyph itself."
},
"Parameter": {
"type": "string",
"description": "Specify a parameter if there are multiple pages with the same UniqueId"
},
"IsSpecialSection": {
"type": "boolean",
"description": "Indicates that this section is not a regular section but is added to the navigation differently",
"default": true
},
"HideGroup": {
"type": "boolean",
"default": false,
"description": "If true, the item is hidden from the NavigationView"
},
"ShowItemsWithoutGroup": {
"type": "boolean",
"default": false,
"description": "If true, the items in NavigationView will be shown without a group or parent"
},
"IsExpanded": {
"type": "boolean",
"default": false,
"description": "If true, the item in NavigationView will be Expanded"
},
"IsNavigationViewItemHeader": {
"type": "boolean",
"default": false,
"description": "Indicates if this is a NavigationViewItemHeader"
},
"IsFooterNavigationViewItem": {
"type": "boolean",
"default": false,
"description": "Indicates if this should be added in NavigationView FooterMenuItems"
},
"UsexUid": {
"type": "boolean",
"default": false,
"description": "Indicates whether to use a Uid for localization"
},
"Order": {
"type": "boolean",
"default": false,
"description": "A boolean value that specifies whether to apply ordering to the result set. When set to true, the results will be sorted in ascending order by default. If set to false, no specific ordering is applied."
},
"OrderByDescending": {
"type": "boolean",
"default": false,
"description": "A boolean value that specifies whether to sort the results in descending order. If set to true, the results will be ordered from highest to lowest. This option only applies when Order is enabled."
},
"DataInfoBadge": {
"type": "object",
"properties": {
"BadgeValue": {
"type": "string",
"description": "Not used, leave as default"
},
"BadgeStyle": {
"type": "string",
"description": "Not used, leave as default"
},
"BadgeSymbolIcon": {
"type": "string",
"description": "Not used, leave as default"
},
"BadgeBitmapIcon": {
"type": "string",
"description": "Not used, leave as default"
},
"BadgeFontIconGlyph": {
"type": "string",
"description": "Not used, leave as default"
},
"BadgeFontIconFontName": {
"type": "string",
"description": "Not used, leave as default"
},
"BadgeWidth": {
"type": "integer",
"description": "Not used, leave as default"
},
"BadgeHeight": {
"type": "integer",
"description": "Not used, leave as default"
},
"HideBadge": {
"type": "boolean",
"description": "Not used, leave as default"
},
"HideNavigationViewItemBadge": {
"type": "boolean",
"description": "Not used, leave as default"
}
}
},
"Items": {
"type": "array",
"description": "Items that will appear in the NavigationView and GridView",
"items": {
"type": "object",
"properties": {
"UniqueId": {
"type": "string",
"description": "Unique identifier of the item, typically refers to the full page type, e.g., 'AppNameSpace.Views.BlankPage'"
},
"SectionId": {
"type": "string",
"description": "Globally section id of this item"
},
"Title": {
"type": "string",
"description": "Displayed in both the NavigationViewItem and the GridView Item on the LandingPage"
},
"SecondaryTitle": {
"type": "string",
"description": "Not used, leave as default"
},
"Parameter": {
"type": "string",
"description": "Specify a parameter if there are multiple pages with the same UniqueId"
},
"ApiNamespace": {
"type": "string",
"description": "Not used, leave as default"
},
"Subtitle": {
"type": "string",
"description": "Only shown in the GridView Item on the LandingPage"
},
"Description": {
"type": "string",
"description": "Not used, leave as default"
},
"ImagePath": {
"type": "string",
"description": "Used as an image for both GridView and NavigationView items, with the format: 'ms-appx:///Assets/Icon.png'."
},
"IconGlyph": {
"type": "string",
"description": "If specified, this will be used in the NavigationViewItem instead of ImagePath. Format can be a Unicode string like 'E709' or an icon glyph itself."
},
"BadgeString": {
"type": "string",
"description": "Not used, leave as default"
},
"Content": {
"type": "string",
"description": "Not used, leave as default"
},
"IsNew": {
"type": "boolean",
"default": true,
"description": "Indicates if this item is newly added and shows a dot on the overview card in the GridView"
},
"IsUpdated": {
"type": "boolean",
"default": true,
"description": "Indicates if this item is updated and shows a dot on the overview card in the GridView"
},
"IsPreview": {
"type": "boolean",
"default": false,
"description": "Indicates if this item is in a preview state"
},
"HideItem": {
"type": "boolean",
"default": false,
"description": "If true, the item is hidden from the GridView"
},
"HideNavigationViewItem": {
"type": "boolean",
"default": false,
"description": "If true, the item is hidden from the NavigationView"
},
"IncludedInBuild": {
"type": "boolean",
"default": true,
"description": "Indicates if this item is included in the build"
},
"IsNavigationViewItemHeader": {
"type": "boolean",
"default": false,
"description": "Indicates if this is a NavigationViewItemHeader"
},
"UsexUid": {
"type": "boolean",
"default": false,
"description": "Indicates whether to use a Uid for localization"
},
"Links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Title": {
"type": "string",
"description": "Not used, leave as default"
},
"Uri": {
"type": "string",
"description": "Not used, leave as default"
}
},
"required": [ "Title", "Uri" ]
},
"description": "Not used, leave as default"
},
"Extra": {
"type": "array",
"items": {
"type": "string",
"description": "Not used, leave as default"
},
"description": "Array of names of related items"
}
},
"required": [ "UniqueId", "Title" ]
}
}
},
"required": [ "UniqueId", "Title", "Items" ]
}
}
}
}