@saasquatch/mint-components 1.5.5 → 1.5.6-2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (162) hide show
  1. package/dist/cjs/sqm-big-stat_35.cjs.entry.js +135 -69
  2. package/dist/cjs/sqm-empty_5.cjs.entry.js +2 -2
  3. package/dist/cjs/sqm-hero.cjs.entry.js +15 -7
  4. package/dist/cjs/sqm-password-field.cjs.entry.js +5 -2
  5. package/dist/cjs/sqm-portal-email-verification.cjs.entry.js +4 -4
  6. package/dist/cjs/sqm-portal-forgot-password.cjs.entry.js +4 -4
  7. package/dist/cjs/sqm-portal-logout.cjs.entry.js +1 -1
  8. package/dist/cjs/sqm-portal-profile.cjs.entry.js +18 -8
  9. package/dist/cjs/sqm-portal-protected-route.cjs.entry.js +1 -1
  10. package/dist/cjs/sqm-portal-reset-password.cjs.entry.js +12 -10
  11. package/dist/cjs/sqm-portal-verify-email.cjs.entry.js +2 -2
  12. package/dist/cjs/sqm-referral-table_11.cjs.entry.js +21 -8
  13. package/dist/cjs/sqm-rewards-table_9.cjs.entry.js +8 -4
  14. package/dist/cjs/sqm-stencilbook.cjs.entry.js +7 -79
  15. package/dist/collection/components/sqm-asset-card/sqm-asset-card.js +2 -2
  16. package/dist/collection/components/sqm-big-stat/sqm-big-stat.js +13 -8
  17. package/dist/collection/components/sqm-brand/sqm-brand.js +1 -1
  18. package/dist/collection/components/sqm-card-feed/sqm-card-feed.js +1 -0
  19. package/dist/collection/components/sqm-checkbox-field/sqm-checkbox-field.js +11 -10
  20. package/dist/collection/components/sqm-divided-layout/sqm-divided-layout.js +4 -4
  21. package/dist/collection/components/sqm-dropdown-field/sqm-dropdown-field.js +5 -5
  22. package/dist/collection/components/sqm-edit-profile/sqm-edit-profile.js +9 -9
  23. package/dist/collection/components/sqm-empty/sqm-empty.js +1 -0
  24. package/dist/collection/components/sqm-form-message/sqm-form-message.js +3 -3
  25. package/dist/collection/components/sqm-hero/sqm-hero.js +23 -15
  26. package/dist/collection/components/sqm-hero-image/sqm-hero-image.js +7 -3
  27. package/dist/collection/components/sqm-hook-story-container/sqm-hook-story-container.js +3 -0
  28. package/dist/collection/components/sqm-leaderboard/Leaderboard.stories.js +2 -74
  29. package/dist/collection/components/sqm-leaderboard/sqm-leaderboard.js +10 -8
  30. package/dist/collection/components/sqm-leaderboard-rank/sqm-leaderboard-rank.js +4 -4
  31. package/dist/collection/components/sqm-name-fields/sqm-name-fields.js +4 -4
  32. package/dist/collection/components/sqm-navigation-menu/sqm-navigation-menu.js +3 -3
  33. package/dist/collection/components/sqm-navigation-sidebar/sqm-navigation-sidebar.js +1 -1
  34. package/dist/collection/components/sqm-navigation-sidebar-item/sqm-navigation-sidebar-item.js +1 -1
  35. package/dist/collection/components/sqm-password-field/sqm-password-field.js +9 -6
  36. package/dist/collection/components/sqm-popup-container/sqm-popup-container.js +11 -11
  37. package/dist/collection/components/sqm-portal-change-password/sqm-portal-change-password.js +34 -22
  38. package/dist/collection/components/sqm-portal-container/sqm-portal-container.js +5 -4
  39. package/dist/collection/components/sqm-portal-email-verification/sqm-portal-email-verification.js +8 -8
  40. package/dist/collection/components/sqm-portal-forgot-password/sqm-portal-forgot-password.js +8 -8
  41. package/dist/collection/components/sqm-portal-login/sqm-portal-login.js +42 -26
  42. package/dist/collection/components/sqm-portal-logout/sqm-portal-logout.js +2 -2
  43. package/dist/collection/components/sqm-portal-profile/sqm-portal-profile.js +31 -21
  44. package/dist/collection/components/sqm-portal-protected-route/sqm-portal-protected-route.js +2 -2
  45. package/dist/collection/components/sqm-portal-register/sqm-portal-register.js +36 -28
  46. package/dist/collection/components/sqm-portal-reset-password/sqm-portal-reset-password.js +23 -21
  47. package/dist/collection/components/sqm-portal-verify-email/sqm-portal-verify-email.js +4 -4
  48. package/dist/collection/components/sqm-program-explainer/sqm-program-explainer.js +1 -0
  49. package/dist/collection/components/sqm-program-explainer-step/sqm-program-explainer-step.js +2 -0
  50. package/dist/collection/components/sqm-referral-card/sqm-referral-card.js +2 -0
  51. package/dist/collection/components/sqm-referral-iframe/sqm-referral-iframe.js +11 -9
  52. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-column.js +1 -0
  53. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-date-column.js +1 -0
  54. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-rewards-column.js +1 -0
  55. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-status-column.js +1 -0
  56. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-user-column.js +11 -6
  57. package/dist/collection/components/sqm-referral-table/sqm-referral-table.js +23 -14
  58. package/dist/collection/components/sqm-reward-exchange-list/sqm-reward-exchange-list.js +21 -13
  59. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-date-column.js +1 -0
  60. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-note-column.js +1 -0
  61. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-reward-column.js +3 -2
  62. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-source-column.js +13 -8
  63. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-status-column.js +1 -0
  64. package/dist/collection/components/sqm-route/sqm-route.js +1 -1
  65. package/dist/collection/components/sqm-share-button/sqm-share-button.js +25 -15
  66. package/dist/collection/components/sqm-share-code/sqm-share-code.js +7 -7
  67. package/dist/collection/components/sqm-share-link/sqm-share-link.js +7 -7
  68. package/dist/collection/components/sqm-stat-container/sqm-stat-container.js +3 -2
  69. package/dist/collection/components/sqm-tab/sqm-tab.js +1 -0
  70. package/dist/collection/components/sqm-task-card/sqm-task-card.js +95 -8
  71. package/dist/collection/components/sqm-text-span/sqm-text-span.js +1 -1
  72. package/dist/collection/components/sqm-timeline/sqm-timeline-entry.js +2 -0
  73. package/dist/collection/components/sqm-timeline/sqm-timeline.js +4 -2
  74. package/dist/collection/components/sqm-titled-section/sqm-titled-section.js +4 -4
  75. package/dist/collection/components/sqm-user-name/sqm-user-name.js +6 -5
  76. package/dist/esm/sqm-big-stat_35.entry.js +135 -69
  77. package/dist/esm/sqm-empty_5.entry.js +2 -2
  78. package/dist/esm/sqm-hero.entry.js +15 -7
  79. package/dist/esm/sqm-password-field.entry.js +5 -2
  80. package/dist/esm/sqm-portal-email-verification.entry.js +4 -4
  81. package/dist/esm/sqm-portal-forgot-password.entry.js +4 -4
  82. package/dist/esm/sqm-portal-logout.entry.js +1 -1
  83. package/dist/esm/sqm-portal-profile.entry.js +18 -8
  84. package/dist/esm/sqm-portal-protected-route.entry.js +1 -1
  85. package/dist/esm/sqm-portal-reset-password.entry.js +12 -10
  86. package/dist/esm/sqm-portal-verify-email.entry.js +2 -2
  87. package/dist/esm/sqm-referral-table_11.entry.js +21 -8
  88. package/dist/esm/sqm-rewards-table_9.entry.js +8 -4
  89. package/dist/esm/sqm-stencilbook.entry.js +7 -79
  90. package/dist/esm-es5/sqm-big-stat_35.entry.js +1 -1
  91. package/dist/esm-es5/sqm-stencilbook.entry.js +1 -1
  92. package/dist/mint-components/mint-components.esm.js +1 -1
  93. package/dist/mint-components/{p-951e7817.system.entry.js → p-25ac7c14.system.entry.js} +1 -1
  94. package/dist/mint-components/p-5bef951d.system.entry.js +1 -0
  95. package/dist/mint-components/p-94096609.system.js +1 -1
  96. package/dist/mint-components/{p-87ffb558.entry.js → p-c7b0f076.entry.js} +2 -2
  97. package/dist/types/components/sqm-asset-card/sqm-asset-card.d.ts +2 -2
  98. package/dist/types/components/sqm-big-stat/sqm-big-stat.d.ts +12 -5
  99. package/dist/types/components/sqm-brand/sqm-brand.d.ts +1 -1
  100. package/dist/types/components/sqm-card-feed/sqm-card-feed.d.ts +1 -0
  101. package/dist/types/components/sqm-checkbox-field/sqm-checkbox-field.d.ts +6 -5
  102. package/dist/types/components/sqm-divided-layout/sqm-divided-layout.d.ts +2 -2
  103. package/dist/types/components/sqm-dropdown-field/sqm-dropdown-field.d.ts +3 -3
  104. package/dist/types/components/sqm-edit-profile/sqm-edit-profile.d.ts +10 -7
  105. package/dist/types/components/sqm-empty/sqm-empty.d.ts +1 -0
  106. package/dist/types/components/sqm-form-message/sqm-form-message.d.ts +8 -2
  107. package/dist/types/components/sqm-hero/sqm-hero.d.ts +20 -8
  108. package/dist/types/components/sqm-hero-image/sqm-hero-image.d.ts +5 -1
  109. package/dist/types/components/sqm-hook-story-container/sqm-hook-story-container.d.ts +3 -0
  110. package/dist/types/components/sqm-leaderboard/sqm-leaderboard.d.ts +7 -7
  111. package/dist/types/components/sqm-leaderboard-rank/sqm-leaderboard-rank.d.ts +4 -4
  112. package/dist/types/components/sqm-name-fields/sqm-name-fields.d.ts +2 -2
  113. package/dist/types/components/sqm-navigation-menu/sqm-navigation-menu.d.ts +4 -2
  114. package/dist/types/components/sqm-navigation-sidebar/sqm-navigation-sidebar.d.ts +1 -1
  115. package/dist/types/components/sqm-navigation-sidebar-item/sqm-navigation-sidebar-item.d.ts +1 -1
  116. package/dist/types/components/sqm-password-field/sqm-password-field.d.ts +5 -2
  117. package/dist/types/components/sqm-popup-container/sqm-popup-container.d.ts +21 -6
  118. package/dist/types/components/sqm-portal-change-password/sqm-portal-change-password.d.ts +20 -8
  119. package/dist/types/components/sqm-portal-container/sqm-portal-container.d.ts +6 -3
  120. package/dist/types/components/sqm-portal-email-verification/sqm-portal-email-verification.d.ts +4 -4
  121. package/dist/types/components/sqm-portal-forgot-password/sqm-portal-forgot-password.d.ts +4 -4
  122. package/dist/types/components/sqm-portal-login/sqm-portal-login.d.ts +25 -9
  123. package/dist/types/components/sqm-portal-logout/sqm-portal-logout.d.ts +1 -1
  124. package/dist/types/components/sqm-portal-profile/sqm-portal-profile.d.ts +18 -8
  125. package/dist/types/components/sqm-portal-protected-route/sqm-portal-protected-route.d.ts +1 -1
  126. package/dist/types/components/sqm-portal-register/sqm-portal-register.d.ts +20 -12
  127. package/dist/types/components/sqm-portal-reset-password/sqm-portal-reset-password.d.ts +12 -10
  128. package/dist/types/components/sqm-portal-verify-email/sqm-portal-verify-email.d.ts +2 -2
  129. package/dist/types/components/sqm-program-explainer/sqm-program-explainer.d.ts +1 -0
  130. package/dist/types/components/sqm-program-explainer-step/sqm-program-explainer-step.d.ts +2 -0
  131. package/dist/types/components/sqm-referral-card/sqm-referral-card.d.ts +2 -0
  132. package/dist/types/components/sqm-referral-iframe/sqm-referral-iframe.d.ts +7 -4
  133. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-column.d.ts +1 -0
  134. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-date-column.d.ts +1 -0
  135. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-rewards-column.d.ts +1 -0
  136. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-status-column.d.ts +1 -0
  137. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-user-column.d.ts +7 -2
  138. package/dist/types/components/sqm-referral-table/sqm-referral-table.d.ts +15 -6
  139. package/dist/types/components/sqm-reward-exchange-list/sqm-reward-exchange-list.d.ts +17 -9
  140. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-date-column.d.ts +1 -0
  141. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-note-column.d.ts +1 -0
  142. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-reward-column.d.ts +2 -1
  143. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-source-column.d.ts +8 -3
  144. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-status-column.d.ts +1 -0
  145. package/dist/types/components/sqm-route/sqm-route.d.ts +1 -1
  146. package/dist/types/components/sqm-share-button/sqm-share-button.d.ts +24 -9
  147. package/dist/types/components/sqm-share-code/sqm-share-code.d.ts +3 -2
  148. package/dist/types/components/sqm-share-link/sqm-share-link.d.ts +3 -2
  149. package/dist/types/components/sqm-stat-container/sqm-stat-container.d.ts +2 -1
  150. package/dist/types/components/sqm-tab/sqm-tab.d.ts +1 -0
  151. package/dist/types/components/sqm-task-card/sqm-task-card.d.ts +34 -8
  152. package/dist/types/components/sqm-text-span/sqm-text-span.d.ts +1 -1
  153. package/dist/types/components/sqm-timeline/sqm-timeline-entry.d.ts +2 -0
  154. package/dist/types/components/sqm-timeline/sqm-timeline.d.ts +4 -2
  155. package/dist/types/components/sqm-titled-section/sqm-titled-section.d.ts +2 -2
  156. package/dist/types/components/sqm-user-name/sqm-user-name.d.ts +3 -2
  157. package/dist/types/components.d.ts +478 -318
  158. package/docs/docs.docx +0 -0
  159. package/docs/raisins.json +1 -0
  160. package/grapesjs/grapesjs.js +1 -1
  161. package/package.json +8 -3
  162. package/dist/mint-components/p-64cc1a70.system.entry.js +0 -1
