-
Notifications
You must be signed in to change notification settings - Fork 1
/
components.d.ts
6747 lines (6747 loc) · 228 KB
/
components.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* eslint-disable */
/* tslint:disable */
/**
* This is an autogenerated file created by the Stencil compiler.
* It contains typing information for all components that exist in this project.
*/
import { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
import { DemoData } from "./global/demo";
import { AssetCardViewProps } from "./components/sqm-asset-card/sqm-asset-card-view";
import { BigStatViewProps } from "./components/sqm-big-stat/sqm-big-stat-view";
import { UserNameViewProps } from "./components/tax-and-cash/sqm-tax-and-cash/sqm-tax-and-cash-view";
import { CheckboxFieldViewProps } from "./components/sqm-checkbox-field/sqm-checkbox-field-view";
import { CouponCodeViewProps } from "./components/sqm-coupon-code/sqm-coupon-code-view";
import { TaxFormStepTwoProps } from "./components/tax-and-cash/sqm-tax-form/sqm-tax-form-step-2-view";
import { DropdownFieldViewProps } from "./components/sqm-dropdown-field/sqm-dropdown-field-view";
import { EditProfileViewProps } from "./components/sqm-edit-profile/sqm-edit-profile-view";
import { Spacing } from "./global/mixins";
import { FunctionalComponent } from "@stencil/core";
import { InputFieldViewProps } from "./components/sqm-input-field/sqm-input-field-view";
import { EmailRegistrationViewProps } from "./components/views/email-registration-view";
import { LeaderboardViewProps } from "./components/sqm-leaderboard/sqm-leaderboard-view";
import { LeaderboardRankViewProps } from "./components/sqm-leaderboard-rank/sqm-leaderboard-rank-view";
import { CopyTextViewProps } from "./components/views/copy-text-view";
import { NameFieldsViewProps } from "./components/sqm-name-fields/sqm-name-fields-view";
import { NavigationMenuViewProps } from "./components/sqm-navigation-menu/sqm-navigation-menu-view";
import { NavigationSidebarItemViewProps } from "./components/sqm-navigation-sidebar-item/sqm-navigation-sidebar-item-view";
import { PasswordFieldViewDemoProps } from "./components/sqm-password-field/sqm-password-field";
import { PortalChangePasswordViewProps } from "./components/sqm-portal-change-password/sqm-portal-change-password-view";
import { PortalEmailVerificationViewProps } from "./components/sqm-portal-email-verification/sqm-portal-email-verification-view";
import { PortalForgotPasswordViewProps } from "./components/sqm-portal-forgot-password/sqm-portal-forgot-password-view";
import { PortalFrameViewProps } from "./components/sqm-portal-frame/sqm-portal-frame-view";
import { PortalLoginViewProps } from "./components/sqm-portal-login/sqm-portal-login-view";
import { PortalProfileViewProps } from "./components/sqm-portal-profile/sqm-portal-profile-view";
import { PortalRegisterViewProps } from "./components/sqm-portal-register/sqm-portal-register-view";
import { PortalRegistrationFormViewProps } from "./components/sqm-portal-registration-form/sqm-portal-registration-form-view";
import { PortalResetPasswordViewProps } from "./components/sqm-portal-reset-password/sqm-portal-reset-password-view";
import { PortalVerifyEmailViewProps } from "./components/sqm-portal-verify-email/sqm-portal-verify-email-view";
import { ReferralIframeViewProps } from "./components/sqm-referral-iframe/sqm-referral-iframe-view";
import { GenericTableViewProps } from "./tables/GenericTableView";
import { ReferralDates } from "./components/sqm-referral-table/useReferralTable";
import { RewardExchangeViewProps } from "./components/sqm-reward-exchange-list/sqm-reward-exchange-list-view";
import { ShareButtonViewProps } from "./components/sqm-share-button/sqm-share-button-view";
import { TaskCardViewProps } from "./components/sqm-task-card/sqm-task-card-view";
import { UserNameViewProps as UserNameViewProps1 } from "./components/sqm-user-name/sqm-user-name-view";
export namespace Components {
interface RaisinsPlopTarget {
"renderCell": () => Promise<any>;
"renderLabel": (idx: any) => Promise<any>;
}
interface SqmAssetCard {
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<AssetCardViewProps>;
/**
* @uiName Banner image
*/
"imgUrl": string;
/**
* @uiName Banner title
*/
"titleText": string;
}
interface SqmBigStat {
/**
* Controls the alignment of the flexbox
* @uiName Alignment
* @uiType string
* @uiEnum ["left", "right", "center"]
* @uiEnumNames ["Left", "Right", "Center"]
*/
"alignment"?: "left" | "right" | "center";
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<BigStatViewProps>;
/**
* Controls the order of the stat value & description column
* @uiName Flex reverse
* @default
*/
"flexReverse"?: boolean;
/**
* The ID of the program that is used to scope stats. Defaults to the program context when no ID is specified.
* @uiName Program ID
* @uiWidget programSelector
*/
"programId"?: string;
/**
* Select what type of stat to display. Manual paths are also supported.
* @uiWidget statTypeSelectWidget
* @uiName Stat type
* @required
* @uiWidgetOptions {"version": 1.1}
*/
"statType": string;
}
interface SqmBrand {
/**
* Controls the primary brand color used in the Mint Components library.
* @uiName Brand color
* @uiWidget color
* @format color
*/
"brandColor": string;
/**
* Enter a font from the Google Fonts library to use throughout your widget. This value is case sensitive. Some fonts may not require quotations. Example: Roboto
* @uiName Brand font
* @default "Nunito Sans"
*/
"brandFont": string;
}
interface SqmCardFeed {
/**
* @uiName Column gap
* @uiType number
*/
"gap": number;
/**
* @uiName Card width
*/
"width": number;
}
interface SqmCashForm {
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<UserNameViewProps>;
}
interface SqmCheckboxField {
/**
* @uiName Checkbox label
* @uiWidget textArea
*/
"checkboxLabel": string;
/**
* Used with link text if the checkbox label contains {labelLink}
* @uiName Checkbox label link
*/
"checkboxLabelLink": string;
/**
* @uiName Checkbox label link lext
*/
"checkboxLabelLinkText": string;
/**
* This name is used as the key for this form field on submission. The name must be unique within this specific form.
* @uiName Checkbox name attribute
* @required
*/
"checkboxName": string;
/**
* @uiName Optional
*/
"checkboxOptional"?: boolean;
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<CheckboxFieldViewProps>;
/**
* @uiName Unchecked error message
*/
"errorMessage": string;
}
interface SqmCloseButton {
/**
* @uiName Color
* @uiWidget color
* @uiType string
*/
"color": string;
}
interface SqmContextRouter {
"contextName": string;
}
interface SqmCouponCode {
/**
* Set the copy button style and placement.
* @uiName Style
* @uiType string
* @uiEnum ["icon", "button-outside", "button-below"]
* @uiEnumNames ["Icon", "Button outside", "Button below"]
*/
"buttonStyle"?: "icon" | "button-outside" | "button-below";
/**
* Display this message when the coupon code has been cancelled.
* @uiWidget textArea
* @uiName Cancelled code error message
* @uiGroup Coupon code error
*/
"cancelledErrorText": string;
/**
* @uiName Copy button label
*/
"copyButtonLabel": string;
/**
* @uiName Coupon code label
*/
"couponCodeLabel": string;
/**
* Display this text when the coupon code can’t be retrieved.
* @uiName Coupon code placeholder
* @uiGroup Coupon code error
*/
"couponCodePlaceholder": string;
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<CouponCodeViewProps>;
/**
* Display this message when the coupon code has expired.
* @uiWidget textArea
* @uiName Expired code error message
* @uiGroup Coupon code error
*/
"expiredErrorText": string;
/**
* Display this message when the code fails to load due to a fulfillment error.
* @uiWidget textArea
* @uiName Code fulfillment error message
* @uiGroup Coupon code error
*/
"fullfillmentErrorText": string;
/**
* Display this message when the code fails to load due to an unspecified error.
* @uiWidget textArea
* @uiName Code retrieval error message
* @uiGroup Coupon code error
*/
"genericErrorText": string;
/**
* Display this message when the coupon code not available yet. Use the ICU message, {unpendDate}, to show the date the code will be available.
* @uiWidget textArea
* @uiName Code pending error message
* @uiGroup Coupon code error
*/
"pendingErrorText": string;
/**
* The ID of the program that should generate the code. Defaults to the program ID in context where this widget is loaded.
* @uiName Program ID
* @uiWidget programSelector
*/
"programId"?: string;
/**
* Display this message when the coupon code has already been redeemed.
* @uiWidget textArea
* @uiName Redeemed code error message
* @uiGroup Coupon code error
*/
"redeemedErrorText": string;
/**
* @uiName Coupon code alignment
* @uiType string
* @uiEnum ["left", "center", "right"]
* @uiEnumNames ["Left", "Center", "Right"]
*/
"textAlign"?: "left" | "center" | "right";
/**
* The number of milliseconds that the tooltip appears for
* @uiName Tooltip lifespan
*/
"tooltiplifespan": number;
/**
* Shown inside a tooltip after someone has successfully copied the link to their clipboard.
* @uiName Tooltip text
*/
"tooltiptext": string;
}
interface SqmDividedLayout {
/**
* @uiName Direction
* @uiType string
* @uiEnum ["row", "column"]
* @uiEnumNames ["Row", "Column"]
*/
"direction": "row" | "column";
/**
* Uses Shorthand CSS border syntax allowing specification of thickness, fill style and color.
* @uiName Border style
*/
"dividerStyle": string;
}
interface SqmDocusignEmbed {
}
interface SqmDocusignForm {
"backButton": string;
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<TaxFormStepTwoProps>;
"submitButton": string;
"w8": string;
"w8e": string;
"w9": string;
}
interface SqmDropdownField {
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<DropdownFieldViewProps>;
/**
* @uiName Dropdown label
*/
"dropdownLabel": string;
/**
* This name is used as the key for this form field on submission. The name must be unique within this specific form.
* @uiName Dropdown name attribute
* @required
*/
"dropdownName": string;
/**
* @uiName Optional
* @default
*/
"dropdownOptional"?: boolean;
/**
* @uiName Unselected error message
*/
"errorMessage": string;
}
interface SqmEditProfile {
/**
* @uiName Cancel button text
*/
"canceltext": string;
/**
* @uiName Region field label
*/
"currentregiontext": string;
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<EditProfileViewProps>;
/**
* @uiName Heading
*/
"editprofileheader": string;
/**
* Enable editing button text
* @uiName Edit profile text
*/
"editprofiletext": string;
/**
* @uiName First name label
*/
"firstnametext": string;
/**
* @uiName Last name label
*/
"lastnametext": string;
/**
* Show or hide current region
* @uiName Show region
*/
"showregion": boolean;
/**
* @uiName Info button text
*/
"updatetext": string;
}
interface SqmEmpty {
/**
* @uiName Title
*/
"emptyStateHeader": string;
/**
* @uiWidget ImageUpload
* @format url
* @uiName Image
*/
"emptyStateImage": string;
/**
* @uiName Description
* @uiWidget textArea
*/
"emptyStateText": string;
}
interface SqmFormMessage {
/**
* Icon to use in alert. Use icon values from Shoelace (e.g. "star" or "heart") at https://shoelace.style/components/icon
* @uiName Icon
*/
"icon"?: string;
/**
* Options include "success", "info", "warning", and "error"
* @uiName Alert type
*/
"type": string;
}
interface SqmGraphqlClientProvider {
/**
* @uiName Domain
*/
"domain": string;
}
interface SqmHeaderLogo {
/**
* @uiName Logo height
*/
"height": number;
/**
* @uiWidget ImageUpload
* @format url
* @uiName Logo image
*/
"imageUrl": string;
/**
* Page participants are navigated to after clicking the header logo.
* @uiName Redirect path
* @uiWidget pageSelect
*/
"nextPage": string;
}
interface SqmHero {
/**
* Can be an image url, colour or Shoelace variable.
* @uiName Background
* @uiWidget Background
*/
"background"?: string;
/**
* @uiName Columns
* @uiEnum [1, 2]
* @uiEnumNames ["One", "Two"]
*/
"columns": 1 | 2;
/**
* Minimum height of each column including when they are stacked on mobile
* @uiName Minimum height (in px)
*/
"minHeight": number;
/**
* @uiName Padding size
* @uiEnum ["none", "small", "medium","large"]
* @uiEnumNames ["None", "Small", "Medium", "Large"]
*/
"paddingSize": "none" | "small" | "medium" | "large";
/**
* Secondary background image or color (for use in the right column)
* @uiName Secondary background
* @uiWidget Background
*/
"secondaryBackground"?: string;
/**
* Flexbox wrap direction, accepts wrap or wrap-reverse
* @uiName Wrap direction
* @uiEnum ["wrap", "wrap-reverse"]
* @uiEnumNames ["Wrap", "Wrap Reverse"]
*/
"wrapDirection": "wrap" | "wrap-reverse";
}
interface SqmHeroImage {
/**
* @uiName Background color
* @uiWidget color
* @format color
*/
"backgroundColor"?: string;
/**
* @uiName Button link
*/
"buttonLink"?: string;
/**
* @uiName Open link in new tab
* @default
*/
"buttonNewTab"?: boolean;
/**
* @uiName Button text
*/
"buttonText"?: string;
/**
* @uiName Description
* @uiWidget textArea
*/
"description"?: string;
/**
* @uiName Title
*/
"header"?: string;
/**
* @uiName Image mobile position
* @uiType string
* @uiEnum ["top", "bottom"]
* @uiEnumNames ["Top", "Bottom"]
*/
"imageMobilePos": "top" | "bottom";
/**
* @uiName Image percentage
* @uiType number
*/
"imagePercentage": number;
/**
* @uiName Image position
* @uiType string
* @uiEnum ["left", "center", "right"]
* @uiEnumNames ["Left", "Center", "Right"]
*/
"imagePos": "left" | "center" | "right";
/**
* @uiWidget ImageUpload
* @format url
* @uiName Image
*/
"imageUrl": string;
/**
* @uiName Image layout
* @uiType string
* @uiEnum ["overlay", "columns"]
* @uiEnumNames ["Overlay", "Two-column"]
*/
"layout": "overlay" | "columns";
/**
* @uiName Overlay color
* @uiWidget color
* @format color
*/
"overlayColor"?: string;
/**
* @uiName Overlay opacity
*/
"overlayOpacity": string;
/**
* @uiName Image padding
* @uiType string
* @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
* @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
*/
"paddingImage": Spacing;
/**
* @uiName Text padding
* @uiType string
* @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
* @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
*/
"paddingText": Spacing;
/**
* @uiName Text color
* @uiWidget color
* @format color
*/
"textColor"?: string;
}
interface SqmHookStoryContainer {
"hookStory": FunctionalComponent;
}
interface SqmImage {
/**
* @uiName Position alignment
* @uiType string
* @uiEnum ["left", "center", "right"]
* @uiEnumNames ["Left", "Center", "Right"]
*/
"alignment": "left" | "center" | "right";
/**
* @uiName Background color
* @uiWidget color
* @format color
*/
"backgroundColor": string;
/**
* @uiWidget ImageUpload
* @format url
* @required
* @uiName Image link
*/
"imageUrl": string;
/**
* (Optional) Helps with constraining the minimum image size. Can be a pixel value or a percentage i.e. "500px", "33%", etc.
* @uiName Minimum height
*/
"minHeight"?: string;
}
interface SqmInputField {
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<InputFieldViewProps>;
/**
* @uiName Required error message
*/
"errorMessage": string;
/**
* @uiName Input label
*/
"fieldLabel": string;
/**
* This name is used as the key for this form field on submission. The name must be unique within this specific form.
* @uiName Input name attribute
* @required
*/
"fieldName": string;
/**
* @uiName Optional
* @default
*/
"fieldOptional"?: boolean;
/**
* @uiName Input type
* @uiType string
* @uiEnum ["text", "date", "tel"]
* @uiEnumNames ["Text", "Date", "Phone Number"]
*/
"fieldType": "text" | "date" | "tel";
}
interface SqmInstantAccessRegistration {
/**
* @uiName Background color
* @uiWidget color
* @uiGroup Card style
* @uiType string
*/
"backgroundColor": string;
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<EmailRegistrationViewProps>;
/**
* @uiName Email field label
*/
"emailLabel": string;
/**
* @uiName First name field label
*/
"firstNameLabel": string;
/**
* @uiName Hide border
* @uiGroup Card style
*/
"hideBorder": boolean;
/**
* @undocumented
* @uiType boolean
*/
"includeCookies"?: boolean;
/**
* Require your participants to enter their first and last name.
* @uiName Include name fields
*/
"includeName": boolean;
/**
* Display this message when the given email is invalid.
* @uiName Invalid email message
* @uiWidget textArea
* @uiGroup Error messages
*/
"invalidEmailErrorMessage": string;
/**
* @uiName Last name field label
*/
"lastNameLabel": string;
/**
* Display this message when the form submission unexpectedly fails.
* @uiName Network error message
* @uiWidget textArea
* @uiGroup Error messages
*/
"networkErrorMessage": string;
/**
* @uiName Bottom padding
* @uiGroup Card style
* @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
* @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
*/
"paddingBottom": string;
/**
* @uiName Left padding
* @uiGroup Card style
* @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
* @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
*/
"paddingLeft": string;
/**
* @uiName Right padding
* @uiGroup Card style
* @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
* @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
*/
"paddingRight": string;
/**
* @uiName Top padding
* @uiGroup Card style
* @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
* @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
*/
"paddingTop": string;
/**
* @uiName Register button text
*/
"registerLabel": string;
/**
* Display this message when a required field has not been filled out.
* @uiName Required field message
* @uiWidget textArea
* @uiGroup Error messages
*/
"requiredFieldErrorMessage": string;
}
interface SqmLeaderboard {
/**
* Title displayed for users without names
* @uiName Unknown user text
*/
"anonymousUser": string;
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<LeaderboardViewProps>;
/**
* Hide the viewer's leaderboard row if not in the top results.
* @uiName Hide viewing user
* @default
*/
"hideViewer": boolean;
/**
* @uiName Leaderboard time interval
* @uiWidget dateRange
* @uiWidgetOptions {"allowPastDates":true, "months": 1}
*/
"interval": string;
/**
* @uiName Leaderboard type
* @uiType string
* @required
* @uiEnum ["topStartedReferrers", "topConvertedReferrers", "topPointEarners"]
* @uiEnumNames ["Top Started Referrers", "Top Converted Referrers", "Top Point Earners"]
*/
"leaderboardType": | "topStartedReferrers"
| "topConvertedReferrers"
| "topPointEarners";
/**
* Control the maximum amount of rows displayed on the leaderboard.
* @uiName Maximum rows number
*/
"maxRows": number;
/**
* Filters leaderboard to show only data from this program. Defaults to the program context where this leaderboard is. If no program ID is set or provided by context, then a global leaderboard is shown.
* @uiName Program
* @uiWidget programSelector
*/
"programId"?: string;
/**
* @uiName Rank type
* @uiType string
* @uiEnum ["rowNumber", "rank", "denseRank"]
* @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
*/
"rankType": "rowNumber" | "rank" | "denseRank";
/**
* @uiName Rank column heading
*/
"rankheading"?: string;
/**
* @uiName Show leaderboard rank
*/
"showRank": boolean;
/**
* @uiName Stats column heading
*/
"statsheading": string;
/**
* @uiName User column heading
*/
"usersheading": string;
}
interface SqmLeaderboardRank {
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<LeaderboardRankViewProps>;
/**
* @uiName Leaderboard time interval
* @uiWidget dateRange
* @uiWidgetOptions {"allowPastDates":true, "months": 1}
*/
"interval": string;
/**
* @uiName Leaderboard type
* @uiType string
* @required
* @uiEnum ["topStartedReferrers", "topConvertedReferrers", "topPointEarners"]
* @uiEnumNames ["Top Started Referrers", "Top Converted Referrers", "Top Point Earners"]
*/
"leaderboardType": | "topStartedReferrers"
| "topConvertedReferrers"
| "topPointEarners";
/**
* Filters leaderboard to show only data from this program. Defaults to the program context where this leaderboard is. If no program ID is set or provided by context, then a global leaderboard is shown.
* @uiName Program
* @uiWidget programSelector
*/
"programId"?: string;
/**
* @uiName Rank text
* @uiWidget textArea
*/
"rankText": string;
/**
* @uiName Default rank
* @uiType string
* @uiEnum ["rowNumber", "rank", "denseRank"]
* @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
*/
"rankType": "rowNumber" | "rank" | "denseRank";
/**
* @uiName Unranked text
*/
"unrankedText": string;
}
interface SqmLinkButton {
/**
* @uiName Button text
* @uiType string
*/
"buttonText"?: string;
/**
* Enter the URL where you want your participants redirected. Example: https://www.example.com
* @required
* @uiName Link
*/
"link": string;
/**
* @uiName Open link in new tab
*/
"openInNewTab": boolean;
}
interface SqmLogoutCurrentUser {
/**
* @required
* @uiName Switch user button link
*/
"demoData"?: DemoData<CopyTextViewProps>;
/**
* @required
* @uiName Switch user button label
*/
"switchUserText": string;
/**
* @required
* @uiName User identification text
*/
"userIdentificationText": string;
}
interface SqmNameFields {
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<NameFieldsViewProps>;
/**
* @uiName First name label
*/
"firstNameLabel": string;
/**
* @uiName Last name label
*/
"lastNameLabel": string;
}
interface SqmNavigationMenu {
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<NavigationMenuViewProps>;
/**
* @uiName Include dropdown menu
*/
"includeDropdown": boolean;
/**
* Label on the header menu
* @uiName Menu label
*/
"menuLabel": string;
}
interface SqmNavigationSidebar {
}
interface SqmNavigationSidebarItem {
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<NavigationSidebarItemViewProps>;
/**
* Options available at https://shoelace.style/components/icon
* @uiName Icon
*/
"icon": string;
/**
* @uiName Label
*/
"label": string;
/**
* @uiName Navigation path
* @uiWidget pageSelect
*/
"path": string;
}
interface SqmPasswordField {
/**
* @undocumented
* @uiType object
*/
"demoData"?: PasswordFieldViewDemoProps;
/**
* Disable live password validation
* @uiName Disable validation
*/
"disableValidation": boolean;
/**
* Label for password field
* @uiName Password label
*/
"fieldLabel": string;
}
interface SqmPopupContainer {
/**
* Display a close button on the popup
* @uiName Show close button
*/
"closeButton": boolean;
/**
* Text inside the close button
* @uiName Close button text
*/
"closeButtonText": string;
/**
* Specify padding on the popup contents when in embedded mode
* @uiName Embed padding
* @uiType string
* @uiEnum ["none", "small", "medium", "large"]
* @uiEnumNames ["None", "Small", "Medium", "Large"]
*/
"embedPadding"?: "none" | "small" | "medium" | "large";
/**
* Specify padding on the popup contents when in popup mode
* @uiName Popup padding
* @uiType string
* @uiEnum ["none", "small", "medium", "large"]
* @uiEnumNames ["None", "Small", "Medium", "Large"]
*/
"popupPadding"?: "none" | "small" | "medium" | "large";
/**
* Show Powered with SaaSquatch by Impact.com link
* @uiName Show powered by
*/
"poweredBy": boolean;
}
interface SqmPortalChangePassword {
/**
* Found in modal
* @uiName Cancel button text
*/
"cancelText": string;
/**
* Found in modal
* @uiName Change password button text
*/
"changePasswordButtonText": string;
/**
* Found in modal
* @uiName Confirm password Label
*/
"confirmPasswordFieldLabel": string;
/**
* @undocumented
* @uiType object
*/
"demoData"?: DemoData<PortalChangePasswordViewProps>;
/**
* @uiName Change password modal header
*/
"modalChangePasswordHeader": string;
/**
* Found in modal
* @uiName New password field label
*/
"passwordFieldLabel": string;
/**
* @uiName Change password button text
*/
"portalChangePasswordButtonText": string;
/**
* Portal change password section header
* @uiName Change password header
*/
"portalChangePasswordHeader": string;
/**
* Successful password change message
* @uiName Successful password change message