@@ -45,17 +45,18 @@ export namespace Components {
45
45
  */
46
46
  "demoData"?: DemoData<AssetCardViewProps>;
47
47
  /**
48
- * @uiName Banner image
48
+ * @uiName Banner Image
49
49
  */
50
50
  "imgUrl": string;
51
51
  /**
52
- * @uiName Banner title
52
+ * @uiName Banner Title
53
53
  */
54
54
  "titleText": string;
55
55
  }
56
56
  interface SqmBigStat {
57
57
  /**
58
- * @uiName Alignment - controls the alignment of the flexbox
58
+ * Controls the alignment of the flexbox
59
+ * @uiName Alignment
59
60
  * @uiType string
60
61
  * @uiEnum ["left", "right", "center"]
61
62
  * @uiEnumNames ["Left", "Right", "Center"]
@@ -67,7 +68,8 @@ export namespace Components {
67
68
  */
68
69
  "demoData"?: DemoData<BigStatViewProps>;
69
70
  /**
70
- * @uiName Flex Reverse - controls the order of the stat value & description column
71
+ * Controls the order of the stat value & description column
72
+ * @uiName Flex Reverse
71
73
  */
72
74
  "flexReverse"?: boolean;
73
75
  /**
@@ -79,7 +81,7 @@ export namespace Components {
79
81
  * Select what type of stat to display. Manual paths are also supported.
80
82
  * @uiWidget StatTypeSelectWidget
81
83
  * @uiName Stat Type
82
- * @uiOptions {"version": 1.1}
84
+ * @uiWidgetOptions {"version": 1.1}
83
85
  */
84
86
  "statType": string;
85
87
  }
@@ -109,19 +111,20 @@ export namespace Components {
109
111
  }
110
112
  interface SqmCheckboxField {
111
113
  /**
112
- * @uiName Checkbox label
114
+ * @uiName Checkbox Label
113
115
  */
114
116
  "checkboxLabel": string;
115
117
  /**
116
- * @uiName Checkbox label link Used with link text if the checkbox label contains {labelLink}
118
+ * Used with link text if the checkbox label contains {labelLink}
119
+ * @uiName Checkbox Label Link
117
120
  */
118
121
  "checkboxLabelLink": string;
119
122
  /**
120
- * @uiName Checkbox label link text
123
+ * @uiName Checkbox Label Link Text
121
124
  */
122
125
  "checkboxLabelLinkText": string;
123
126
  /**
124
- * @uiName Checkbox name attribute
127
+ * @uiName Checkbox Name Attribute
125
128
  */
126
129
  "checkboxName": string;
127
130
  /**
@@ -134,7 +137,7 @@ export namespace Components {
134
137
  */
135
138
  "demoData"?: DemoData<CheckboxFieldViewProps>;
136
139
  /**
137
- * @uiName Unchecked error message
140
+ * @uiName Unchecked Error Message
138
141
  */
139
142
  "errorMessage": string;
140
143
  }
@@ -147,8 +150,8 @@ export namespace Components {
147
150
  */
148
151
  "direction": "row" | "column";
149
152
  /**
150
- * Uses CSS border style syntax
151
- * @uiName Border style
153
+ * Uses Shorthand CSS border syntax
154
+ * @uiName Border Style
152
155
  */
153
156
  "dividerStyle": string;
154
157
  }
@@ -159,11 +162,11 @@ export namespace Components {
159
162
  */
160
163
  "demoData"?: DemoData<DropdownFieldViewProps>;
161
164
  /**
162
- * @uiName Dropdown label
165
+ * @uiName Dropdown Label
163
166
  */
164
167
  "dropdownLabel": string;
165
168
  /**
166
- * @uiName Dropdown name attribute
169
+ * @uiName Dropdown Name Attribute
167
170
  */
168
171
  "dropdownName": string;
169
172
  /**
@@ -171,17 +174,17 @@ export namespace Components {
171
174
  */
172
175
  "dropdownOptional"?: boolean;
173
176
  /**
174
- * @uiName Unselected error message
177
+ * @uiName Unselected Error Message
175
178
  */
176
179
  "errorMessage": string;
177
180
  }
178
181
  interface SqmEditProfile {
179
182
  /**
180
- * @uiName Cancel button text
183
+ * @uiName Cancel Button Text
181
184
  */
182
185
  "canceltext": string;
183
186
  /**
184
- * @uiName Region field label
187
+ * @uiName Region Field Label
185
188
  */
186
189
  "currentregiontext": string;
187
190
  /**
@@ -194,23 +197,25 @@ export namespace Components {
194
197
  */
195
198
  "editprofileheader": string;
196
199
  /**
197
- * @uiName Enable editing button text
200
+ * Enable editing button text
201
+ * @uiName Edit Profile Text
198
202
  */
199
203
  "editprofiletext": string;
200
204
  /**
201
- * @uiName First name field label
205
+ * @uiName First Name Label
202
206
  */
203
207
  "firstnametext": string;
204
208
  /**
205
- * @uiName Last name field label
209
+ * @uiName Last Name Label
206
210
  */
207
211
  "lastnametext": string;
208
212
  /**
209
- * @uiName Show or hide current region
213
+ * Show or hide current region
214
+ * @uiName Show Region
210
215
  */
211
216
  "showregion": boolean;
212
217
  /**
213
- * @uiName Update info button text
218
+ * @uiName Info Button Text
214
219
  */
215
220
  "updatetext": string;
216
221
  }
@@ -231,11 +236,12 @@ export namespace Components {
231
236
  }
232
237
  interface SqmFormMessage {
233
238
  /**
234
- * @uiName Icon to use in alert
239
+ * Icon to use in alert
240
+ * @uiName Icon
235
241
  */
236
242
  "icon"?: string;
237
243
  /**
238
- * @uiName Type of alert
244
+ * @uiName Alert Type
239
245
  */
240
246
  "type": string;
241
247
  }
@@ -247,24 +253,27 @@ export namespace Components {
247
253
  }
248
254
  interface SqmHero {
249
255
  /**
250
- * Can either be an image url, colour or Shoelace variable.
256
+ * Can be an image url, colour or Shoelace variable.
251
257
  * @uiName Background
252
258
  */
253
259
  "background"?: string;
254
260
  /**
255
- * @uiName Number of columns in the layout
261
+ * Number of columns in the layout
262
+ * @uiName Columns
256
263
  */
257
264
  "columns": 1 | 2;
258
265
  /**
259
- * @uiName Padding size
266
+ * @uiName Padding Size
260
267
  */
261
268
  "paddingSize": "none" | "small" | "medium" | "large";
262
269
  /**
263
- * @uiName Secondary background image or color (for use in right column)
270
+ * Secondary background image or color (for use in the right column)
271
+ * @uiName Secondary Background
264
272
  */
265
273
  "secondaryBackground"?: string;
266
274
  /**
267
- * @uiName Wrap direction
275
+ * Flexbox wrap direction, accepts wrap or wrap-reverse
276
+ * @uiName Wrap Direction
268
277
  */
269
278
  "wrapDirection": "wrap" | "wrap-reverse";
270
279
  }
@@ -279,7 +288,8 @@ export namespace Components {
279
288
  */
280
289
  "buttonLink"?: string;
281
290
  /**
282
- * @uiName CTA Button Link Open in New Tab
291
+ * CTA Button Opens Link in New Tab
292
+ * @uiName Button New Tab
283
293
  */
284
294
  "buttonNewTab"?: boolean;
285
295
  /**
@@ -414,8 +424,8 @@ export namespace Components {
414
424
  }
415
425
  interface SqmLeaderboard {
416
426
  /**
417
- * Text displayed for users without names in the leaderboard
418
- * @uiName Anonymous User Name
427
+ * Title displayed for users without names
428
+ * @uiName Unknown User Text
419
429
  */
420
430
  "anonymousUser": string;
421
431
  /**
@@ -429,10 +439,9 @@ export namespace Components {
429
439
  */
430
440
  "hideViewer": boolean;
431
441
  /**
432
- * Only count leaderboard activity within a given interval
433
442
  * @uiName Leaderboard Time Interval
434
443
  * @uiWidget DateRange
435
- * @uiOptions {"allowPastDates":true, "months": 1}
444
+ * @uiWidgetOptions {"allowPastDates":true, "months": 1}
436
445
  */
437
446
  "interval": string;
438
447
  /**
@@ -466,7 +475,7 @@ export namespace Components {
466
475
  */
467
476
  "rankheading"?: string;
468
477
  /**
469
- * @uiName Show Rank Column
478
+ * @uiName Show Leaderboard Rank
470
479
  */
471
480
  "showRank": boolean;
472
481
  /**
@@ -485,13 +494,13 @@ export namespace Components {
485
494
  */
486
495
  "demoData"?: DemoData<LeaderboardRankViewProps>;
487
496
  /**
488
- * @uiName Leaderboard time interval
497
+ * @uiName Leaderboard Time Interval
489
498
  * @uiWidget DateRange
490
- * @uiOptions {"allowPastDates":true, "months": 1}
499
+ * @uiWidgetOptions {"allowPastDates":true, "months": 1}
491
500
  */
492
501
  "interval": string;
493
502
  /**
494
- * @uiName Leaderboard type
503
+ * @uiName Leaderboard Type
495
504
  * @uiType string
496
505
  * @uiEnum ["topStartedReferrers", "topConvertedReferrers", "topPointEarners"]
497
506
  * @uiEnumNames ["Top Started Referrers", "Top Converted Referrers", "Top Point Earners"]
@@ -509,7 +518,7 @@ export namespace Components {
509
518
  */
510
519
  "rankText": string;
511
520
  /**
512
- * @uiName Default rank
521
+ * @uiName Default Rank
513
522
  * @uiType string
514
523
  * @uiEnum ["rowNumber", "rank", "denseRank"]
515
524
  * @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
@@ -527,11 +536,11 @@ export namespace Components {
527
536
  */
528
537
  "demoData"?: DemoData<NameFieldsViewProps>;
529
538
  /**
530
- * @uiName First name field label
539
+ * @uiName First Name label
531
540
  */
532
541
  "firstNameLabel": string;
533
542
  /**
534
- * @uiName Last name field label
543
+ * @uiName Last Name label
535
544
  */
536
545
  "lastNameLabel": string;
537
546
  }
@@ -542,11 +551,12 @@ export namespace Components {
542
551
  */
543
552
  "demoData"?: DemoData<NavigationMenuViewProps>;
544
553
  /**
545
- * @uiName Include dropdown menu
554
+ * @uiName Include Dropdown Menu
546
555
  */
547
556
  "includeDropdown": boolean;
548
557
  /**
549
- * @uiName Label on the header menu
558
+ * Label on the header menu
559
+ * @uiName Menu Label
550
560
  */
551
561
  "menuLabel": string;
552
562
  }
@@ -568,7 +578,7 @@ export namespace Components {
568
578
  */
569
579
  "label": string;
570
580
  /**
571
- * @uiName Navigation path
581
+ * @uiName Navigation Path
572
582
  */
573
583
  "path": string;
574
584
  }
@@ -579,53 +589,63 @@ export namespace Components {
579
589
  */
580
590
  "demoData"?: PasswordFieldViewDemoProps;
581
591
  /**
582
- * @uiName Enable live password validation
592
+ * Enable live password validation
593
+ * @uiName Enable Validation
583
594
  */
584
595
  "enableValidation": boolean;
585
596
  /**
586
- * @uiName Label for password field
597
+ * Label for password field
598
+ * @uiName Password Label
587
599
  */
588
600
  "fieldLabel": string;
589
601
  }
590
602
  interface SqmPopupContainer {
591
603
  /**
592
- * @uiName Display a close button on the popup
604
+ * Display a close button on the popup
605
+ * @uiName Show Close Button
593
606
  */
594
607
  "closeButton": boolean;
595
608
  /**
596
- * @uiName Text to be used as the close button
609
+ * Text inside the close button
610
+ * @uiName Close Button Text
597
611
  */
598
612
  "closeButtonText": string;
599
613
  /**
600
- * @uiName Specify padding on the popup contents when in embedded mode
614
+ * Specify padding on the popup contents when in embedded mode
615
+ * @uiName Embed Padding
601
616
  * @uiType string
602
617
  * @uiEnum ["none", "small", "medium", "large"]
603
618
  * @uiEnumNames ["None", "Small", "Medium", "Large"]
604
619
  */
605
620
  "embedPadding"?: "none" | "small" | "medium" | "large";
606
621
  /**
607
- * @uiName Specify padding on the popup contents when in popup mode
622
+ * Specify padding on the popup contents when in popup mode
623
+ * @uiName Popup Padding
608
624
  * @uiType string
609
625
  * @uiEnum ["none", "small", "medium", "large"]
610
626
  * @uiEnumNames ["None", "Small", "Medium", "Large"]
611
627
  */
612
628
  "popupPadding"?: "none" | "small" | "medium" | "large";
613
629
  /**
614
- * @uiName Show SaaSquatch Powered By messaging
630
+ * Show Powered By SaaSquatch link
631
+ * @uiName Show Powered By
615
632
  */
616
633
  "poweredBy": boolean;
617
634
  }
618
635
  interface SqmPortalChangePassword {
619
636
  /**
620
- * @uiName Modal cancel password change button text
637
+ * Modal cancel button text
638
+ * @uiName Cancel Button Text
621
639
  */
622
640
  "cancelText": string;
623
641
  /**
624
- * @uiName Modal change password button text
642
+ * Modal change password button text
643
+ * @uiName Change Password Button Text
625
644
  */
626
645
  "changePasswordButtonText": string;
627
646
  /**
628
- * @uiName Password confirmation input field label
647
+ * Password confirmation input field label
648
+ * @uiName Confirm Password Label
629
649
  */
630
650
  "confirmPasswordFieldLabel": string;
631
651
  /**
@@ -634,29 +654,32 @@ export namespace Components {
634
654
  */
635
655
  "demoData"?: DemoData<PortalChangePasswordViewProps>;
636
656
  /**
637
- * @uiName Change password modal header
657
+ * @uiName Change Password Modal Header
638
658
  */
639
659
  "modalChangePasswordHeader": string;
640
660
  /**
641
- * @uiName Password input field label
661
+ * Password input field label
662
+ * @uiName Password Label
642
663
  */
643
664
  "passwordFieldLabel": string;
644
665
  /**
645
- * @uiName Portal change password button text
666
+ * @uiName Change Password Button Text
646
667
  */
647
668
  "portalChangePasswordButtonText": string;
648
669
  /**
649
- * @uiName Portal change password section header
670
+ * Portal change password section header
671
+ * @uiName Change Password Header
650
672
  */
651
673
  "portalChangePasswordHeader": string;
652
674
  /**
653
- * @uiName Successful password change message
675
+ * Successful password change message
676
+ * @uiName Successful Message
654
677
  */
655
678
  "successMessage": string;
656
679
  }
657
680
  interface SqmPortalContainer {
658
681
  /**
659
- * @uiName Center content
682
+ * @uiName Center Content
660
683
  */
661
684
  "center"?: boolean;
662
685
  /**
@@ -681,7 +704,8 @@ export namespace Components {
681
704
  */
682
705
  "gap": Spacing;
683
706
  /**
684
- * @uiName Justify content
707
+ * Defines how the container distributes space between & around content items along the main-axis of a flex container
708
+ * @uiName Justify Content
685
709
  * @uiType string
686
710
  * @uiEnum ["start", "center", "end", "space-between", "space-around", "space-evenly"]
687
711
  * @uiEnumNames ["Start", "Center", "End", "Space Between", "Space Around", "Space Evenly"]
@@ -697,7 +721,7 @@ export namespace Components {
697
721
  */
698
722
  "maxWidth"?: string;
699
723
  /**
700
- * @uiName Minimum width
724
+ * @uiName Minimum Width
701
725
  */
702
726
  "minWidth"?: string;
703
727
  /**
@@ -715,20 +739,20 @@ export namespace Components {
715
739
  */
716
740
  "demoData"?: DemoData<PortalEmailVerificationViewProps>;
717
741
  /**
718
- * @uiName Email verification header text
742
+ * @uiName Email Verification Header Text
719
743
  */
720
744
  "emailVerificationHeader": string;
721
745
  /**
722
746
  * The page that users are redirected to from the verification email.
723
- * @uiName Email redirection base path
747
+ * @uiName Email Redirection Base Path
724
748
  */
725
749
  "redirectPath": string;
726
750
  /**
727
- * @uiName Re-send email button text
751
+ * @uiName Re-send Email Button Text
728
752
  */
729
753
  "resendEmailButtonText": string;
730
754
  /**
731
- * @uiName Email verification body text
755
+ * @uiName Email Verification Body Text
732
756
  */
733
757
  "verifyMessage": string;
734
758
  }
@@ -789,20 +813,20 @@ export namespace Components {
789
813
  */
790
814
  "demoData"?: DemoData<PortalForgotPasswordViewProps>;
791
815
  /**
792
- * @uiName Email label
816
+ * @uiName Email Label
793
817
  */
794
818
  "emailLabel": string;
795
819
  /**
796
- * @uiName Routing path to login page
820
+ * @uiName Login Page Routing Path
797
821
  */
798
822
  "loginPath": string;
799
823
  /**
800
824
  * The page that users are redirected to from the password reset email.
801
- * @uiName Email redirection base path
825
+ * @uiName Email Redirection Base Path
802
826
  */
803
827
  "redirectPath": string;
804
828
  /**
805
- * @uiName Password reset button text
829
+ * @uiName Password Reset Button Text
806
830
  */
807
831
  "submitLabel": string;
808
832
  }
@@ -820,51 +844,60 @@ export namespace Components {
820
844
  */
821
845
  "demoData"?: DemoData<PortalLoginViewProps>;
822
846
  /**
823
- * @uiName Label for email field
847
+ * Label for email field
848
+ * @uiName Email Label
824
849
  */
825
850
  "emailLabel": string;
826
851
  /**
827
- * @uiName Label for forgotten password button
852
+ * Label for forgotten password button
853
+ * @uiName Forgot Password Text
828
854
  */
829
855
  "forgotPasswordLabel": string;
830
856
  /**
831
- * @uiName Forgot password button redirect path
857
+ * Forgot password redirect path
858
+ * @uiName Forgot Password Path
832
859
  */
833
860
  "forgotPasswordPath": string;
834
861
  /**
835
- * @uiName Page navigated to after sign-in
862
+ * Page navigated to after sign-in
863
+ * @uiName Next Page Path
836
864
  */
837
865
  "nextPage": string;
838
866
  /**
839
- * @uiName Heading label
867
+ * @uiName Heading Label
840
868
  */
841
869
  "pageLabel": string;
842
870
  /**
843
- * @uiName Label for password field
871
+ * Label for password field
872
+ * @uiName Password Label
844
873
  */
845
874
  "passwordLabel": string;
846
875
  /**
847
- * @uiName Label for register navigation button
876
+ * Label for register button
877
+ * @uiName Register Button Text
848
878
  */
849
879
  "registerLabel": string;
850
880
  /**
851
- * @uiName Register button redirection path
881
+ * Register redirect path
882
+ * @uiName Register Path
852
883
  */
853
884
  "registerPath": string;
854
885
  /**
855
- * @uiName Label for submit button
886
+ * Label for submit button
887
+ * @uiName Submit Button Text
856
888
  */
857
889
  "submitLabel": string;
858
890
  }
859
891
  interface SqmPortalLogout {
860
892
  /**
861
- * @uiName Next Page path
893
+ * @uiName Next Page Path
862
894
  */
863
895
  "nextPage": string;
864
896
  }
865
897
  interface SqmPortalProfile {
866
898
  /**
867
- * @uiName Country input field label
899
+ * Country input field label
900
+ * @uiName Country Label
868
901
  */
869
902
  "countrytext": string;
870
903
  /**
@@ -873,31 +906,35 @@ export namespace Components {
873
906
  */
874
907
  "demoData"?: DemoData<PortalProfileViewProps>;
875
908
  /**
876
- * @uiName Edit profile header
909
+ * @uiName Edit Profile Header
877
910
  */
878
911
  "editProfileHeader": string;
879
912
  /**
880
- * @uiName Edit profile sub header
913
+ * @uiName Edit Profile Sub Header
881
914
  */
882
915
  "editProfileSubHeader": string;
883
916
  /**
884
- * @uiName Email input field label
917
+ * Email input field label
918
+ * @uiName Email Label
885
919
  */
886
920
  "emailtext": string;
887
921
  /**
888
- * @uiName First name input field label
922
+ * First name input field label
923
+ * @uiName First Name Label
889
924
  */
890
925
  "firstnametext": string;
891
926
  /**
892
- * @uiName Last name input field label
927
+ * Last name input field label
928
+ * @uiName Last Name Label
893
929
  */
894
930
  "lastnametext": string;
895
931
  /**
896
- * @uiName Show or hide country field
932
+ * Show or hide the country field
933
+ * @uiName Show Country Field
897
934
  */
898
935
  "showCountry": boolean;
899
936
  /**
900
- * @uiName Text for the submit changes button
937
+ * @uiName Submit Changes Button Text
901
938
  */
902
939
  "submitChangeButtonText": string;
903
940
  }
@@ -907,7 +944,7 @@ export namespace Components {
907
944
  */
908
945
  "redirectTo": string;
909
946
  /**
910
- * @uiName Redirect unverified users path
947
+ * @uiName Redirect Unverified Users Path
911
948
  */
912
949
  "redirectToUnverified": string;
913
950
  /**
@@ -917,11 +954,12 @@ export namespace Components {
917
954
  }
918
955
  interface SqmPortalRegister {
919
956
  /**
920
- * @uiName Show confirm password field
957
+ * Show or hide the confirm password input
958
+ * @uiName Show Confirm Password Field
921
959
  */
922
960
  "confirmPassword": boolean;
923
961
  /**
924
- * @uiName Label for confirm password field
962
+ * @uiName Confirm Password Label
925
963
  */
926
964
  "confirmPasswordLabel": string;
927
965
  /**
@@ -930,59 +968,63 @@ export namespace Components {
930
968
  */
931
969
  "demoData"?: DemoData<PortalRegisterViewProps>;
932
970
  /**
933
- * @uiName Label for email field
971
+ * @uiName Email Label
934
972
  */
935
973
  "emailLabel": string;
936
974
  /**
937
- * @uiName Use password field with live validation
975
+ * @uiName Enable Password Validation
938
976
  */
939
977
  "enablePasswordValidation": boolean;
940
978
  /**
941
- * @uiName Hide default input fields to use custom fields
979
+ * Hide default input fields to use custom fields
980
+ * @uiName Hide Default Inputs
942
981
  */
943
982
  "hideInputs": boolean;
944
983
  /**
945
- * @uiName Label for login navigation button
984
+ * @uiName Login Button Text
946
985
  */
947
986
  "loginLabel": string;
948
987
  /**
949
- * @uiName Sign in button redirection path
988
+ * Login button redirection path
989
+ * @uiName Login Path
950
990
  */
951
991
  "loginPath": string;
952
992
  /**
953
- * @uiName Page navigated to after registration
993
+ * Page navigated to after registration
994
+ * @uiName Next Page
954
995
  */
955
996
  "nextPage": string;
956
997
  /**
957
- * @uiName Heading label
998
+ * @uiName Heading Label
958
999
  */
959
1000
  "pageLabel": string;
960
1001
  /**
961
- * @uiName Label for password field
1002
+ * @uiName Password Label
962
1003
  */
963
1004
  "passwordLabel": string;
964
1005
  /**
965
1006
  * The page that users are redirected to from the verification email.
966
- * @uiName Email redirection base path
1007
+ * @uiName Email Redirection Base Path
967
1008
  */
968
1009
  "redirectPath": string;
969
1010
  /**
970
- * @uiName Label for submit button
1011
+ * @uiName Submit Button Text
971
1012
  */
972
1013
  "submitLabel": string;
973
1014
  }
974
1015
  interface SqmPortalResetPassword {
975
1016
  /**
976
- * @uiName Show confirm password
1017
+ * Show or hide confirm password field
1018
+ * @uiName Show Confirm Password
977
1019
  */
978
1020
  "confirmPassword": boolean;
979
1021
  /**
980
- * @uiName Confirm password field label
1022
+ * @uiName Confirm Password Label
981
1023
  */
982
1024
  "confirmPasswordFieldLabel": string;
983
1025
  /**
984
- * Displayed after a successful password reset
985
- * @uiName Continue button text
1026
+ * Button text displayed after a successful password reset
1027
+ * @uiName Continue Button Text
986
1028
  */
987
1029
  "continueButtonText": string;
988
1030
  /**
@@ -992,29 +1034,29 @@ export namespace Components {
992
1034
  "demoData"?: DemoData<PortalResetPasswordViewProps>;
993
1035
  /**
994
1036
  * The page that users are redirected to if the reset fails due to outdated password reset attempt.
995
- * @uiName Failed page redirection path
1037
+ * @uiName Failed Page Path
996
1038
  */
997
1039
  "failedPage": string;
998
1040
  /**
999
1041
  * The page that users are redirected to when the password reset succeeds.
1000
- * @uiName Next page path
1042
+ * @uiName Next Page Path
1001
1043
  */
1002
1044
  "nextPage": string;
1003
1045
  /**
1004
- * @uiName Password field label
1046
+ * @uiName Password Label
1005
1047
  */
1006
1048
  "passwordFieldLabel": string;
1007
1049
  /**
1008
1050
  * Displayed after a successful password reset
1009
- * @uiName Password reset header text
1051
+ * @uiName Successful Password Reset Text
1010
1052
  */
1011
1053
  "passwordResetHeader": string;
1012
1054
  /**
1013
- * @uiName Password reset button text
1055
+ * @uiName Password Reset Button Text
1014
1056
  */
1015
1057
  "resetPasswordButtonText": string;
1016
1058
  /**
1017
- * @uiName Password reset header text
1059
+ * @uiName Reset Password Header Text
1018
1060
  */
1019
1061
  "resetPasswordHeader": string;
1020
1062
  }
@@ -1026,12 +1068,12 @@ export namespace Components {
1026
1068
  "demoData"?: DemoData<PortalVerifyEmailViewProps>;
1027
1069
  /**
1028
1070
  * The page that users are redirected to if verification fails due to outdated verification attempt.
1029
- * @uiName Failed page redirection path
1071
+ * @uiName Failed Page Path
1030
1072
  */
1031
1073
  "failedPage": string;
1032
1074
  /**
1033
1075
  * The page that users are redirected to when the verification succeeds.
1034
- * @uiName Next page path
1076
+ * @uiName Next Page Path
1035
1077
  */
1036
1078
  "nextPage": string;
1037
1079
  }
@@ -1099,16 +1141,19 @@ export namespace Components {
1099
1141
  */
1100
1142
  "demoData"?: DemoData<ReferralIframeViewProps>;
1101
1143
  /**
1102
- * @uiName Height of the iframe container
1144
+ * Height of the iframe container
1145
+ * @uiName Iframe Height
1103
1146
  */
1104
1147
  "iframeHeight": string;
1105
1148
  /**
1106
- * @uiName URL of iframe to display
1107
- * @uiRequired
1149
+ * URL of iframe to display
1150
+ * @uiName Iframe Source
1151
+ * @required
1108
1152
  */
1109
1153
  "iframeSrc": string;
1110
1154
  /**
1111
- * @uiName Width of the iframe container
1155
+ * Width of the iframe container
1156
+ * @uiName Iframe Width
1112
1157
  */
1113
1158
  "iframeWidth": string;
1114
1159
  }
@@ -1120,7 +1165,7 @@ export namespace Components {
1120
1165
  "demoData"?: DemoData<GenericTableViewProps>;
1121
1166
  /**
1122
1167
  * Provide the column numbers (0 indexed) that should not be displayed in mobile views. Ex. 0,2,3
1123
- * @uiName Mobile Hidden Columns
1168
+ * @uiName Hidden Mobile Columns
1124
1169
  */
1125
1170
  "hiddenColumns"?: string;
1126
1171
  /**
@@ -1128,15 +1173,16 @@ export namespace Components {
1128
1173
  */
1129
1174
  "mdBreakpoint"?: number;
1130
1175
  /**
1131
- * @uiName View More button text
1176
+ * @uiName View More Button Text
1132
1177
  */
1133
1178
  "moreLabel"?: string;
1134
1179
  /**
1135
- * @uiName Number of referrals per page
1180
+ * Number of referrals displayed per page
1181
+ * @uiName Referrals Per Page
1136
1182
  */
1137
1183
  "perPage": number;
1138
1184
  /**
1139
- * @uiName Previous button text
1185
+ * @uiName Previous Button Text
1140
1186
  */
1141
1187
  "prevLabel"?: string;
1142
1188
  /**
@@ -1145,11 +1191,12 @@ export namespace Components {
1145
1191
  */
1146
1192
  "programId": string;
1147
1193
  /**
1148
- * @uiName Show column labels
1194
+ * @uiName Show Column Labels
1149
1195
  */
1150
1196
  "showLabels"?: boolean;
1151
1197
  /**
1152
- * @uiName Show Referred by user in table
1198
+ * Show referred by user in table
1199
+ * @uiName Show Referrer
1153
1200
  */
1154
1201
  "showReferrer"?: boolean;
1155
1202
  /**
@@ -1262,7 +1309,8 @@ export namespace Components {
1262
1309
  }
1263
1310
  interface SqmReferralTableUserColumn {
1264
1311
  /**
1265
- * @uiName Name displayed for anonymous users
1312
+ * Name displayed for unknown users
1313
+ * @uiName Anonymous User Text
1266
1314
  */
1267
1315
  "anonymousUser": string;
1268
1316
  /**
@@ -1270,7 +1318,8 @@ export namespace Components {
1270
1318
  */
1271
1319
  "columnTitle": string;
1272
1320
  /**
1273
- * @uiName Name displayed for deleted users
1321
+ * Name displayed for deleted users
1322
+ * @uiName Deleted User Text
1274
1323
  */
1275
1324
  "deletedUser": string;
1276
1325
  "renderCell": (data: Referral) => Promise<any>;
@@ -1322,11 +1371,12 @@ export namespace Components {
1322
1371
  */
1323
1372
  "doneText": string;
1324
1373
  /**
1325
- * @uiName Exchange button text
1374
+ * Error message shown when reward is not available
1375
+ * @uiName Not Available Error
1326
1376
  */
1327
1377
  "notAvailableError": string;
1328
1378
  /**
1329
- * @uiName Not Enough Available Error Message
1379
+ * @uiName Not Enough Error Message
1330
1380
  */
1331
1381
  "notEnoughError": string;
1332
1382
  /**
@@ -1381,7 +1431,7 @@ export namespace Components {
1381
1431
  "selectText": string;
1382
1432
  /**
1383
1433
  * Set the number of placeholder cards to be shown in loading state.
1384
- * @undocumented Loading Cards
1434
+ * @uiName Loading Cards
1385
1435
  */
1386
1436
  "skeletonCardNum": number;
1387
1437
  /**
@@ -1480,7 +1530,7 @@ export namespace Components {
1480
1530
  */
1481
1531
  "availableText": string;
1482
1532
  /**
1483
- * @uiName Reward column title
1533
+ * @uiName Reward Column Title
1484
1534
  */
1485
1535
  "columnTitle": string;
1486
1536
  /**
@@ -1505,7 +1555,8 @@ export namespace Components {
1505
1555
  }
1506
1556
  interface SqmRewardsTableSourceColumn {
1507
1557
  /**
1508
- * @uiName Name displayed for anonymous users
1558
+ * Name displayed for unknown users
1559
+ * @uiName Anonymous User Text
1509
1560
  */
1510
1561
  "anonymousUser": string;
1511
1562
  /**
@@ -1513,7 +1564,8 @@ export namespace Components {
1513
1564
  */
1514
1565
  "columnTitle": string;
1515
1566
  /**
1516
- * @uiName Name displayed for deleted users
1567
+ * Name displayed for deleted users
1568
+ * @uiName Deleted User Text
1517
1569
  */
1518
1570
  "deletedUser": string;
1519
1571
  /**
@@ -1524,7 +1576,7 @@ export namespace Components {
1524
1576
  "renderCell": (data: Reward, locale: any) => Promise<any>;
1525
1577
  "renderLabel": () => Promise<string>;
1526
1578
  /**
1527
- * @uiName Reward Exchange label
1579
+ * @uiName Reward Exchange Label
1528
1580
  */
1529
1581
  "rewardExchangeText": string;
1530
1582
  /**
@@ -1573,7 +1625,7 @@ export namespace Components {
1573
1625
  }
1574
1626
  interface SqmRoute {
1575
1627
  /**
1576
- * @uiName Navigation path name
1628
+ * @uiName Navigation Path Name
1577
1629
  */
1578
1630
  "path": string;
1579
1631
  }
@@ -1653,12 +1705,13 @@ export namespace Components {
1653
1705
  }
1654
1706
  interface SqmShareButton {
1655
1707
  /**
1656
- * @uiName Button background color
1708
+ * @uiName Button Background Color
1657
1709
  * @uiWidget color
1658
1710
  */
1659
1711
  "backgroundcolor"?: string;
1660
1712
  /**
1661
- * @uiName Configure border radius with pixel amount
1713
+ * Configure border radius with pixel amount
1714
+ * @uiName Border Radius
1662
1715
  */
1663
1716
  "borderradius"?: number;
1664
1717
  /**
@@ -1671,16 +1724,16 @@ export namespace Components {
1671
1724
  */
1672
1725
  "disabled"?: boolean;
1673
1726
  /**
1674
- * @uiName Hide the icon
1727
+ * @uiName Hide Icon
1675
1728
  */
1676
1729
  "hideicon"?: boolean;
1677
1730
  /**
1678
- * @uiName Hide the text
1731
+ * @uiName Hide Text
1679
1732
  */
1680
1733
  "hidetext"?: boolean;
1681
1734
  /**
1682
- * Options available at https://shoelace.style/components/icon
1683
- * @uiName Icon used in button. Will try to select an icon based on the share medium if left empty.
1735
+ * Options available at https://shoelace.style/components/icon Icon used in button. Will try to select an icon based on the share medium if left empty.
1736
+ * @uiName Icon
1684
1737
  */
1685
1738
  "icon"?: string;
1686
1739
  /**
@@ -1710,7 +1763,7 @@ export namespace Components {
1710
1763
  | "reminder"
1711
1764
  | "unknown";
1712
1765
  /**
1713
- * @uiName Display as pill
1766
+ * @uiName Display Pill
1714
1767
  */
1715
1768
  "pill"?: boolean;
1716
1769
  /**
@@ -1719,11 +1772,13 @@ export namespace Components {
1719
1772
  */
1720
1773
  "programId"?: string;
1721
1774
  /**
1722
- * @uiName Text used for native sharing (mobile only)
1775
+ * Text used for native sharing (mobile only)
1776
+ * @uiName Share Text
1723
1777
  */
1724
1778
  "sharetext"?: string;
1725
1779
  /**
1726
- * @uiName Title used for native sharing (mobile only)
1780
+ * Title used for native sharing (mobile only)
1781
+ * @uiName Share Title
1727
1782
  */
1728
1783
  "sharetitle"?: string;
1729
1784
  /**
@@ -1734,7 +1789,7 @@ export namespace Components {
1734
1789
  */
1735
1790
  "size"?: "small" | "medium" | "large";
1736
1791
  /**
1737
- * @uiName Button text color
1792
+ * @uiName Button Text Color
1738
1793
  * @uiWidget color
1739
1794
  */
1740
1795
  "textcolor"?: string;
@@ -1769,8 +1824,8 @@ export namespace Components {
1769
1824
  */
1770
1825
  "tooltiplifespan": number;
1771
1826
  /**
1772
- * This is shown after someone has successfully copied the cpde to the clipboard.
1773
- * @uiName Tooltip text
1827
+ * This is shown after someone has successfully copied the code to the clipboard.
1828
+ * @uiName Tooltip Text
1774
1829
  */
1775
1830
  "tooltiptext": string;
1776
1831
  }
@@ -1787,12 +1842,12 @@ export namespace Components {
1787
1842
  "programId"?: string;
1788
1843
  /**
1789
1844
  * The number of milliseconds that the tooltip will appear for
1790
- * @uiName Tooltip lifespan
1845
+ * @uiName Tooltip Lifespan
1791
1846
  */
1792
1847
  "tooltiplifespan": number;
1793
1848
  /**
1794
1849
  * This is shown after someone has successfully copied the link to the clipboard.
1795
- * @uiName Tooltip text
1850
+ * @uiName Tooltip Text
1796
1851
  */
1797
1852
  "tooltiptext": string;
1798
1853
  }
@@ -1805,7 +1860,7 @@ export namespace Components {
1805
1860
  */
1806
1861
  "display": "grid" | "flex";
1807
1862
  /**
1808
- * @uiName Space between stats
1863
+ * @uiName Space Between Stats
1809
1864
  * @uiType string
1810
1865
  * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
1811
1866
  * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
@@ -1840,19 +1895,23 @@ export namespace Components {
1840
1895
  interface SqmTaskCard {
1841
1896
  /**
1842
1897
  * @uiName CTA Button Link
1898
+ * @uiGroup CTA Button
1843
1899
  */
1844
1900
  "buttonLink": string;
1845
1901
  /**
1846
1902
  * @uiName CTA Button Text
1903
+ * @uiGroup CTA Button
1847
1904
  */
1848
1905
  "buttonText": string;
1849
1906
  /**
1850
1907
  * @uiName Title Text
1908
+ * @uiGroup Task
1851
1909
  */
1852
1910
  "cardTitle": string;
1853
1911
  /**
1854
1912
  * Displays the amount of times that a user has completed a repeatable task.
1855
1913
  * @uiName Completed Count Text
1914
+ * @uiGroup Task
1856
1915
  */
1857
1916
  "completedText": string;
1858
1917
  /**
@@ -1862,88 +1921,108 @@ export namespace Components {
1862
1921
  "demoData"?: DemoData<TaskCardViewProps | BigStatViewProps>;
1863
1922
  /**
1864
1923
  * @uiName Description Text
1924
+ * @uiGroup Task
1865
1925
  */
1866
1926
  "description": string;
1867
1927
  /**
1868
1928
  * Timeframe that the task card will be shown
1869
1929
  * @uiName Display Duration
1870
1930
  * @uiWidget DateRange
1871
- * @uiOptions {"allowPastDates":true, "months": 1}
1931
+ * @uiWidgetOptions {"allowPastDates":true, "months": 1}
1932
+ * @uiGroup Task
1872
1933
  */
1873
1934
  "displayDuration": string;
1874
1935
  /**
1875
1936
  * Shown to users after the end of the task duration.
1876
1937
  * @uiName Ended Date Message
1938
+ * @uiGroup Task
1877
1939
  */
1878
1940
  "endedMessage": string;
1879
1941
  /**
1880
1942
  * Optionally send an event to SaaSquatch when a user clicks the CTA. This field configured what key of the event sent is.
1881
- * @uiName Event key of task card button
1943
+ * @uiName Task Card Button Event Key
1944
+ * @uiGroup CTA Button
1882
1945
  */
1883
1946
  "eventKey"?: string;
1884
1947
  /**
1885
1948
  * @uiName Expiry Date Message
1949
+ * @uiGroup Task
1886
1950
  */
1887
1951
  "expiryMessage": string;
1888
1952
  /**
1889
1953
  * The number of times a reward can be earned. Use zero for no limit (the default).
1890
1954
  * @uiName Repeat Amount
1955
+ * @uiGroup Reward
1891
1956
  */
1892
1957
  "finite": number;
1893
1958
  /**
1894
1959
  * Sets the goal for users progress to know when a task has been completed. If repeatable is checked, repeatable goals is an increment of this.
1895
1960
  * @uiName Goal Completion Number
1961
+ * @uiGroup Goal
1896
1962
  */
1897
1963
  "goal": number;
1898
1964
  /**
1899
- * @uiName CTA Button Link Open in New Tab
1965
+ * CTA Button Link Opens in New Tab
1966
+ * @uiName Open In New Tab
1967
+ * @uiGroup CTA Button
1968
+ * @default undefined
1900
1969
  */
1901
1970
  "openNewTab": boolean;
1902
1971
  /**
1903
1972
  * The ID of the program that is used to scope the task card. Defaults to the program context when no ID is specified.
1904
- * @uiName Program ID override
1973
+ * @uiName Program ID Override
1974
+ * @uiGroup Goal
1905
1975
  */
1906
1976
  "programId"?: string;
1907
1977
  /**
1908
1978
  * @uiName Progress Bar Unit
1979
+ * @uiGroup Goal
1909
1980
  */
1910
1981
  "progressBarUnit": string;
1911
1982
  /**
1912
1983
  * @uiName Goal Repeatable
1984
+ * @uiGroup Goal
1913
1985
  */
1914
1986
  "repeatable": boolean;
1915
1987
  /**
1916
1988
  * @uiName Reward Amount
1989
+ * @uiGroup Reward
1917
1990
  */
1918
1991
  "rewardAmount": string;
1919
1992
  /**
1920
1993
  * @uiName Reward Duration
1921
1994
  * @uiWidget DateRange
1922
- * @uiOptions {"allowPastDates":true, "months": 1}
1995
+ * @uiWidgetOptions {"allowPastDates":true, "months": 1}
1996
+ * @uiGroup Reward
1923
1997
  */
1924
1998
  "rewardDuration": string;
1925
1999
  /**
1926
2000
  * @uiName Reward Unit
2001
+ * @uiGroup Reward
1927
2002
  */
1928
2003
  "rewardUnit": string;
1929
2004
  /**
1930
2005
  * @uiName Show Progress Bar
2006
+ * @uiGroup Goal
1931
2007
  */
1932
2008
  "showProgressBar": boolean;
1933
2009
  /**
1934
2010
  * Shown to users before the start of the task duration.
1935
2011
  * @uiName Start Date Message
2012
+ * @uiGroup Task
1936
2013
  */
1937
2014
  "startsOnMessage": string;
1938
2015
  /**
1939
2016
  * Select what type of stat to display for the goal. Manual paths are also supported.
1940
2017
  * @uiWidget StatTypeSelectWidget
1941
2018
  * @uiName Goal Progress Source
1942
- * @uiOptions {"version": 1.1}
2019
+ * @uiWidgetOptions {"version": 1.1}
2020
+ * @uiGroup Goal
1943
2021
  */
1944
2022
  "statType": string;
1945
2023
  /**
1946
2024
  * @uiName Progress Bar Steps
2025
+ * @uiGroup Goal
1947
2026
  */
1948
2027
  "steps": boolean;
1949
2028
  }
@@ -1955,7 +2034,7 @@ export namespace Components {
1955
2034
  */
1956
2035
  "text": string;
1957
2036
  /**
1958
- * @uiName Text
2037
+ * @uiName Type
1959
2038
  * @uiType string
1960
2039
  * @uiEnum ["p", "subtext", "h1", "h2", "h3", "h4"]
1961
2040
  * @uiEnumNames ["Paragraph", "Subtext", "Header 1", "Header 2", "Header 3", "Header 4"]
@@ -2000,14 +2079,14 @@ export namespace Components {
2000
2079
  */
2001
2080
  "label": string;
2002
2081
  /**
2003
- * @uiName Label margin style
2082
+ * @uiName Label Margin Style
2004
2083
  * @uiType string
2005
2084
  * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
2006
2085
  * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
2007
2086
  */
2008
2087
  "labelMargin": Spacing;
2009
2088
  /**
2010
- * @uiName Section padding
2089
+ * @uiName Section Padding
2011
2090
  * @uiType string
2012
2091
  * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
2013
2092
  * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
@@ -2028,11 +2107,12 @@ export namespace Components {
2028
2107
  */
2029
2108
  "demoData"?: DemoData<UserNameViewProps>;
2030
2109
  /**
2031
- * @uiName Fallback name for nameless users
2110
+ * Fallback name for unknown users
2111
+ * @uiName Fallback Name
2032
2112
  */
2033
2113
  "fallback": string;
2034
2114
  /**
2035
- * @uiName Loading text
2115
+ * @uiName Loading Text
2036
2116
  */
2037
2117
  "loadingText": string;
2038
2118
  }
@@ -2637,17 +2717,18 @@ declare namespace LocalJSX {
2637
2717
  */
2638
2718
  "demoData"?: DemoData<AssetCardViewProps>;
2639
2719
  /**
2640
- * @uiName Banner image
2720
+ * @uiName Banner Image
2641
2721
  */
2642
2722
  "imgUrl"?: string;
2643
2723
  /**
2644
- * @uiName Banner title
2724
+ * @uiName Banner Title
2645
2725
  */
2646
2726
  "titleText"?: string;
2647
2727
  }
2648
2728
  interface SqmBigStat {
2649
2729
  /**
2650
- * @uiName Alignment - controls the alignment of the flexbox
2730
+ * Controls the alignment of the flexbox
2731
+ * @uiName Alignment
2651
2732
  * @uiType string
2652
2733
  * @uiEnum ["left", "right", "center"]
2653
2734
  * @uiEnumNames ["Left", "Right", "Center"]
@@ -2659,7 +2740,8 @@ declare namespace LocalJSX {
2659
2740
  */
2660
2741
  "demoData"?: DemoData<BigStatViewProps>;
2661
2742
  /**
2662
- * @uiName Flex Reverse - controls the order of the stat value & description column
2743
+ * Controls the order of the stat value & description column
2744
+ * @uiName Flex Reverse
2663
2745
  */
2664
2746
  "flexReverse"?: boolean;
2665
2747
  /**
@@ -2671,7 +2753,7 @@ declare namespace LocalJSX {
2671
2753
  * Select what type of stat to display. Manual paths are also supported.
2672
2754
  * @uiWidget StatTypeSelectWidget
2673
2755
  * @uiName Stat Type
2674
- * @uiOptions {"version": 1.1}
2756
+ * @uiWidgetOptions {"version": 1.1}
2675
2757
  */
2676
2758
  "statType"?: string;
2677
2759
  }
@@ -2701,19 +2783,20 @@ declare namespace LocalJSX {
2701
2783
  }
2702
2784
  interface SqmCheckboxField {
2703
2785
  /**
2704
- * @uiName Checkbox label
2786
+ * @uiName Checkbox Label
2705
2787
  */
2706
2788
  "checkboxLabel"?: string;
2707
2789
  /**
2708
- * @uiName Checkbox label link Used with link text if the checkbox label contains {labelLink}
2790
+ * Used with link text if the checkbox label contains {labelLink}
2791
+ * @uiName Checkbox Label Link
2709
2792
  */
2710
2793
  "checkboxLabelLink"?: string;
2711
2794
  /**
2712
- * @uiName Checkbox label link text
2795
+ * @uiName Checkbox Label Link Text
2713
2796
  */
2714
2797
  "checkboxLabelLinkText"?: string;
2715
2798
  /**
2716
- * @uiName Checkbox name attribute
2799
+ * @uiName Checkbox Name Attribute
2717
2800
  */
2718
2801
  "checkboxName"?: string;
2719
2802
  /**
@@ -2726,7 +2809,7 @@ declare namespace LocalJSX {
2726
2809
  */
2727
2810
  "demoData"?: DemoData<CheckboxFieldViewProps>;
2728
2811
  /**
2729
- * @uiName Unchecked error message
2812
+ * @uiName Unchecked Error Message
2730
2813
  */
2731
2814
  "errorMessage"?: string;
2732
2815
  }
@@ -2739,8 +2822,8 @@ declare namespace LocalJSX {
2739
2822
  */
2740
2823
  "direction"?: "row" | "column";
2741
2824
  /**
2742
- * Uses CSS border style syntax
2743
- * @uiName Border style
2825
+ * Uses Shorthand CSS border syntax
2826
+ * @uiName Border Style
2744
2827
  */
2745
2828
  "dividerStyle"?: string;
2746
2829
  }
@@ -2751,11 +2834,11 @@ declare namespace LocalJSX {
2751
2834
  */
2752
2835
  "demoData"?: DemoData<DropdownFieldViewProps>;
2753
2836
  /**
2754
- * @uiName Dropdown label
2837
+ * @uiName Dropdown Label
2755
2838
  */
2756
2839
  "dropdownLabel"?: string;
2757
2840
  /**
2758
- * @uiName Dropdown name attribute
2841
+ * @uiName Dropdown Name Attribute
2759
2842
  */
2760
2843
  "dropdownName"?: string;
2761
2844
  /**
@@ -2763,17 +2846,17 @@ declare namespace LocalJSX {
2763
2846
  */
2764
2847
  "dropdownOptional"?: boolean;
2765
2848
  /**
2766
- * @uiName Unselected error message
2849
+ * @uiName Unselected Error Message
2767
2850
  */
2768
2851
  "errorMessage"?: string;
2769
2852
  }
2770
2853
  interface SqmEditProfile {
2771
2854
  /**
2772
- * @uiName Cancel button text
2855
+ * @uiName Cancel Button Text
2773
2856
  */
2774
2857
  "canceltext"?: string;
2775
2858
  /**
2776
- * @uiName Region field label
2859
+ * @uiName Region Field Label
2777
2860
  */
2778
2861
  "currentregiontext"?: string;
2779
2862
  /**
@@ -2786,23 +2869,25 @@ declare namespace LocalJSX {
2786
2869
  */
2787
2870
  "editprofileheader"?: string;
2788
2871
  /**
2789
- * @uiName Enable editing button text
2872
+ * Enable editing button text
2873
+ * @uiName Edit Profile Text
2790
2874
  */
2791
2875
  "editprofiletext"?: string;
2792
2876
  /**
2793
- * @uiName First name field label
2877
+ * @uiName First Name Label
2794
2878
  */
2795
2879
  "firstnametext"?: string;
2796
2880
  /**
2797
- * @uiName Last name field label
2881
+ * @uiName Last Name Label
2798
2882
  */
2799
2883
  "lastnametext"?: string;
2800
2884
  /**
2801
- * @uiName Show or hide current region
2885
+ * Show or hide current region
2886
+ * @uiName Show Region
2802
2887
  */
2803
2888
  "showregion"?: boolean;
2804
2889
  /**
2805
- * @uiName Update info button text
2890
+ * @uiName Info Button Text
2806
2891
  */
2807
2892
  "updatetext"?: string;
2808
2893
  }
@@ -2823,11 +2908,12 @@ declare namespace LocalJSX {
2823
2908
  }
2824
2909
  interface SqmFormMessage {
2825
2910
  /**
2826
- * @uiName Icon to use in alert
2911
+ * Icon to use in alert
2912
+ * @uiName Icon
2827
2913
  */
2828
2914
  "icon"?: string;
2829
2915
  /**
2830
- * @uiName Type of alert
2916
+ * @uiName Alert Type
2831
2917
  */
2832
2918
  "type"?: string;
2833
2919
  }
@@ -2839,24 +2925,27 @@ declare namespace LocalJSX {
2839
2925
  }
2840
2926
  interface SqmHero {
2841
2927
  /**
2842
- * Can either be an image url, colour or Shoelace variable.
2928
+ * Can be an image url, colour or Shoelace variable.
2843
2929
  * @uiName Background
2844
2930
  */
2845
2931
  "background"?: string;
2846
2932
  /**
2847
- * @uiName Number of columns in the layout
2933
+ * Number of columns in the layout
2934
+ * @uiName Columns
2848
2935
  */
2849
2936
  "columns"?: 1 | 2;
2850
2937
  /**
2851
- * @uiName Padding size
2938
+ * @uiName Padding Size
2852
2939
  */
2853
2940
  "paddingSize"?: "none" | "small" | "medium" | "large";
2854
2941
  /**
2855
- * @uiName Secondary background image or color (for use in right column)
2942
+ * Secondary background image or color (for use in the right column)
2943
+ * @uiName Secondary Background
2856
2944
  */
2857
2945
  "secondaryBackground"?: string;
2858
2946
  /**
2859
- * @uiName Wrap direction
2947
+ * Flexbox wrap direction, accepts wrap or wrap-reverse
2948
+ * @uiName Wrap Direction
2860
2949
  */
2861
2950
  "wrapDirection"?: "wrap" | "wrap-reverse";
2862
2951
  }
@@ -2871,7 +2960,8 @@ declare namespace LocalJSX {
2871
2960
  */
2872
2961
  "buttonLink"?: string;
2873
2962
  /**
2874
- * @uiName CTA Button Link Open in New Tab
2963
+ * CTA Button Opens Link in New Tab
2964
+ * @uiName Button New Tab
2875
2965
  */
2876
2966
  "buttonNewTab"?: boolean;
2877
2967
  /**
@@ -3006,8 +3096,8 @@ declare namespace LocalJSX {
3006
3096
  }
3007
3097
  interface SqmLeaderboard {
3008
3098
  /**
3009
- * Text displayed for users without names in the leaderboard
3010
- * @uiName Anonymous User Name
3099
+ * Title displayed for users without names
3100
+ * @uiName Unknown User Text
3011
3101
  */
3012
3102
  "anonymousUser"?: string;
3013
3103
  /**
@@ -3021,10 +3111,9 @@ declare namespace LocalJSX {
3021
3111
  */
3022
3112
  "hideViewer"?: boolean;
3023
3113
  /**
3024
- * Only count leaderboard activity within a given interval
3025
3114
  * @uiName Leaderboard Time Interval
3026
3115
  * @uiWidget DateRange
3027
- * @uiOptions {"allowPastDates":true, "months": 1}
3116
+ * @uiWidgetOptions {"allowPastDates":true, "months": 1}
3028
3117
  */
3029
3118
  "interval"?: string;
3030
3119
  /**
@@ -3058,7 +3147,7 @@ declare namespace LocalJSX {
3058
3147
  */
3059
3148
  "rankheading"?: string;
3060
3149
  /**
3061
- * @uiName Show Rank Column
3150
+ * @uiName Show Leaderboard Rank
3062
3151
  */
3063
3152
  "showRank"?: boolean;
3064
3153
  /**
@@ -3077,13 +3166,13 @@ declare namespace LocalJSX {
3077
3166
  */
3078
3167
  "demoData"?: DemoData<LeaderboardRankViewProps>;
3079
3168
  /**
3080
- * @uiName Leaderboard time interval
3169
+ * @uiName Leaderboard Time Interval
3081
3170
  * @uiWidget DateRange
3082
- * @uiOptions {"allowPastDates":true, "months": 1}
3171
+ * @uiWidgetOptions {"allowPastDates":true, "months": 1}
3083
3172
  */
3084
3173
  "interval"?: string;
3085
3174
  /**
3086
- * @uiName Leaderboard type
3175
+ * @uiName Leaderboard Type
3087
3176
  * @uiType string
3088
3177
  * @uiEnum ["topStartedReferrers", "topConvertedReferrers", "topPointEarners"]
3089
3178
  * @uiEnumNames ["Top Started Referrers", "Top Converted Referrers", "Top Point Earners"]
@@ -3101,7 +3190,7 @@ declare namespace LocalJSX {
3101
3190
  */
3102
3191
  "rankText"?: string;
3103
3192
  /**
3104
- * @uiName Default rank
3193
+ * @uiName Default Rank
3105
3194
  * @uiType string
3106
3195
  * @uiEnum ["rowNumber", "rank", "denseRank"]
3107
3196
  * @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
@@ -3119,11 +3208,11 @@ declare namespace LocalJSX {
3119
3208
  */
3120
3209
  "demoData"?: DemoData<NameFieldsViewProps>;
3121
3210
  /**
3122
- * @uiName First name field label
3211
+ * @uiName First Name label
3123
3212
  */
3124
3213
  "firstNameLabel"?: string;
3125
3214
  /**
3126
- * @uiName Last name field label
3215
+ * @uiName Last Name label
3127
3216
  */
3128
3217
  "lastNameLabel"?: string;
3129
3218
  }
@@ -3134,11 +3223,12 @@ declare namespace LocalJSX {
3134
3223
  */
3135
3224
  "demoData"?: DemoData<NavigationMenuViewProps>;
3136
3225
  /**
3137
- * @uiName Include dropdown menu
3226
+ * @uiName Include Dropdown Menu
3138
3227
  */
3139
3228
  "includeDropdown"?: boolean;
3140
3229
  /**
3141
- * @uiName Label on the header menu
3230
+ * Label on the header menu
3231
+ * @uiName Menu Label
3142
3232
  */
3143
3233
  "menuLabel"?: string;
3144
3234
  }
@@ -3160,7 +3250,7 @@ declare namespace LocalJSX {
3160
3250
  */
3161
3251
  "label"?: string;
3162
3252
  /**
3163
- * @uiName Navigation path
3253
+ * @uiName Navigation Path
3164
3254
  */
3165
3255
  "path"?: string;
3166
3256
  }
@@ -3171,53 +3261,63 @@ declare namespace LocalJSX {
3171
3261
  */
3172
3262
  "demoData"?: PasswordFieldViewDemoProps;
3173
3263
  /**
3174
- * @uiName Enable live password validation
3264
+ * Enable live password validation
3265
+ * @uiName Enable Validation
3175
3266
  */
3176
3267
  "enableValidation"?: boolean;
3177
3268
  /**
3178
- * @uiName Label for password field
3269
+ * Label for password field
3270
+ * @uiName Password Label
3179
3271
  */
3180
3272
  "fieldLabel"?: string;
3181
3273
  }
3182
3274
  interface SqmPopupContainer {
3183
3275
  /**
3184
- * @uiName Display a close button on the popup
3276
+ * Display a close button on the popup
3277
+ * @uiName Show Close Button
3185
3278
  */
3186
3279
  "closeButton"?: boolean;
3187
3280
  /**
3188
- * @uiName Text to be used as the close button
3281
+ * Text inside the close button
3282
+ * @uiName Close Button Text
3189
3283
  */
3190
3284
  "closeButtonText"?: string;
3191
3285
  /**
3192
- * @uiName Specify padding on the popup contents when in embedded mode
3286
+ * Specify padding on the popup contents when in embedded mode
3287
+ * @uiName Embed Padding
3193
3288
  * @uiType string
3194
3289
  * @uiEnum ["none", "small", "medium", "large"]
3195
3290
  * @uiEnumNames ["None", "Small", "Medium", "Large"]
3196
3291
  */
3197
3292
  "embedPadding"?: "none" | "small" | "medium" | "large";
3198
3293
  /**
3199
- * @uiName Specify padding on the popup contents when in popup mode
3294
+ * Specify padding on the popup contents when in popup mode
3295
+ * @uiName Popup Padding
3200
3296
  * @uiType string
3201
3297
  * @uiEnum ["none", "small", "medium", "large"]
3202
3298
  * @uiEnumNames ["None", "Small", "Medium", "Large"]
3203
3299
  */
3204
3300
  "popupPadding"?: "none" | "small" | "medium" | "large";
3205
3301
  /**
3206
- * @uiName Show SaaSquatch Powered By messaging
3302
+ * Show Powered By SaaSquatch link
3303
+ * @uiName Show Powered By
3207
3304
  */
3208
3305
  "poweredBy"?: boolean;
3209
3306
  }
3210
3307
  interface SqmPortalChangePassword {
3211
3308
  /**
3212
- * @uiName Modal cancel password change button text
3309
+ * Modal cancel button text
3310
+ * @uiName Cancel Button Text
3213
3311
  */
3214
3312
  "cancelText"?: string;
3215
3313
  /**
3216
- * @uiName Modal change password button text
3314
+ * Modal change password button text
3315
+ * @uiName Change Password Button Text
3217
3316
  */
3218
3317
  "changePasswordButtonText"?: string;
3219
3318
  /**
3220
- * @uiName Password confirmation input field label
3319
+ * Password confirmation input field label
3320
+ * @uiName Confirm Password Label
3221
3321
  */
3222
3322
  "confirmPasswordFieldLabel"?: string;
3223
3323
  /**
@@ -3226,29 +3326,32 @@ declare namespace LocalJSX {
3226
3326
  */
3227
3327
  "demoData"?: DemoData<PortalChangePasswordViewProps>;
3228
3328
  /**
3229
- * @uiName Change password modal header
3329
+ * @uiName Change Password Modal Header
3230
3330
  */
3231
3331
  "modalChangePasswordHeader"?: string;
3232
3332
  /**
3233
- * @uiName Password input field label
3333
+ * Password input field label
3334
+ * @uiName Password Label
3234
3335
  */
3235
3336
  "passwordFieldLabel"?: string;
3236
3337
  /**
3237
- * @uiName Portal change password button text
3338
+ * @uiName Change Password Button Text
3238
3339
  */
3239
3340
  "portalChangePasswordButtonText"?: string;
3240
3341
  /**
3241
- * @uiName Portal change password section header
3342
+ * Portal change password section header
3343
+ * @uiName Change Password Header
3242
3344
  */
3243
3345
  "portalChangePasswordHeader"?: string;
3244
3346
  /**
3245
- * @uiName Successful password change message
3347
+ * Successful password change message
3348
+ * @uiName Successful Message
3246
3349
  */
3247
3350
  "successMessage"?: string;
3248
3351
  }
3249
3352
  interface SqmPortalContainer {
3250
3353
  /**
3251
- * @uiName Center content
3354
+ * @uiName Center Content
3252
3355
  */
3253
3356
  "center"?: boolean;
3254
3357
  /**
@@ -3273,7 +3376,8 @@ declare namespace LocalJSX {
3273
3376
  */
3274
3377
  "gap"?: Spacing;
3275
3378
  /**
3276
- * @uiName Justify content
3379
+ * Defines how the container distributes space between & around content items along the main-axis of a flex container
3380
+ * @uiName Justify Content
3277
3381
  * @uiType string
3278
3382
  * @uiEnum ["start", "center", "end", "space-between", "space-around", "space-evenly"]
3279
3383
  * @uiEnumNames ["Start", "Center", "End", "Space Between", "Space Around", "Space Evenly"]
@@ -3289,7 +3393,7 @@ declare namespace LocalJSX {
3289
3393
  */
3290
3394
  "maxWidth"?: string;
3291
3395
  /**
3292
- * @uiName Minimum width
3396
+ * @uiName Minimum Width
3293
3397
  */
3294
3398
  "minWidth"?: string;
3295
3399
  /**
@@ -3307,20 +3411,20 @@ declare namespace LocalJSX {
3307
3411
  */
3308
3412
  "demoData"?: DemoData<PortalEmailVerificationViewProps>;
3309
3413
  /**
3310
- * @uiName Email verification header text
3414
+ * @uiName Email Verification Header Text
3311
3415
  */
3312
3416
  "emailVerificationHeader"?: string;
3313
3417
  /**
3314
3418
  * The page that users are redirected to from the verification email.
3315
- * @uiName Email redirection base path
3419
+ * @uiName Email Redirection Base Path
3316
3420
  */
3317
3421
  "redirectPath"?: string;
3318
3422
  /**
3319
- * @uiName Re-send email button text
3423
+ * @uiName Re-send Email Button Text
3320
3424
  */
3321
3425
  "resendEmailButtonText"?: string;
3322
3426
  /**
3323
- * @uiName Email verification body text
3427
+ * @uiName Email Verification Body Text
3324
3428
  */
3325
3429
  "verifyMessage"?: string;
3326
3430
  }
@@ -3381,20 +3485,20 @@ declare namespace LocalJSX {
3381
3485
  */
3382
3486
  "demoData"?: DemoData<PortalForgotPasswordViewProps>;
3383
3487
  /**
3384
- * @uiName Email label
3488
+ * @uiName Email Label
3385
3489
  */
3386
3490
  "emailLabel"?: string;
3387
3491
  /**
3388
- * @uiName Routing path to login page
3492
+ * @uiName Login Page Routing Path
3389
3493
  */
3390
3494
  "loginPath"?: string;
3391
3495
  /**
3392
3496
  * The page that users are redirected to from the password reset email.
3393
- * @uiName Email redirection base path
3497
+ * @uiName Email Redirection Base Path
3394
3498
  */
3395
3499
  "redirectPath"?: string;
3396
3500
  /**
3397
- * @uiName Password reset button text
3501
+ * @uiName Password Reset Button Text
3398
3502
  */
3399
3503
  "submitLabel"?: string;
3400
3504
  }
@@ -3412,51 +3516,60 @@ declare namespace LocalJSX {
3412
3516
  */
3413
3517
  "demoData"?: DemoData<PortalLoginViewProps>;
3414
3518
  /**
3415
- * @uiName Label for email field
3519
+ * Label for email field
3520
+ * @uiName Email Label
3416
3521
  */
3417
3522
  "emailLabel"?: string;
3418
3523
  /**
3419
- * @uiName Label for forgotten password button
3524
+ * Label for forgotten password button
3525
+ * @uiName Forgot Password Text
3420
3526
  */
3421
3527
  "forgotPasswordLabel"?: string;
3422
3528
  /**
3423
- * @uiName Forgot password button redirect path
3529
+ * Forgot password redirect path
3530
+ * @uiName Forgot Password Path
3424
3531
  */
3425
3532
  "forgotPasswordPath"?: string;
3426
3533
  /**
3427
- * @uiName Page navigated to after sign-in
3534
+ * Page navigated to after sign-in
3535
+ * @uiName Next Page Path
3428
3536
  */
3429
3537
  "nextPage"?: string;
3430
3538
  /**
3431
- * @uiName Heading label
3539
+ * @uiName Heading Label
3432
3540
  */
3433
3541
  "pageLabel"?: string;
3434
3542
  /**
3435
- * @uiName Label for password field
3543
+ * Label for password field
3544
+ * @uiName Password Label
3436
3545
  */
3437
3546
  "passwordLabel"?: string;
3438
3547
  /**
3439
- * @uiName Label for register navigation button
3548
+ * Label for register button
3549
+ * @uiName Register Button Text
3440
3550
  */
3441
3551
  "registerLabel"?: string;
3442
3552
  /**
3443
- * @uiName Register button redirection path
3553
+ * Register redirect path
3554
+ * @uiName Register Path
3444
3555
  */
3445
3556
  "registerPath"?: string;
3446
3557
  /**
3447
- * @uiName Label for submit button
3558
+ * Label for submit button
3559
+ * @uiName Submit Button Text
3448
3560
  */
3449
3561
  "submitLabel"?: string;
3450
3562
  }
3451
3563
  interface SqmPortalLogout {
3452
3564
  /**
3453
- * @uiName Next Page path
3565
+ * @uiName Next Page Path
3454
3566
  */
3455
3567
  "nextPage"?: string;
3456
3568
  }
3457
3569
  interface SqmPortalProfile {
3458
3570
  /**
3459
- * @uiName Country input field label
3571
+ * Country input field label
3572
+ * @uiName Country Label
3460
3573
  */
3461
3574
  "countrytext"?: string;
3462
3575
  /**
@@ -3465,31 +3578,35 @@ declare namespace LocalJSX {
3465
3578
  */
3466
3579
  "demoData"?: DemoData<PortalProfileViewProps>;
3467
3580
  /**
3468
- * @uiName Edit profile header
3581
+ * @uiName Edit Profile Header
3469
3582
  */
3470
3583
  "editProfileHeader"?: string;
3471
3584
  /**
3472
- * @uiName Edit profile sub header
3585
+ * @uiName Edit Profile Sub Header
3473
3586
  */
3474
3587
  "editProfileSubHeader"?: string;
3475
3588
  /**
3476
- * @uiName Email input field label
3589
+ * Email input field label
3590
+ * @uiName Email Label
3477
3591
  */
3478
3592
  "emailtext"?: string;
3479
3593
  /**
3480
- * @uiName First name input field label
3594
+ * First name input field label
3595
+ * @uiName First Name Label
3481
3596
  */
3482
3597
  "firstnametext"?: string;
3483
3598
  /**
3484
- * @uiName Last name input field label
3599
+ * Last name input field label
3600
+ * @uiName Last Name Label
3485
3601
  */
3486
3602
  "lastnametext"?: string;
3487
3603
  /**
3488
- * @uiName Show or hide country field
3604
+ * Show or hide the country field
3605
+ * @uiName Show Country Field
3489
3606
  */
3490
3607
  "showCountry"?: boolean;
3491
3608
  /**
3492
- * @uiName Text for the submit changes button
3609
+ * @uiName Submit Changes Button Text
3493
3610
  */
3494
3611
  "submitChangeButtonText"?: string;
3495
3612
  }
@@ -3499,7 +3616,7 @@ declare namespace LocalJSX {
3499
3616
  */
3500
3617
  "redirectTo"?: string;
3501
3618
  /**
3502
- * @uiName Redirect unverified users path
3619
+ * @uiName Redirect Unverified Users Path
3503
3620
  */
3504
3621
  "redirectToUnverified"?: string;
3505
3622
  /**
@@ -3509,11 +3626,12 @@ declare namespace LocalJSX {
3509
3626
  }
3510
3627
  interface SqmPortalRegister {
3511
3628
  /**
3512
- * @uiName Show confirm password field
3629
+ * Show or hide the confirm password input
3630
+ * @uiName Show Confirm Password Field
3513
3631
  */
3514
3632
  "confirmPassword"?: boolean;
3515
3633
  /**
3516
- * @uiName Label for confirm password field
3634
+ * @uiName Confirm Password Label
3517
3635
  */
3518
3636
  "confirmPasswordLabel"?: string;
3519
3637
  /**
@@ -3522,59 +3640,63 @@ declare namespace LocalJSX {
3522
3640
  */
3523
3641
  "demoData"?: DemoData<PortalRegisterViewProps>;
3524
3642
  /**
3525
- * @uiName Label for email field
3643
+ * @uiName Email Label
3526
3644
  */
3527
3645
  "emailLabel"?: string;
3528
3646
  /**
3529
- * @uiName Use password field with live validation
3647
+ * @uiName Enable Password Validation
3530
3648
  */
3531
3649
  "enablePasswordValidation"?: boolean;
3532
3650
  /**
3533
- * @uiName Hide default input fields to use custom fields
3651
+ * Hide default input fields to use custom fields
3652
+ * @uiName Hide Default Inputs
3534
3653
  */
3535
3654
  "hideInputs"?: boolean;
3536
3655
  /**
3537
- * @uiName Label for login navigation button
3656
+ * @uiName Login Button Text
3538
3657
  */
3539
3658
  "loginLabel"?: string;
3540
3659
  /**
3541
- * @uiName Sign in button redirection path
3660
+ * Login button redirection path
3661
+ * @uiName Login Path
3542
3662
  */
3543
3663
  "loginPath"?: string;
3544
3664
  /**
3545
- * @uiName Page navigated to after registration
3665
+ * Page navigated to after registration
3666
+ * @uiName Next Page
3546
3667
  */
3547
3668
  "nextPage"?: string;
3548
3669
  /**
3549
- * @uiName Heading label
3670
+ * @uiName Heading Label
3550
3671
  */
3551
3672
  "pageLabel"?: string;
3552
3673
  /**
3553
- * @uiName Label for password field
3674
+ * @uiName Password Label
3554
3675
  */
3555
3676
  "passwordLabel"?: string;
3556
3677
  /**
3557
3678
  * The page that users are redirected to from the verification email.
3558
- * @uiName Email redirection base path
3679
+ * @uiName Email Redirection Base Path
3559
3680
  */
3560
3681
  "redirectPath"?: string;
3561
3682
  /**
3562
- * @uiName Label for submit button
3683
+ * @uiName Submit Button Text
3563
3684
  */
3564
3685
  "submitLabel"?: string;
3565
3686
  }
3566
3687
  interface SqmPortalResetPassword {
3567
3688
  /**
3568
- * @uiName Show confirm password
3689
+ * Show or hide confirm password field
3690
+ * @uiName Show Confirm Password
3569
3691
  */
3570
3692
  "confirmPassword"?: boolean;
3571
3693
  /**
3572
- * @uiName Confirm password field label
3694
+ * @uiName Confirm Password Label
3573
3695
  */
3574
3696
  "confirmPasswordFieldLabel"?: string;
3575
3697
  /**
3576
- * Displayed after a successful password reset
3577
- * @uiName Continue button text
3698
+ * Button text displayed after a successful password reset
3699
+ * @uiName Continue Button Text
3578
3700
  */
3579
3701
  "continueButtonText"?: string;
3580
3702
  /**
@@ -3584,29 +3706,29 @@ declare namespace LocalJSX {
3584
3706
  "demoData"?: DemoData<PortalResetPasswordViewProps>;
3585
3707
  /**
3586
3708
  * The page that users are redirected to if the reset fails due to outdated password reset attempt.
3587
- * @uiName Failed page redirection path
3709
+ * @uiName Failed Page Path
3588
3710
  */
3589
3711
  "failedPage"?: string;
3590
3712
  /**
3591
3713
  * The page that users are redirected to when the password reset succeeds.
3592
- * @uiName Next page path
3714
+ * @uiName Next Page Path
3593
3715
  */
3594
3716
  "nextPage"?: string;
3595
3717
  /**
3596
- * @uiName Password field label
3718
+ * @uiName Password Label
3597
3719
  */
3598
3720
  "passwordFieldLabel"?: string;
3599
3721
  /**
3600
3722
  * Displayed after a successful password reset
3601
- * @uiName Password reset header text
3723
+ * @uiName Successful Password Reset Text
3602
3724
  */
3603
3725
  "passwordResetHeader"?: string;
3604
3726
  /**
3605
- * @uiName Password reset button text
3727
+ * @uiName Password Reset Button Text
3606
3728
  */
3607
3729
  "resetPasswordButtonText"?: string;
3608
3730
  /**
3609
- * @uiName Password reset header text
3731
+ * @uiName Reset Password Header Text
3610
3732
  */
3611
3733
  "resetPasswordHeader"?: string;
3612
3734
  }
@@ -3618,12 +3740,12 @@ declare namespace LocalJSX {
3618
3740
  "demoData"?: DemoData<PortalVerifyEmailViewProps>;
3619
3741
  /**
3620
3742
  * The page that users are redirected to if verification fails due to outdated verification attempt.
3621
- * @uiName Failed page redirection path
3743
+ * @uiName Failed Page Path
3622
3744
  */
3623
3745
  "failedPage"?: string;
3624
3746
  /**
3625
3747
  * The page that users are redirected to when the verification succeeds.
3626
- * @uiName Next page path
3748
+ * @uiName Next Page Path
3627
3749
  */
3628
3750
  "nextPage"?: string;
3629
3751
  }
@@ -3691,16 +3813,19 @@ declare namespace LocalJSX {
3691
3813
  */
3692
3814
  "demoData"?: DemoData<ReferralIframeViewProps>;
3693
3815
  /**
3694
- * @uiName Height of the iframe container
3816
+ * Height of the iframe container
3817
+ * @uiName Iframe Height
3695
3818
  */
3696
3819
  "iframeHeight"?: string;
3697
3820
  /**
3698
- * @uiName URL of iframe to display
3699
- * @uiRequired
3821
+ * URL of iframe to display
3822
+ * @uiName Iframe Source
3823
+ * @required
3700
3824
  */
3701
3825
  "iframeSrc"?: string;
3702
3826
  /**
3703
- * @uiName Width of the iframe container
3827
+ * Width of the iframe container
3828
+ * @uiName Iframe Width
3704
3829
  */
3705
3830
  "iframeWidth"?: string;
3706
3831
  }
@@ -3712,7 +3837,7 @@ declare namespace LocalJSX {
3712
3837
  "demoData"?: DemoData<GenericTableViewProps>;
3713
3838
  /**
3714
3839
  * Provide the column numbers (0 indexed) that should not be displayed in mobile views. Ex. 0,2,3
3715
- * @uiName Mobile Hidden Columns
3840
+ * @uiName Hidden Mobile Columns
3716
3841
  */
3717
3842
  "hiddenColumns"?: string;
3718
3843
  /**
@@ -3720,15 +3845,16 @@ declare namespace LocalJSX {
3720
3845
  */
3721
3846
  "mdBreakpoint"?: number;
3722
3847
  /**
3723
- * @uiName View More button text
3848
+ * @uiName View More Button Text
3724
3849
  */
3725
3850
  "moreLabel"?: string;
3726
3851
  /**
3727
- * @uiName Number of referrals per page
3852
+ * Number of referrals displayed per page
3853
+ * @uiName Referrals Per Page
3728
3854
  */
3729
3855
  "perPage"?: number;
3730
3856
  /**
3731
- * @uiName Previous button text
3857
+ * @uiName Previous Button Text
3732
3858
  */
3733
3859
  "prevLabel"?: string;
3734
3860
  /**
@@ -3737,11 +3863,12 @@ declare namespace LocalJSX {
3737
3863
  */
3738
3864
  "programId"?: string;
3739
3865
  /**
3740
- * @uiName Show column labels
3866
+ * @uiName Show Column Labels
3741
3867
  */
3742
3868
  "showLabels"?: boolean;
3743
3869
  /**
3744
- * @uiName Show Referred by user in table
3870
+ * Show referred by user in table
3871
+ * @uiName Show Referrer
3745
3872
  */
3746
3873
  "showReferrer"?: boolean;
3747
3874
  /**
@@ -3843,7 +3970,8 @@ declare namespace LocalJSX {
3843
3970
  }
3844
3971
  interface SqmReferralTableUserColumn {
3845
3972
  /**
3846
- * @uiName Name displayed for anonymous users
3973
+ * Name displayed for unknown users
3974
+ * @uiName Anonymous User Text
3847
3975
  */
3848
3976
  "anonymousUser"?: string;
3849
3977
  /**
@@ -3851,7 +3979,8 @@ declare namespace LocalJSX {
3851
3979
  */
3852
3980
  "columnTitle"?: string;
3853
3981
  /**
3854
- * @uiName Name displayed for deleted users
3982
+ * Name displayed for deleted users
3983
+ * @uiName Deleted User Text
3855
3984
  */
3856
3985
  "deletedUser"?: string;
3857
3986
  }
@@ -3900,11 +4029,12 @@ declare namespace LocalJSX {
3900
4029
  */
3901
4030
  "doneText"?: string;
3902
4031
  /**
3903
- * @uiName Exchange button text
4032
+ * Error message shown when reward is not available
4033
+ * @uiName Not Available Error
3904
4034
  */
3905
4035
  "notAvailableError"?: string;
3906
4036
  /**
3907
- * @uiName Not Enough Available Error Message
4037
+ * @uiName Not Enough Error Message
3908
4038
  */
3909
4039
  "notEnoughError"?: string;
3910
4040
  /**
@@ -3959,7 +4089,7 @@ declare namespace LocalJSX {
3959
4089
  "selectText"?: string;
3960
4090
  /**
3961
4091
  * Set the number of placeholder cards to be shown in loading state.
3962
- * @undocumented Loading Cards
4092
+ * @uiName Loading Cards
3963
4093
  */
3964
4094
  "skeletonCardNum"?: number;
3965
4095
  /**
@@ -4054,7 +4184,7 @@ declare namespace LocalJSX {
4054
4184
  */
4055
4185
  "availableText"?: string;
4056
4186
  /**
4057
- * @uiName Reward column title
4187
+ * @uiName Reward Column Title
4058
4188
  */
4059
4189
  "columnTitle"?: string;
4060
4190
  /**
@@ -4077,7 +4207,8 @@ declare namespace LocalJSX {
4077
4207
  }
4078
4208
  interface SqmRewardsTableSourceColumn {
4079
4209
  /**
4080
- * @uiName Name displayed for anonymous users
4210
+ * Name displayed for unknown users
4211
+ * @uiName Anonymous User Text
4081
4212
  */
4082
4213
  "anonymousUser"?: string;
4083
4214
  /**
@@ -4085,7 +4216,8 @@ declare namespace LocalJSX {
4085
4216
  */
4086
4217
  "columnTitle"?: string;
4087
4218
  /**
4088
- * @uiName Name displayed for deleted users
4219
+ * Name displayed for deleted users
4220
+ * @uiName Deleted User Text
4089
4221
  */
4090
4222
  "deletedUser"?: string;
4091
4223
  /**
@@ -4094,7 +4226,7 @@ declare namespace LocalJSX {
4094
4226
  */
4095
4227
  "referralText"?: string;
4096
4228
  /**
4097
- * @uiName Reward Exchange label
4229
+ * @uiName Reward Exchange Label
4098
4230
  */
4099
4231
  "rewardExchangeText"?: string;
4100
4232
  /**
@@ -4141,7 +4273,7 @@ declare namespace LocalJSX {
4141
4273
  }
4142
4274
  interface SqmRoute {
4143
4275
  /**
4144
- * @uiName Navigation path name
4276
+ * @uiName Navigation Path Name
4145
4277
  */
4146
4278
  "path"?: string;
4147
4279
  }
@@ -4221,12 +4353,13 @@ declare namespace LocalJSX {
4221
4353
  }
4222
4354
  interface SqmShareButton {
4223
4355
  /**
4224
- * @uiName Button background color
4356
+ * @uiName Button Background Color
4225
4357
  * @uiWidget color
4226
4358
  */
4227
4359
  "backgroundcolor"?: string;
4228
4360
  /**
4229
- * @uiName Configure border radius with pixel amount
4361
+ * Configure border radius with pixel amount
4362
+ * @uiName Border Radius
4230
4363
  */
4231
4364
  "borderradius"?: number;
4232
4365
  /**
@@ -4239,16 +4372,16 @@ declare namespace LocalJSX {
4239
4372
  */
4240
4373
  "disabled"?: boolean;
4241
4374
  /**
4242
- * @uiName Hide the icon
4375
+ * @uiName Hide Icon
4243
4376
  */
4244
4377
  "hideicon"?: boolean;
4245
4378
  /**
4246
- * @uiName Hide the text
4379
+ * @uiName Hide Text
4247
4380
  */
4248
4381
  "hidetext"?: boolean;
4249
4382
  /**
4250
- * Options available at https://shoelace.style/components/icon
4251
- * @uiName Icon used in button. Will try to select an icon based on the share medium if left empty.
4383
+ * Options available at https://shoelace.style/components/icon Icon used in button. Will try to select an icon based on the share medium if left empty.
4384
+ * @uiName Icon
4252
4385
  */
4253
4386
  "icon"?: string;
4254
4387
  /**
@@ -4278,7 +4411,7 @@ declare namespace LocalJSX {
4278
4411
  | "reminder"
4279
4412
  | "unknown";
4280
4413
  /**
4281
- * @uiName Display as pill
4414
+ * @uiName Display Pill
4282
4415
  */
4283
4416
  "pill"?: boolean;
4284
4417
  /**
@@ -4287,11 +4420,13 @@ declare namespace LocalJSX {
4287
4420
  */
4288
4421
  "programId"?: string;
4289
4422
  /**
4290
- * @uiName Text used for native sharing (mobile only)
4423
+ * Text used for native sharing (mobile only)
4424
+ * @uiName Share Text
4291
4425
  */
4292
4426
  "sharetext"?: string;
4293
4427
  /**
4294
- * @uiName Title used for native sharing (mobile only)
4428
+ * Title used for native sharing (mobile only)
4429
+ * @uiName Share Title
4295
4430
  */
4296
4431
  "sharetitle"?: string;
4297
4432
  /**
@@ -4302,7 +4437,7 @@ declare namespace LocalJSX {
4302
4437
  */
4303
4438
  "size"?: "small" | "medium" | "large";
4304
4439
  /**
4305
- * @uiName Button text color
4440
+ * @uiName Button Text Color
4306
4441
  * @uiWidget color
4307
4442
  */
4308
4443
  "textcolor"?: string;
@@ -4337,8 +4472,8 @@ declare namespace LocalJSX {
4337
4472
  */
4338
4473
  "tooltiplifespan"?: number;
4339
4474
  /**
4340
- * This is shown after someone has successfully copied the cpde to the clipboard.
4341
- * @uiName Tooltip text
4475
+ * This is shown after someone has successfully copied the code to the clipboard.
4476
+ * @uiName Tooltip Text
4342
4477
  */
4343
4478
  "tooltiptext"?: string;
4344
4479
  }
@@ -4355,12 +4490,12 @@ declare namespace LocalJSX {
4355
4490
  "programId"?: string;
4356
4491
  /**
4357
4492
  * The number of milliseconds that the tooltip will appear for
4358
- * @uiName Tooltip lifespan
4493
+ * @uiName Tooltip Lifespan
4359
4494
  */
4360
4495
  "tooltiplifespan"?: number;
4361
4496
  /**
4362
4497
  * This is shown after someone has successfully copied the link to the clipboard.
4363
- * @uiName Tooltip text
4498
+ * @uiName Tooltip Text
4364
4499
  */
4365
4500
  "tooltiptext"?: string;
4366
4501
  }
@@ -4373,7 +4508,7 @@ declare namespace LocalJSX {
4373
4508
  */
4374
4509
  "display"?: "grid" | "flex";
4375
4510
  /**
4376
- * @uiName Space between stats
4511
+ * @uiName Space Between Stats
4377
4512
  * @uiType string
4378
4513
  * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
4379
4514
  * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
@@ -4408,19 +4543,23 @@ declare namespace LocalJSX {
4408
4543
  interface SqmTaskCard {
4409
4544
  /**
4410
4545
  * @uiName CTA Button Link
4546
+ * @uiGroup CTA Button
4411
4547
  */
4412
4548
  "buttonLink"?: string;
4413
4549
  /**
4414
4550
  * @uiName CTA Button Text
4551
+ * @uiGroup CTA Button
4415
4552
  */
4416
4553
  "buttonText"?: string;
4417
4554
  /**
4418
4555
  * @uiName Title Text
4556
+ * @uiGroup Task
4419
4557
  */
4420
4558
  "cardTitle"?: string;
4421
4559
  /**
4422
4560
  * Displays the amount of times that a user has completed a repeatable task.
4423
4561
  * @uiName Completed Count Text
4562
+ * @uiGroup Task
4424
4563
  */
4425
4564
  "completedText"?: string;
4426
4565
  /**
@@ -4430,88 +4569,108 @@ declare namespace LocalJSX {
4430
4569
  "demoData"?: DemoData<TaskCardViewProps | BigStatViewProps>;
4431
4570
  /**
4432
4571
  * @uiName Description Text
4572
+ * @uiGroup Task
4433
4573
  */
4434
4574
  "description"?: string;
4435
4575
  /**
4436
4576
  * Timeframe that the task card will be shown
4437
4577
  * @uiName Display Duration
4438
4578
  * @uiWidget DateRange
4439
- * @uiOptions {"allowPastDates":true, "months": 1}
4579
+ * @uiWidgetOptions {"allowPastDates":true, "months": 1}
4580
+ * @uiGroup Task
4440
4581
  */
4441
4582
  "displayDuration"?: string;
4442
4583
  /**
4443
4584
  * Shown to users after the end of the task duration.
4444
4585
  * @uiName Ended Date Message
4586
+ * @uiGroup Task
4445
4587
  */
4446
4588
  "endedMessage"?: string;
4447
4589
  /**
4448
4590
  * Optionally send an event to SaaSquatch when a user clicks the CTA. This field configured what key of the event sent is.
4449
- * @uiName Event key of task card button
4591
+ * @uiName Task Card Button Event Key
4592
+ * @uiGroup CTA Button
4450
4593
  */
4451
4594
  "eventKey"?: string;
4452
4595
  /**
4453
4596
  * @uiName Expiry Date Message
4597
+ * @uiGroup Task
4454
4598
  */
4455
4599
  "expiryMessage"?: string;
4456
4600
  /**
4457
4601
  * The number of times a reward can be earned. Use zero for no limit (the default).
4458
4602
  * @uiName Repeat Amount
4603
+ * @uiGroup Reward
4459
4604
  */
4460
4605
  "finite"?: number;
4461
4606
  /**
4462
4607
  * Sets the goal for users progress to know when a task has been completed. If repeatable is checked, repeatable goals is an increment of this.
4463
4608
  * @uiName Goal Completion Number
4609
+ * @uiGroup Goal
4464
4610
  */
4465
4611
  "goal"?: number;
4466
4612
  /**
4467
- * @uiName CTA Button Link Open in New Tab
4613
+ * CTA Button Link Opens in New Tab
4614
+ * @uiName Open In New Tab
4615
+ * @uiGroup CTA Button
4616
+ * @default undefined
4468
4617
  */
4469
4618
  "openNewTab"?: boolean;
4470
4619
  /**
4471
4620
  * The ID of the program that is used to scope the task card. Defaults to the program context when no ID is specified.
4472
- * @uiName Program ID override
4621
+ * @uiName Program ID Override
4622
+ * @uiGroup Goal
4473
4623
  */
4474
4624
  "programId"?: string;
4475
4625
  /**
4476
4626
  * @uiName Progress Bar Unit
4627
+ * @uiGroup Goal
4477
4628
  */
4478
4629
  "progressBarUnit"?: string;
4479
4630
  /**
4480
4631
  * @uiName Goal Repeatable
4632
+ * @uiGroup Goal
4481
4633
  */
4482
4634
  "repeatable"?: boolean;
4483
4635
  /**
4484
4636
  * @uiName Reward Amount
4637
+ * @uiGroup Reward
4485
4638
  */
4486
4639
  "rewardAmount"?: string;
4487
4640
  /**
4488
4641
  * @uiName Reward Duration
4489
4642
  * @uiWidget DateRange
4490
- * @uiOptions {"allowPastDates":true, "months": 1}
4643
+ * @uiWidgetOptions {"allowPastDates":true, "months": 1}
4644
+ * @uiGroup Reward
4491
4645
  */
4492
4646
  "rewardDuration"?: string;
4493
4647
  /**
4494
4648
  * @uiName Reward Unit
4649
+ * @uiGroup Reward
4495
4650
  */
4496
4651
  "rewardUnit"?: string;
4497
4652
  /**
4498
4653
  * @uiName Show Progress Bar
4654
+ * @uiGroup Goal
4499
4655
  */
4500
4656
  "showProgressBar"?: boolean;
4501
4657
  /**
4502
4658
  * Shown to users before the start of the task duration.
4503
4659
  * @uiName Start Date Message
4660
+ * @uiGroup Task
4504
4661
  */
4505
4662
  "startsOnMessage"?: string;
4506
4663
  /**
4507
4664
  * Select what type of stat to display for the goal. Manual paths are also supported.
4508
4665
  * @uiWidget StatTypeSelectWidget
4509
4666
  * @uiName Goal Progress Source
4510
- * @uiOptions {"version": 1.1}
4667
+ * @uiWidgetOptions {"version": 1.1}
4668
+ * @uiGroup Goal
4511
4669
  */
4512
4670
  "statType"?: string;
4513
4671
  /**
4514
4672
  * @uiName Progress Bar Steps
4673
+ * @uiGroup Goal
4515
4674
  */
4516
4675
  "steps"?: boolean;
4517
4676
  }
@@ -4523,7 +4682,7 @@ declare namespace LocalJSX {
4523
4682
  */
4524
4683
  "text"?: string;
4525
4684
  /**
4526
- * @uiName Text
4685
+ * @uiName Type
4527
4686
  * @uiType string
4528
4687
  * @uiEnum ["p", "subtext", "h1", "h2", "h3", "h4"]
4529
4688
  * @uiEnumNames ["Paragraph", "Subtext", "Header 1", "Header 2", "Header 3", "Header 4"]
@@ -4567,14 +4726,14 @@ declare namespace LocalJSX {
4567
4726
  */
4568
4727
  "label"?: string;
4569
4728
  /**
4570
- * @uiName Label margin style
4729
+ * @uiName Label Margin Style
4571
4730
  * @uiType string
4572
4731
  * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
4573
4732
  * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
4574
4733
  */
4575
4734
  "labelMargin"?: Spacing;
4576
4735
  /**
4577
- * @uiName Section padding
4736
+ * @uiName Section Padding
4578
4737
  * @uiType string
4579
4738
  * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
4580
4739
  * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
@@ -4595,11 +4754,12 @@ declare namespace LocalJSX {
4595
4754
  */
4596
4755
  "demoData"?: DemoData<UserNameViewProps>;
4597
4756
  /**
4598
- * @uiName Fallback name for nameless users
4757
+ * Fallback name for unknown users
4758
+ * @uiName Fallback Name
4599
4759
  */
4600
4760
  "fallback"?: string;
4601
4761
  /**
4602
- * @uiName Loading text
4762
+ * @uiName Loading Text
4603
4763
  */
4604
4764
  "loadingText"?: string;
4605
4765
  }