@genesislcap/foundation-ui 14.125.1 → 14.126.0

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.
@@ -777,6 +777,47 @@
777
777
  }
778
778
  ]
779
779
  },
780
+ {
781
+ "kind": "javascript-module",
782
+ "path": "src/_common/icons.ts",
783
+ "declarations": [
784
+ {
785
+ "kind": "function",
786
+ "name": "closeIcon",
787
+ "parameters": [
788
+ {
789
+ "name": "slot",
790
+ "default": "'start'"
791
+ }
792
+ ]
793
+ }
794
+ ],
795
+ "exports": [
796
+ {
797
+ "kind": "js",
798
+ "name": "closeIcon",
799
+ "declaration": {
800
+ "name": "closeIcon",
801
+ "module": "src/_common/icons.ts"
802
+ }
803
+ }
804
+ ]
805
+ },
806
+ {
807
+ "kind": "javascript-module",
808
+ "path": "src/_common/index.ts",
809
+ "declarations": [],
810
+ "exports": [
811
+ {
812
+ "kind": "js",
813
+ "name": "*",
814
+ "declaration": {
815
+ "name": "*",
816
+ "package": "./icons"
817
+ }
818
+ }
819
+ ]
820
+ },
780
821
  {
781
822
  "kind": "javascript-module",
782
823
  "path": "src/_config/index.ts",
@@ -810,15 +851,28 @@
810
851
  },
811
852
  {
812
853
  "kind": "javascript-module",
813
- "path": "src/_common/icons.ts",
854
+ "path": "src/accordion/accordion.styles.ts",
814
855
  "declarations": [
815
856
  {
816
857
  "kind": "function",
817
- "name": "closeIcon",
858
+ "name": "foundationAccordionStyles",
859
+ "return": {
860
+ "type": {
861
+ "text": "ElementStyles"
862
+ }
863
+ },
818
864
  "parameters": [
819
865
  {
820
- "name": "slot",
821
- "default": "'start'"
866
+ "name": "context",
867
+ "type": {
868
+ "text": "ElementDefinitionContext"
869
+ }
870
+ },
871
+ {
872
+ "name": "definition",
873
+ "type": {
874
+ "text": "FoundationElementDefinition"
875
+ }
822
876
  }
823
877
  ]
824
878
  }
@@ -826,17 +880,129 @@
826
880
  "exports": [
827
881
  {
828
882
  "kind": "js",
829
- "name": "closeIcon",
883
+ "name": "foundationAccordionStyles",
830
884
  "declaration": {
831
- "name": "closeIcon",
832
- "module": "src/_common/icons.ts"
885
+ "name": "foundationAccordionStyles",
886
+ "module": "src/accordion/accordion.styles.ts"
833
887
  }
834
888
  }
835
889
  ]
836
890
  },
837
891
  {
838
892
  "kind": "javascript-module",
839
- "path": "src/_common/index.ts",
893
+ "path": "src/accordion/accordion.template.ts",
894
+ "declarations": [
895
+ {
896
+ "kind": "function",
897
+ "name": "foundationAccordionTemplate",
898
+ "return": {
899
+ "type": {
900
+ "text": "ViewTemplate<Accordion>"
901
+ }
902
+ },
903
+ "parameters": [
904
+ {
905
+ "name": "context",
906
+ "type": {
907
+ "text": "ElementDefinitionContext"
908
+ }
909
+ },
910
+ {
911
+ "name": "definition",
912
+ "type": {
913
+ "text": "FoundationElementDefinition"
914
+ }
915
+ }
916
+ ]
917
+ }
918
+ ],
919
+ "exports": [
920
+ {
921
+ "kind": "js",
922
+ "name": "foundationAccordionTemplate",
923
+ "declaration": {
924
+ "name": "foundationAccordionTemplate",
925
+ "module": "src/accordion/accordion.template.ts"
926
+ }
927
+ }
928
+ ]
929
+ },
930
+ {
931
+ "kind": "javascript-module",
932
+ "path": "src/accordion/accordion.ts",
933
+ "declarations": [
934
+ {
935
+ "kind": "class",
936
+ "description": "",
937
+ "name": "Accordion",
938
+ "superclass": {
939
+ "name": "FASTAccordion",
940
+ "package": "@microsoft/fast-foundation"
941
+ },
942
+ "tagName": "%%prefix%%-accordion",
943
+ "customElement": true
944
+ },
945
+ {
946
+ "kind": "variable",
947
+ "name": "foundationAccordionShadowOptions",
948
+ "type": {
949
+ "text": "ShadowRootInit"
950
+ },
951
+ "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
952
+ },
953
+ {
954
+ "kind": "variable",
955
+ "name": "defaultAccordionConfig",
956
+ "type": {
957
+ "text": "object"
958
+ },
959
+ "default": "{}"
960
+ },
961
+ {
962
+ "kind": "variable",
963
+ "name": "foundationAccordion",
964
+ "description": "The Foundation Accordion",
965
+ "privacy": "public"
966
+ }
967
+ ],
968
+ "exports": [
969
+ {
970
+ "kind": "js",
971
+ "name": "Accordion",
972
+ "declaration": {
973
+ "name": "Accordion",
974
+ "module": "src/accordion/accordion.ts"
975
+ }
976
+ },
977
+ {
978
+ "kind": "js",
979
+ "name": "foundationAccordionShadowOptions",
980
+ "declaration": {
981
+ "name": "foundationAccordionShadowOptions",
982
+ "module": "src/accordion/accordion.ts"
983
+ }
984
+ },
985
+ {
986
+ "kind": "js",
987
+ "name": "defaultAccordionConfig",
988
+ "declaration": {
989
+ "name": "defaultAccordionConfig",
990
+ "module": "src/accordion/accordion.ts"
991
+ }
992
+ },
993
+ {
994
+ "kind": "js",
995
+ "name": "foundationAccordion",
996
+ "declaration": {
997
+ "name": "foundationAccordion",
998
+ "module": "src/accordion/accordion.ts"
999
+ }
1000
+ }
1001
+ ]
1002
+ },
1003
+ {
1004
+ "kind": "javascript-module",
1005
+ "path": "src/accordion/index.ts",
840
1006
  "declarations": [],
841
1007
  "exports": [
842
1008
  {
@@ -844,7 +1010,23 @@
844
1010
  "name": "*",
845
1011
  "declaration": {
846
1012
  "name": "*",
847
- "package": "./icons"
1013
+ "package": "./accordion.template"
1014
+ }
1015
+ },
1016
+ {
1017
+ "kind": "js",
1018
+ "name": "*",
1019
+ "declaration": {
1020
+ "name": "*",
1021
+ "package": "./accordion.styles"
1022
+ }
1023
+ },
1024
+ {
1025
+ "kind": "js",
1026
+ "name": "*",
1027
+ "declaration": {
1028
+ "name": "*",
1029
+ "package": "./accordion"
848
1030
  }
849
1031
  }
850
1032
  ]
@@ -3914,11 +4096,11 @@
3914
4096
  },
3915
4097
  {
3916
4098
  "kind": "javascript-module",
3917
- "path": "src/accordion/accordion.styles.ts",
4099
+ "path": "src/avatar/avatar.styles.ts",
3918
4100
  "declarations": [
3919
4101
  {
3920
4102
  "kind": "function",
3921
- "name": "foundationAccordionStyles",
4103
+ "name": "foundationAvatarStyles",
3922
4104
  "return": {
3923
4105
  "type": {
3924
4106
  "text": "ElementStyles"
@@ -3943,24 +4125,24 @@
3943
4125
  "exports": [
3944
4126
  {
3945
4127
  "kind": "js",
3946
- "name": "foundationAccordionStyles",
4128
+ "name": "foundationAvatarStyles",
3947
4129
  "declaration": {
3948
- "name": "foundationAccordionStyles",
3949
- "module": "src/accordion/accordion.styles.ts"
4130
+ "name": "foundationAvatarStyles",
4131
+ "module": "src/avatar/avatar.styles.ts"
3950
4132
  }
3951
4133
  }
3952
4134
  ]
3953
4135
  },
3954
4136
  {
3955
4137
  "kind": "javascript-module",
3956
- "path": "src/accordion/accordion.template.ts",
4138
+ "path": "src/avatar/avatar.template.ts",
3957
4139
  "declarations": [
3958
4140
  {
3959
4141
  "kind": "function",
3960
- "name": "foundationAccordionTemplate",
4142
+ "name": "foundationAvatarTemplate",
3961
4143
  "return": {
3962
4144
  "type": {
3963
- "text": "ViewTemplate<Accordion>"
4145
+ "text": "ViewTemplate<Avatar>"
3964
4146
  }
3965
4147
  },
3966
4148
  "parameters": [
@@ -3977,225 +4159,43 @@
3977
4159
  }
3978
4160
  }
3979
4161
  ]
4162
+ },
4163
+ {
4164
+ "kind": "variable",
4165
+ "name": "media",
4166
+ "default": "html<Avatar>`\n ${when(\n (x) => x.imgSrc,\n html<Avatar>`\n <img src=\"${(x) => x.imgSrc}\" alt=\"${(x) => x.alt}\" slot=\"media\" class=\"media\" part=\"media\" />\n `,\n )}\n`"
3980
4167
  }
3981
4168
  ],
3982
4169
  "exports": [
3983
4170
  {
3984
4171
  "kind": "js",
3985
- "name": "foundationAccordionTemplate",
4172
+ "name": "foundationAvatarTemplate",
3986
4173
  "declaration": {
3987
- "name": "foundationAccordionTemplate",
3988
- "module": "src/accordion/accordion.template.ts"
4174
+ "name": "foundationAvatarTemplate",
4175
+ "module": "src/avatar/avatar.template.ts"
4176
+ }
4177
+ },
4178
+ {
4179
+ "kind": "js",
4180
+ "name": "media",
4181
+ "declaration": {
4182
+ "name": "media",
4183
+ "module": "src/avatar/avatar.template.ts"
3989
4184
  }
3990
4185
  }
3991
4186
  ]
3992
4187
  },
3993
4188
  {
3994
4189
  "kind": "javascript-module",
3995
- "path": "src/accordion/accordion.ts",
4190
+ "path": "src/avatar/avatar.ts",
3996
4191
  "declarations": [
3997
4192
  {
3998
4193
  "kind": "class",
3999
4194
  "description": "",
4000
- "name": "Accordion",
4195
+ "name": "Avatar",
4001
4196
  "superclass": {
4002
- "name": "FASTAccordion",
4003
- "package": "@microsoft/fast-foundation"
4004
- },
4005
- "tagName": "%%prefix%%-accordion",
4006
- "customElement": true
4007
- },
4008
- {
4009
- "kind": "variable",
4010
- "name": "foundationAccordionShadowOptions",
4011
- "type": {
4012
- "text": "ShadowRootInit"
4013
- },
4014
- "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
4015
- },
4016
- {
4017
- "kind": "variable",
4018
- "name": "defaultAccordionConfig",
4019
- "type": {
4020
- "text": "object"
4021
- },
4022
- "default": "{}"
4023
- },
4024
- {
4025
- "kind": "variable",
4026
- "name": "foundationAccordion",
4027
- "description": "The Foundation Accordion",
4028
- "privacy": "public"
4029
- }
4030
- ],
4031
- "exports": [
4032
- {
4033
- "kind": "js",
4034
- "name": "Accordion",
4035
- "declaration": {
4036
- "name": "Accordion",
4037
- "module": "src/accordion/accordion.ts"
4038
- }
4039
- },
4040
- {
4041
- "kind": "js",
4042
- "name": "foundationAccordionShadowOptions",
4043
- "declaration": {
4044
- "name": "foundationAccordionShadowOptions",
4045
- "module": "src/accordion/accordion.ts"
4046
- }
4047
- },
4048
- {
4049
- "kind": "js",
4050
- "name": "defaultAccordionConfig",
4051
- "declaration": {
4052
- "name": "defaultAccordionConfig",
4053
- "module": "src/accordion/accordion.ts"
4054
- }
4055
- },
4056
- {
4057
- "kind": "js",
4058
- "name": "foundationAccordion",
4059
- "declaration": {
4060
- "name": "foundationAccordion",
4061
- "module": "src/accordion/accordion.ts"
4062
- }
4063
- }
4064
- ]
4065
- },
4066
- {
4067
- "kind": "javascript-module",
4068
- "path": "src/accordion/index.ts",
4069
- "declarations": [],
4070
- "exports": [
4071
- {
4072
- "kind": "js",
4073
- "name": "*",
4074
- "declaration": {
4075
- "name": "*",
4076
- "package": "./accordion.template"
4077
- }
4078
- },
4079
- {
4080
- "kind": "js",
4081
- "name": "*",
4082
- "declaration": {
4083
- "name": "*",
4084
- "package": "./accordion.styles"
4085
- }
4086
- },
4087
- {
4088
- "kind": "js",
4089
- "name": "*",
4090
- "declaration": {
4091
- "name": "*",
4092
- "package": "./accordion"
4093
- }
4094
- }
4095
- ]
4096
- },
4097
- {
4098
- "kind": "javascript-module",
4099
- "path": "src/avatar/avatar.styles.ts",
4100
- "declarations": [
4101
- {
4102
- "kind": "function",
4103
- "name": "foundationAvatarStyles",
4104
- "return": {
4105
- "type": {
4106
- "text": "ElementStyles"
4107
- }
4108
- },
4109
- "parameters": [
4110
- {
4111
- "name": "context",
4112
- "type": {
4113
- "text": "ElementDefinitionContext"
4114
- }
4115
- },
4116
- {
4117
- "name": "definition",
4118
- "type": {
4119
- "text": "FoundationElementDefinition"
4120
- }
4121
- }
4122
- ]
4123
- }
4124
- ],
4125
- "exports": [
4126
- {
4127
- "kind": "js",
4128
- "name": "foundationAvatarStyles",
4129
- "declaration": {
4130
- "name": "foundationAvatarStyles",
4131
- "module": "src/avatar/avatar.styles.ts"
4132
- }
4133
- }
4134
- ]
4135
- },
4136
- {
4137
- "kind": "javascript-module",
4138
- "path": "src/avatar/avatar.template.ts",
4139
- "declarations": [
4140
- {
4141
- "kind": "function",
4142
- "name": "foundationAvatarTemplate",
4143
- "return": {
4144
- "type": {
4145
- "text": "ViewTemplate<Avatar>"
4146
- }
4147
- },
4148
- "parameters": [
4149
- {
4150
- "name": "context",
4151
- "type": {
4152
- "text": "ElementDefinitionContext"
4153
- }
4154
- },
4155
- {
4156
- "name": "definition",
4157
- "type": {
4158
- "text": "FoundationElementDefinition"
4159
- }
4160
- }
4161
- ]
4162
- },
4163
- {
4164
- "kind": "variable",
4165
- "name": "media",
4166
- "default": "html<Avatar>`\n ${when(\n (x) => x.imgSrc,\n html<Avatar>`\n <img src=\"${(x) => x.imgSrc}\" alt=\"${(x) => x.alt}\" slot=\"media\" class=\"media\" part=\"media\" />\n `,\n )}\n`"
4167
- }
4168
- ],
4169
- "exports": [
4170
- {
4171
- "kind": "js",
4172
- "name": "foundationAvatarTemplate",
4173
- "declaration": {
4174
- "name": "foundationAvatarTemplate",
4175
- "module": "src/avatar/avatar.template.ts"
4176
- }
4177
- },
4178
- {
4179
- "kind": "js",
4180
- "name": "media",
4181
- "declaration": {
4182
- "name": "media",
4183
- "module": "src/avatar/avatar.template.ts"
4184
- }
4185
- }
4186
- ]
4187
- },
4188
- {
4189
- "kind": "javascript-module",
4190
- "path": "src/avatar/avatar.ts",
4191
- "declarations": [
4192
- {
4193
- "kind": "class",
4194
- "description": "",
4195
- "name": "Avatar",
4196
- "superclass": {
4197
- "name": "FASTAvatar",
4198
- "package": "@microsoft/fast-components"
4197
+ "name": "FASTAvatar",
4198
+ "package": "@microsoft/fast-components"
4199
4199
  },
4200
4200
  "tagName": "%%prefix%%-avatar",
4201
4201
  "customElement": true,
@@ -19302,11 +19302,11 @@
19302
19302
  },
19303
19303
  {
19304
19304
  "kind": "javascript-module",
19305
- "path": "src/horizontal-scroll/horizontal-scroll.styles.ts",
19305
+ "path": "src/icon/icon.styles.ts",
19306
19306
  "declarations": [
19307
19307
  {
19308
19308
  "kind": "function",
19309
- "name": "foundationHorizontalScrollStyles",
19309
+ "name": "foundationIconStyles",
19310
19310
  "return": {
19311
19311
  "type": {
19312
19312
  "text": "ElementStyles"
@@ -19331,454 +19331,573 @@
19331
19331
  "exports": [
19332
19332
  {
19333
19333
  "kind": "js",
19334
- "name": "foundationHorizontalScrollStyles",
19334
+ "name": "foundationIconStyles",
19335
19335
  "declaration": {
19336
- "name": "foundationHorizontalScrollStyles",
19337
- "module": "src/horizontal-scroll/horizontal-scroll.styles.ts"
19336
+ "name": "foundationIconStyles",
19337
+ "module": "src/icon/icon.styles.ts"
19338
19338
  }
19339
19339
  }
19340
19340
  ]
19341
19341
  },
19342
19342
  {
19343
19343
  "kind": "javascript-module",
19344
- "path": "src/horizontal-scroll/horizontal-scroll.template.ts",
19344
+ "path": "src/icon/icon.template.ts",
19345
19345
  "declarations": [
19346
19346
  {
19347
- "kind": "function",
19348
- "name": "foundationHorizontalScrollTemplate",
19349
- "return": {
19350
- "type": {
19351
- "text": "ViewTemplate<HorizontalScroll>"
19352
- }
19347
+ "kind": "variable",
19348
+ "name": "foundationIconTemplate",
19349
+ "type": {
19350
+ "text": "ViewTemplate"
19353
19351
  },
19354
- "parameters": [
19355
- {
19356
- "name": "context",
19357
- "type": {
19358
- "text": "ElementDefinitionContext"
19359
- }
19360
- },
19361
- {
19362
- "name": "definition",
19363
- "type": {
19364
- "text": "FoundationElementDefinition"
19365
- }
19366
- }
19367
- ]
19352
+ "default": "html<Icon>`\n <template>\n <i\n ${ref('iElement')}\n class=${(x) => `fa-${x.name} fa-${x.size} fa-${x.variant}`}\n part=${(x) => `icon-${x.name}-${x.size}-${x.variant}`}\n >\n <slot></slot>\n </i>\n </template>\n`"
19368
19353
  }
19369
19354
  ],
19370
19355
  "exports": [
19371
19356
  {
19372
19357
  "kind": "js",
19373
- "name": "foundationHorizontalScrollTemplate",
19358
+ "name": "foundationIconTemplate",
19374
19359
  "declaration": {
19375
- "name": "foundationHorizontalScrollTemplate",
19376
- "module": "src/horizontal-scroll/horizontal-scroll.template.ts"
19360
+ "name": "foundationIconTemplate",
19361
+ "module": "src/icon/icon.template.ts"
19377
19362
  }
19378
19363
  }
19379
19364
  ]
19380
19365
  },
19381
19366
  {
19382
19367
  "kind": "javascript-module",
19383
- "path": "src/horizontal-scroll/horizontal-scroll.ts",
19368
+ "path": "src/icon/icon.ts",
19384
19369
  "declarations": [
19370
+ {
19371
+ "kind": "variable",
19372
+ "name": "foundationIconShadowOptions",
19373
+ "type": {
19374
+ "text": "ShadowRootInit"
19375
+ },
19376
+ "default": "{\n mode: 'open',\n delegatesFocus: true,\n}"
19377
+ },
19378
+ {
19379
+ "kind": "variable",
19380
+ "name": "defaultIconConfig",
19381
+ "type": {
19382
+ "text": "object"
19383
+ },
19384
+ "default": "{}"
19385
+ },
19385
19386
  {
19386
19387
  "kind": "class",
19387
19388
  "description": "",
19388
- "name": "HorizontalScroll",
19389
- "superclass": {
19390
- "name": "FASTHorizontalScroll",
19391
- "package": "@microsoft/fast-components"
19392
- },
19393
- "tagName": "%%prefix%%-horizontal-scroll",
19394
- "customElement": true,
19395
- "attributes": [
19389
+ "name": "Icon",
19390
+ "members": [
19396
19391
  {
19392
+ "kind": "field",
19393
+ "name": "iElement",
19397
19394
  "type": {
19398
- "text": "number"
19399
- },
19400
- "default": "600",
19401
- "description": "Speed of scroll in pixels per second",
19402
- "fieldName": "speed",
19403
- "inheritedFrom": {
19404
- "name": "HorizontalScroll",
19405
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19395
+ "text": "HTMLElement"
19406
19396
  }
19407
19397
  },
19408
19398
  {
19409
- "name": "duration",
19399
+ "kind": "field",
19400
+ "name": "name",
19410
19401
  "type": {
19411
- "text": "string"
19412
- },
19413
- "description": "The CSS time value for the scroll transition duration. Overrides the `speed` attribute.",
19414
- "fieldName": "duration",
19415
- "inheritedFrom": {
19416
- "name": "HorizontalScroll",
19417
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19402
+ "text": "IconName"
19418
19403
  }
19419
19404
  },
19420
19405
  {
19421
- "name": "easing",
19422
- "type": {
19423
- "text": "ScrollEasing"
19424
- },
19425
- "default": "\"ease-in-out\"",
19426
- "description": "Attribute used for easing, defaults to ease-in-out",
19427
- "fieldName": "easing",
19428
- "inheritedFrom": {
19429
- "name": "HorizontalScroll",
19430
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19431
- }
19406
+ "kind": "method",
19407
+ "name": "nameChanged",
19408
+ "parameters": [
19409
+ {
19410
+ "name": "oldValue",
19411
+ "type": {
19412
+ "text": "string"
19413
+ }
19414
+ },
19415
+ {
19416
+ "name": "newValue",
19417
+ "type": {
19418
+ "text": "string"
19419
+ }
19420
+ }
19421
+ ]
19432
19422
  },
19433
19423
  {
19434
- "name": "flippers-hidden-from-at",
19424
+ "kind": "field",
19425
+ "name": "size",
19435
19426
  "type": {
19436
- "text": "boolean"
19427
+ "text": "FaSize"
19437
19428
  },
19438
- "default": "false",
19439
- "description": "Attribute to hide flippers from assistive technology",
19440
- "fieldName": "flippersHiddenFromAT",
19441
- "inheritedFrom": {
19442
- "name": "HorizontalScroll",
19443
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19444
- }
19429
+ "default": "'sm'"
19445
19430
  },
19446
19431
  {
19447
- "name": "view",
19448
- "type": {
19449
- "text": "HorizontalScrollView"
19450
- },
19451
- "description": "View: default | mobile",
19452
- "fieldName": "view",
19453
- "inheritedFrom": {
19454
- "name": "HorizontalScroll",
19455
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19456
- }
19457
- }
19458
- ],
19459
- "members": [
19460
- {
19461
- "kind": "field",
19462
- "name": "scrollContainer",
19463
- "type": {
19464
- "text": "HTMLDivElement"
19465
- },
19466
- "privacy": "public",
19467
- "description": "Reference to DOM element that scrolls the content",
19468
- "inheritedFrom": {
19469
- "name": "HorizontalScroll",
19470
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19471
- }
19432
+ "kind": "method",
19433
+ "name": "sizeChanged",
19434
+ "parameters": [
19435
+ {
19436
+ "name": "oldValue",
19437
+ "type": {
19438
+ "text": "string"
19439
+ }
19440
+ },
19441
+ {
19442
+ "name": "newValue",
19443
+ "type": {
19444
+ "text": "string"
19445
+ }
19446
+ }
19447
+ ]
19472
19448
  },
19473
19449
  {
19474
19450
  "kind": "field",
19475
- "name": "content",
19451
+ "name": "variant",
19476
19452
  "type": {
19477
- "text": "HTMLDivElement"
19453
+ "text": "IconStyle"
19478
19454
  },
19479
- "privacy": "public",
19480
- "description": "Reference to DOM element that holds the slotted content",
19481
- "inheritedFrom": {
19482
- "name": "HorizontalScroll",
19483
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19484
- }
19455
+ "default": "'solid'"
19485
19456
  },
19486
19457
  {
19487
- "kind": "field",
19488
- "name": "previousFlipperContainer",
19489
- "type": {
19490
- "text": "HTMLDivElement"
19491
- },
19492
- "privacy": "public",
19493
- "description": "Reference to flipper to scroll to previous content",
19494
- "inheritedFrom": {
19495
- "name": "HorizontalScroll",
19496
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19497
- }
19458
+ "kind": "method",
19459
+ "name": "variantChanged",
19460
+ "parameters": [
19461
+ {
19462
+ "name": "oldValue",
19463
+ "type": {
19464
+ "text": "string"
19465
+ }
19466
+ },
19467
+ {
19468
+ "name": "newValue",
19469
+ "type": {
19470
+ "text": "string"
19471
+ }
19472
+ }
19473
+ ]
19498
19474
  },
19499
19475
  {
19500
- "kind": "field",
19501
- "name": "nextFlipperContainer",
19502
- "type": {
19503
- "text": "HTMLDivElement"
19504
- },
19505
- "privacy": "public",
19506
- "description": "Reference to flipper to scroll to the next content",
19507
- "inheritedFrom": {
19508
- "name": "HorizontalScroll",
19509
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19510
- }
19476
+ "kind": "method",
19477
+ "name": "loadIcon",
19478
+ "privacy": "public"
19511
19479
  },
19512
19480
  {
19513
19481
  "kind": "field",
19514
- "name": "speed",
19482
+ "name": "_presentation",
19515
19483
  "type": {
19516
- "text": "number"
19484
+ "text": "ComponentPresentation | null | undefined"
19517
19485
  },
19518
- "privacy": "public",
19519
- "default": "600",
19520
- "description": "Speed of scroll in pixels per second",
19486
+ "privacy": "private",
19487
+ "default": "void 0",
19521
19488
  "inheritedFrom": {
19522
- "name": "HorizontalScroll",
19523
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19489
+ "name": "FoundationElement",
19490
+ "module": "src/foundation-element/foundation-element.ts"
19524
19491
  }
19525
19492
  },
19526
19493
  {
19527
19494
  "kind": "field",
19528
- "name": "duration",
19495
+ "name": "$presentation",
19529
19496
  "type": {
19530
- "text": "string"
19497
+ "text": "ComponentPresentation | null"
19531
19498
  },
19532
19499
  "privacy": "public",
19533
- "description": "The CSS time value for the scroll transition duration. Overrides the `speed` attribute.",
19500
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
19534
19501
  "inheritedFrom": {
19535
- "name": "HorizontalScroll",
19536
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19502
+ "name": "FoundationElement",
19503
+ "module": "src/foundation-element/foundation-element.ts"
19537
19504
  }
19538
19505
  },
19539
19506
  {
19540
19507
  "kind": "field",
19541
- "name": "easing",
19508
+ "name": "template",
19542
19509
  "type": {
19543
- "text": "ScrollEasing"
19510
+ "text": "ElementViewTemplate | void | null"
19544
19511
  },
19545
19512
  "privacy": "public",
19546
- "default": "\"ease-in-out\"",
19547
- "description": "Attribute used for easing, defaults to ease-in-out",
19513
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
19548
19514
  "inheritedFrom": {
19549
- "name": "HorizontalScroll",
19550
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19515
+ "name": "FoundationElement",
19516
+ "module": "src/foundation-element/foundation-element.ts"
19551
19517
  }
19552
19518
  },
19553
19519
  {
19554
- "kind": "field",
19555
- "name": "flippersHiddenFromAT",
19556
- "type": {
19557
- "text": "boolean"
19520
+ "kind": "method",
19521
+ "name": "templateChanged",
19522
+ "privacy": "protected",
19523
+ "return": {
19524
+ "type": {
19525
+ "text": "void"
19526
+ }
19558
19527
  },
19559
- "privacy": "public",
19560
- "default": "false",
19561
- "description": "Attribute to hide flippers from assistive technology",
19562
19528
  "inheritedFrom": {
19563
- "name": "HorizontalScroll",
19564
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19529
+ "name": "FoundationElement",
19530
+ "module": "src/foundation-element/foundation-element.ts"
19565
19531
  }
19566
19532
  },
19567
19533
  {
19568
19534
  "kind": "field",
19569
- "name": "scrollItems",
19535
+ "name": "styles",
19570
19536
  "type": {
19571
- "text": "HTMLElement[]"
19537
+ "text": "ElementStyles | void | null"
19572
19538
  },
19573
19539
  "privacy": "public",
19574
- "description": "The default slotted items placed in the scrolling container.",
19540
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
19575
19541
  "inheritedFrom": {
19576
- "name": "HorizontalScroll",
19577
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19542
+ "name": "FoundationElement",
19543
+ "module": "src/foundation-element/foundation-element.ts"
19578
19544
  }
19579
19545
  },
19580
19546
  {
19581
- "kind": "field",
19582
- "name": "view",
19583
- "type": {
19584
- "text": "HorizontalScrollView"
19547
+ "kind": "method",
19548
+ "name": "stylesChanged",
19549
+ "privacy": "protected",
19550
+ "return": {
19551
+ "type": {
19552
+ "text": "void"
19553
+ }
19585
19554
  },
19586
- "privacy": "public",
19587
- "description": "View: default | mobile",
19588
19555
  "inheritedFrom": {
19589
- "name": "HorizontalScroll",
19590
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19556
+ "name": "FoundationElement",
19557
+ "module": "src/foundation-element/foundation-element.ts"
19591
19558
  }
19592
19559
  },
19593
19560
  {
19594
19561
  "kind": "method",
19595
- "name": "scrollItemsChanged",
19562
+ "name": "compose",
19596
19563
  "privacy": "public",
19564
+ "static": true,
19565
+ "return": {
19566
+ "type": {
19567
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
19568
+ }
19569
+ },
19597
19570
  "parameters": [
19598
19571
  {
19599
- "name": "previous",
19572
+ "name": "this",
19600
19573
  "type": {
19601
- "text": "HTMLElement[]"
19602
- },
19603
- "description": "current scroll items"
19574
+ "text": "K"
19575
+ }
19604
19576
  },
19605
19577
  {
19606
- "name": "next",
19578
+ "name": "elementDefinition",
19607
19579
  "type": {
19608
- "text": "HTMLElement[]"
19580
+ "text": "T"
19609
19581
  },
19610
- "description": "new updated scroll items"
19582
+ "description": "The definition of the element to create the registry\nfunction for."
19611
19583
  }
19612
19584
  ],
19613
- "description": "Updates scroll stops and flippers when scroll items change",
19585
+ "description": "Defines an element registry function with a set of element definition defaults.",
19614
19586
  "inheritedFrom": {
19615
- "name": "HorizontalScroll",
19616
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19587
+ "name": "FoundationElement",
19588
+ "module": "src/foundation-element/foundation-element.ts"
19617
19589
  }
19590
+ }
19591
+ ],
19592
+ "attributes": [
19593
+ {
19594
+ "name": "name",
19595
+ "type": {
19596
+ "text": "IconName"
19597
+ },
19598
+ "fieldName": "name"
19618
19599
  },
19619
19600
  {
19620
- "kind": "method",
19621
- "name": "fixScrollMisalign",
19622
- "privacy": "private",
19623
- "parameters": [
19624
- {
19625
- "name": "stops",
19626
- "type": {
19627
- "text": "number[]"
19628
- }
19629
- }
19630
- ],
19601
+ "name": "size",
19602
+ "type": {
19603
+ "text": "FaSize"
19604
+ },
19605
+ "default": "'sm'",
19606
+ "fieldName": "size"
19607
+ },
19608
+ {
19609
+ "name": "variant",
19610
+ "type": {
19611
+ "text": "IconStyle"
19612
+ },
19613
+ "default": "'solid'",
19614
+ "fieldName": "variant"
19615
+ }
19616
+ ],
19617
+ "superclass": {
19618
+ "name": "FoundationElement",
19619
+ "package": "@microsoft/fast-foundation"
19620
+ },
19621
+ "tagName": "%%prefix%%-icon",
19622
+ "customElement": true
19623
+ },
19624
+ {
19625
+ "kind": "variable",
19626
+ "name": "foundationIcon",
19627
+ "description": "The Foundation Icon",
19628
+ "privacy": "public"
19629
+ }
19630
+ ],
19631
+ "exports": [
19632
+ {
19633
+ "kind": "js",
19634
+ "name": "foundationIconShadowOptions",
19635
+ "declaration": {
19636
+ "name": "foundationIconShadowOptions",
19637
+ "module": "src/icon/icon.ts"
19638
+ }
19639
+ },
19640
+ {
19641
+ "kind": "js",
19642
+ "name": "defaultIconConfig",
19643
+ "declaration": {
19644
+ "name": "defaultIconConfig",
19645
+ "module": "src/icon/icon.ts"
19646
+ }
19647
+ },
19648
+ {
19649
+ "kind": "js",
19650
+ "name": "Icon",
19651
+ "declaration": {
19652
+ "name": "Icon",
19653
+ "module": "src/icon/icon.ts"
19654
+ }
19655
+ },
19656
+ {
19657
+ "kind": "js",
19658
+ "name": "foundationIcon",
19659
+ "declaration": {
19660
+ "name": "foundationIcon",
19661
+ "module": "src/icon/icon.ts"
19662
+ }
19663
+ }
19664
+ ]
19665
+ },
19666
+ {
19667
+ "kind": "javascript-module",
19668
+ "path": "src/icon/index.ts",
19669
+ "declarations": [],
19670
+ "exports": [
19671
+ {
19672
+ "kind": "js",
19673
+ "name": "*",
19674
+ "declaration": {
19675
+ "name": "*",
19676
+ "package": "./icon.styles"
19677
+ }
19678
+ },
19679
+ {
19680
+ "kind": "js",
19681
+ "name": "*",
19682
+ "declaration": {
19683
+ "name": "*",
19684
+ "package": "./icon.template"
19685
+ }
19686
+ },
19687
+ {
19688
+ "kind": "js",
19689
+ "name": "*",
19690
+ "declaration": {
19691
+ "name": "*",
19692
+ "package": "./icon"
19693
+ }
19694
+ }
19695
+ ]
19696
+ },
19697
+ {
19698
+ "kind": "javascript-module",
19699
+ "path": "src/horizontal-scroll/horizontal-scroll.styles.ts",
19700
+ "declarations": [
19701
+ {
19702
+ "kind": "function",
19703
+ "name": "foundationHorizontalScrollStyles",
19704
+ "return": {
19705
+ "type": {
19706
+ "text": "ElementStyles"
19707
+ }
19708
+ },
19709
+ "parameters": [
19710
+ {
19711
+ "name": "context",
19712
+ "type": {
19713
+ "text": "ElementDefinitionContext"
19714
+ }
19715
+ },
19716
+ {
19717
+ "name": "definition",
19718
+ "type": {
19719
+ "text": "FoundationElementDefinition"
19720
+ }
19721
+ }
19722
+ ]
19723
+ }
19724
+ ],
19725
+ "exports": [
19726
+ {
19727
+ "kind": "js",
19728
+ "name": "foundationHorizontalScrollStyles",
19729
+ "declaration": {
19730
+ "name": "foundationHorizontalScrollStyles",
19731
+ "module": "src/horizontal-scroll/horizontal-scroll.styles.ts"
19732
+ }
19733
+ }
19734
+ ]
19735
+ },
19736
+ {
19737
+ "kind": "javascript-module",
19738
+ "path": "src/horizontal-scroll/horizontal-scroll.template.ts",
19739
+ "declarations": [
19740
+ {
19741
+ "kind": "function",
19742
+ "name": "foundationHorizontalScrollTemplate",
19743
+ "return": {
19744
+ "type": {
19745
+ "text": "ViewTemplate<HorizontalScroll>"
19746
+ }
19747
+ },
19748
+ "parameters": [
19749
+ {
19750
+ "name": "context",
19751
+ "type": {
19752
+ "text": "ElementDefinitionContext"
19753
+ }
19754
+ },
19755
+ {
19756
+ "name": "definition",
19757
+ "type": {
19758
+ "text": "FoundationElementDefinition"
19759
+ }
19760
+ }
19761
+ ]
19762
+ }
19763
+ ],
19764
+ "exports": [
19765
+ {
19766
+ "kind": "js",
19767
+ "name": "foundationHorizontalScrollTemplate",
19768
+ "declaration": {
19769
+ "name": "foundationHorizontalScrollTemplate",
19770
+ "module": "src/horizontal-scroll/horizontal-scroll.template.ts"
19771
+ }
19772
+ }
19773
+ ]
19774
+ },
19775
+ {
19776
+ "kind": "javascript-module",
19777
+ "path": "src/horizontal-scroll/horizontal-scroll.ts",
19778
+ "declarations": [
19779
+ {
19780
+ "kind": "class",
19781
+ "description": "",
19782
+ "name": "HorizontalScroll",
19783
+ "superclass": {
19784
+ "name": "FASTHorizontalScroll",
19785
+ "package": "@microsoft/fast-components"
19786
+ },
19787
+ "tagName": "%%prefix%%-horizontal-scroll",
19788
+ "customElement": true,
19789
+ "attributes": [
19790
+ {
19791
+ "type": {
19792
+ "text": "number"
19793
+ },
19794
+ "default": "600",
19795
+ "description": "Speed of scroll in pixels per second",
19796
+ "fieldName": "speed",
19631
19797
  "inheritedFrom": {
19632
19798
  "name": "HorizontalScroll",
19633
19799
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19634
19800
  }
19635
19801
  },
19636
19802
  {
19637
- "kind": "method",
19638
- "name": "scrollInView",
19639
- "privacy": "public",
19640
- "return": {
19641
- "type": {
19642
- "text": "void"
19643
- }
19803
+ "name": "duration",
19804
+ "type": {
19805
+ "text": "string"
19644
19806
  },
19645
- "parameters": [
19646
- {
19647
- "name": "item",
19648
- "type": {
19649
- "text": "HTMLElement | number"
19650
- },
19651
- "description": "An item index, a scroll item or a child of one of the scroll items"
19652
- },
19653
- {
19654
- "name": "padding",
19655
- "default": "0",
19656
- "type": {
19657
- "text": "number"
19658
- },
19659
- "description": "Padding of the viewport where the active item shouldn't be"
19660
- },
19661
- {
19662
- "name": "rightPadding",
19663
- "optional": true,
19664
- "type": {
19665
- "text": "number"
19666
- },
19667
- "description": "Optional right padding. Uses the padding if not defined"
19668
- }
19669
- ],
19670
- "description": "Function that can scroll an item into view.",
19807
+ "description": "The CSS time value for the scroll transition duration. Overrides the `speed` attribute.",
19808
+ "fieldName": "duration",
19671
19809
  "inheritedFrom": {
19672
19810
  "name": "HorizontalScroll",
19673
19811
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19674
19812
  }
19675
19813
  },
19676
19814
  {
19677
- "kind": "method",
19678
- "name": "keyupHandler",
19679
- "privacy": "public",
19680
- "parameters": [
19681
- {
19682
- "name": "e",
19683
- "type": {
19684
- "text": "Event & KeyboardEvent"
19685
- },
19686
- "description": "Keyboard event"
19687
- }
19688
- ],
19689
- "description": "Lets the user arrow left and right through the horizontal scroll",
19815
+ "name": "easing",
19816
+ "type": {
19817
+ "text": "ScrollEasing"
19818
+ },
19819
+ "default": "\"ease-in-out\"",
19820
+ "description": "Attribute used for easing, defaults to ease-in-out",
19821
+ "fieldName": "easing",
19690
19822
  "inheritedFrom": {
19691
19823
  "name": "HorizontalScroll",
19692
19824
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19693
19825
  }
19694
19826
  },
19695
19827
  {
19696
- "kind": "method",
19697
- "name": "scrollToPrevious",
19698
- "privacy": "public",
19699
- "return": {
19700
- "type": {
19701
- "text": "void"
19702
- }
19828
+ "name": "flippers-hidden-from-at",
19829
+ "type": {
19830
+ "text": "boolean"
19703
19831
  },
19704
- "description": "Scrolls items to the left",
19832
+ "default": "false",
19833
+ "description": "Attribute to hide flippers from assistive technology",
19834
+ "fieldName": "flippersHiddenFromAT",
19705
19835
  "inheritedFrom": {
19706
19836
  "name": "HorizontalScroll",
19707
19837
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19708
19838
  }
19709
19839
  },
19710
19840
  {
19711
- "kind": "method",
19712
- "name": "scrollToNext",
19713
- "privacy": "public",
19714
- "return": {
19715
- "type": {
19716
- "text": "void"
19717
- }
19841
+ "name": "view",
19842
+ "type": {
19843
+ "text": "HorizontalScrollView"
19718
19844
  },
19719
- "description": "Scrolls items to the right",
19845
+ "description": "View: default | mobile",
19846
+ "fieldName": "view",
19720
19847
  "inheritedFrom": {
19721
19848
  "name": "HorizontalScroll",
19722
19849
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19723
19850
  }
19724
- },
19851
+ }
19852
+ ],
19853
+ "members": [
19725
19854
  {
19726
- "kind": "method",
19727
- "name": "scrollToPosition",
19728
- "privacy": "public",
19729
- "return": {
19730
- "type": {
19731
- "text": "void"
19732
- }
19855
+ "kind": "field",
19856
+ "name": "scrollContainer",
19857
+ "type": {
19858
+ "text": "HTMLDivElement"
19733
19859
  },
19734
- "parameters": [
19735
- {
19736
- "name": "newPosition",
19737
- "type": {
19738
- "text": "number"
19739
- },
19740
- "description": "position to scroll to"
19741
- },
19742
- {
19743
- "name": "position",
19744
- "default": "this.scrollContainer.scrollLeft",
19745
- "type": {
19746
- "text": "number"
19747
- },
19748
- "description": "starting position"
19749
- }
19750
- ],
19751
- "description": "Handles scrolling with easing",
19860
+ "privacy": "public",
19861
+ "description": "Reference to DOM element that scrolls the content",
19752
19862
  "inheritedFrom": {
19753
19863
  "name": "HorizontalScroll",
19754
19864
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19755
19865
  }
19756
19866
  },
19757
19867
  {
19758
- "kind": "method",
19759
- "name": "resized",
19760
- "privacy": "public",
19761
- "return": {
19762
- "type": {
19763
- "text": "void"
19764
- }
19868
+ "kind": "field",
19869
+ "name": "content",
19870
+ "type": {
19871
+ "text": "HTMLDivElement"
19765
19872
  },
19766
- "description": "Monitors resize event on the horizontal-scroll element",
19873
+ "privacy": "public",
19874
+ "description": "Reference to DOM element that holds the slotted content",
19767
19875
  "inheritedFrom": {
19768
19876
  "name": "HorizontalScroll",
19769
19877
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19770
19878
  }
19771
19879
  },
19772
19880
  {
19773
- "kind": "method",
19774
- "name": "scrolled",
19881
+ "kind": "field",
19882
+ "name": "previousFlipperContainer",
19883
+ "type": {
19884
+ "text": "HTMLDivElement"
19885
+ },
19775
19886
  "privacy": "public",
19776
- "return": {
19777
- "type": {
19778
- "text": "void"
19779
- }
19887
+ "description": "Reference to flipper to scroll to previous content",
19888
+ "inheritedFrom": {
19889
+ "name": "HorizontalScroll",
19890
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
19891
+ }
19892
+ },
19893
+ {
19894
+ "kind": "field",
19895
+ "name": "nextFlipperContainer",
19896
+ "type": {
19897
+ "text": "HTMLDivElement"
19780
19898
  },
19781
- "description": "Monitors scrolled event on the content container",
19899
+ "privacy": "public",
19900
+ "description": "Reference to flipper to scroll to the next content",
19782
19901
  "inheritedFrom": {
19783
19902
  "name": "HorizontalScroll",
19784
19903
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
@@ -19786,400 +19905,278 @@
19786
19905
  },
19787
19906
  {
19788
19907
  "kind": "field",
19789
- "name": "_presentation",
19908
+ "name": "speed",
19790
19909
  "type": {
19791
- "text": "ComponentPresentation | null | undefined"
19910
+ "text": "number"
19792
19911
  },
19793
- "privacy": "private",
19794
- "default": "void 0",
19912
+ "privacy": "public",
19913
+ "default": "600",
19914
+ "description": "Speed of scroll in pixels per second",
19795
19915
  "inheritedFrom": {
19796
- "name": "FoundationElement",
19797
- "module": "src/foundation-element/foundation-element.ts"
19916
+ "name": "HorizontalScroll",
19917
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
19798
19918
  }
19799
19919
  },
19800
19920
  {
19801
19921
  "kind": "field",
19802
- "name": "$presentation",
19922
+ "name": "duration",
19803
19923
  "type": {
19804
- "text": "ComponentPresentation | null"
19924
+ "text": "string"
19805
19925
  },
19806
19926
  "privacy": "public",
19807
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
19927
+ "description": "The CSS time value for the scroll transition duration. Overrides the `speed` attribute.",
19808
19928
  "inheritedFrom": {
19809
- "name": "FoundationElement",
19810
- "module": "src/foundation-element/foundation-element.ts"
19929
+ "name": "HorizontalScroll",
19930
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
19811
19931
  }
19812
19932
  },
19813
19933
  {
19814
19934
  "kind": "field",
19815
- "name": "template",
19935
+ "name": "easing",
19816
19936
  "type": {
19817
- "text": "ElementViewTemplate | void | null"
19937
+ "text": "ScrollEasing"
19818
19938
  },
19819
19939
  "privacy": "public",
19820
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
19940
+ "default": "\"ease-in-out\"",
19941
+ "description": "Attribute used for easing, defaults to ease-in-out",
19821
19942
  "inheritedFrom": {
19822
- "name": "FoundationElement",
19823
- "module": "src/foundation-element/foundation-element.ts"
19943
+ "name": "HorizontalScroll",
19944
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
19824
19945
  }
19825
19946
  },
19826
19947
  {
19827
- "kind": "method",
19828
- "name": "templateChanged",
19829
- "privacy": "protected",
19830
- "return": {
19831
- "type": {
19832
- "text": "void"
19833
- }
19948
+ "kind": "field",
19949
+ "name": "flippersHiddenFromAT",
19950
+ "type": {
19951
+ "text": "boolean"
19834
19952
  },
19953
+ "privacy": "public",
19954
+ "default": "false",
19955
+ "description": "Attribute to hide flippers from assistive technology",
19835
19956
  "inheritedFrom": {
19836
- "name": "FoundationElement",
19837
- "module": "src/foundation-element/foundation-element.ts"
19957
+ "name": "HorizontalScroll",
19958
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
19838
19959
  }
19839
19960
  },
19840
19961
  {
19841
19962
  "kind": "field",
19842
- "name": "styles",
19963
+ "name": "scrollItems",
19843
19964
  "type": {
19844
- "text": "ElementStyles | void | null"
19965
+ "text": "HTMLElement[]"
19845
19966
  },
19846
19967
  "privacy": "public",
19847
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
19968
+ "description": "The default slotted items placed in the scrolling container.",
19848
19969
  "inheritedFrom": {
19849
- "name": "FoundationElement",
19850
- "module": "src/foundation-element/foundation-element.ts"
19970
+ "name": "HorizontalScroll",
19971
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
19851
19972
  }
19852
19973
  },
19853
19974
  {
19854
- "kind": "method",
19855
- "name": "stylesChanged",
19856
- "privacy": "protected",
19857
- "return": {
19858
- "type": {
19859
- "text": "void"
19860
- }
19975
+ "kind": "field",
19976
+ "name": "view",
19977
+ "type": {
19978
+ "text": "HorizontalScrollView"
19861
19979
  },
19980
+ "privacy": "public",
19981
+ "description": "View: default | mobile",
19862
19982
  "inheritedFrom": {
19863
- "name": "FoundationElement",
19864
- "module": "src/foundation-element/foundation-element.ts"
19983
+ "name": "HorizontalScroll",
19984
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
19865
19985
  }
19866
19986
  },
19867
19987
  {
19868
19988
  "kind": "method",
19869
- "name": "compose",
19989
+ "name": "scrollItemsChanged",
19870
19990
  "privacy": "public",
19871
- "static": true,
19872
- "return": {
19873
- "type": {
19874
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
19875
- }
19876
- },
19877
19991
  "parameters": [
19878
19992
  {
19879
- "name": "this",
19993
+ "name": "previous",
19880
19994
  "type": {
19881
- "text": "K"
19882
- }
19995
+ "text": "HTMLElement[]"
19996
+ },
19997
+ "description": "current scroll items"
19883
19998
  },
19884
19999
  {
19885
- "name": "elementDefinition",
20000
+ "name": "next",
19886
20001
  "type": {
19887
- "text": "T"
20002
+ "text": "HTMLElement[]"
19888
20003
  },
19889
- "description": "The definition of the element to create the registry\nfunction for."
20004
+ "description": "new updated scroll items"
19890
20005
  }
19891
20006
  ],
19892
- "description": "Defines an element registry function with a set of element definition defaults.",
19893
- "inheritedFrom": {
19894
- "name": "FoundationElement",
19895
- "module": "src/foundation-element/foundation-element.ts"
19896
- }
19897
- }
19898
- ],
19899
- "events": [
19900
- {
19901
- "description": "Fires a custom 'scrollstart' event when scrolling",
19902
- "name": "scrollstart",
20007
+ "description": "Updates scroll stops and flippers when scroll items change",
19903
20008
  "inheritedFrom": {
19904
20009
  "name": "HorizontalScroll",
19905
20010
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19906
20011
  }
19907
20012
  },
19908
20013
  {
19909
- "description": "Fires a custom 'scrollend' event when scrolling stops",
19910
- "name": "scrollend",
20014
+ "kind": "method",
20015
+ "name": "fixScrollMisalign",
20016
+ "privacy": "private",
20017
+ "parameters": [
20018
+ {
20019
+ "name": "stops",
20020
+ "type": {
20021
+ "text": "number[]"
20022
+ }
20023
+ }
20024
+ ],
19911
20025
  "inheritedFrom": {
19912
20026
  "name": "HorizontalScroll",
19913
20027
  "module": "src/horizontal-scroll/horizontal-scroll.ts"
19914
20028
  }
19915
- }
19916
- ]
19917
- },
19918
- {
19919
- "kind": "variable",
19920
- "name": "foundationHorizontalScrollShadowOptions",
19921
- "type": {
19922
- "text": "ShadowRootInit"
19923
- },
19924
- "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
19925
- },
19926
- {
19927
- "kind": "variable",
19928
- "name": "defaultHorizontalScrollConfig",
19929
- "type": {
19930
- "text": "object"
19931
- },
19932
- "default": "{\n nextFlipper: html`\n <fast-flipper\n @click=\"${(x) => x.scrollToNext()}\"\n aria-hidden=\"${(x) => x.flippersHiddenFromAT}\"\n ></fast-flipper>\n `,\n previousFlipper: html`\n <fast-flipper\n @click=\"${(x) => x.scrollToPrevious()}\"\n direction=\"previous\"\n aria-hidden=\"${(x) => x.flippersHiddenFromAT}\"\n ></fast-flipper>\n `,\n}"
19933
- },
19934
- {
19935
- "kind": "variable",
19936
- "name": "foundationHorizontalScroll",
19937
- "description": "The Foundation HorizontalScroll",
19938
- "privacy": "public"
19939
- }
19940
- ],
19941
- "exports": [
19942
- {
19943
- "kind": "js",
19944
- "name": "HorizontalScroll",
19945
- "declaration": {
19946
- "name": "HorizontalScroll",
19947
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19948
- }
19949
- },
19950
- {
19951
- "kind": "js",
19952
- "name": "foundationHorizontalScrollShadowOptions",
19953
- "declaration": {
19954
- "name": "foundationHorizontalScrollShadowOptions",
19955
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19956
- }
19957
- },
19958
- {
19959
- "kind": "js",
19960
- "name": "defaultHorizontalScrollConfig",
19961
- "declaration": {
19962
- "name": "defaultHorizontalScrollConfig",
19963
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19964
- }
19965
- },
19966
- {
19967
- "kind": "js",
19968
- "name": "foundationHorizontalScroll",
19969
- "declaration": {
19970
- "name": "foundationHorizontalScroll",
19971
- "module": "src/horizontal-scroll/horizontal-scroll.ts"
19972
- }
19973
- }
19974
- ]
19975
- },
19976
- {
19977
- "kind": "javascript-module",
19978
- "path": "src/horizontal-scroll/index.ts",
19979
- "declarations": [],
19980
- "exports": [
19981
- {
19982
- "kind": "js",
19983
- "name": "*",
19984
- "declaration": {
19985
- "name": "*",
19986
- "package": "./horizontal-scroll.template"
19987
- }
19988
- },
19989
- {
19990
- "kind": "js",
19991
- "name": "*",
19992
- "declaration": {
19993
- "name": "*",
19994
- "package": "./horizontal-scroll.styles"
19995
- }
19996
- },
19997
- {
19998
- "kind": "js",
19999
- "name": "*",
20000
- "declaration": {
20001
- "name": "*",
20002
- "package": "./horizontal-scroll"
20003
- }
20004
- }
20005
- ]
20006
- },
20007
- {
20008
- "kind": "javascript-module",
20009
- "path": "src/icon/icon.styles.ts",
20010
- "declarations": [
20011
- {
20012
- "kind": "function",
20013
- "name": "foundationIconStyles",
20014
- "return": {
20015
- "type": {
20016
- "text": "ElementStyles"
20017
- }
20018
- },
20019
- "parameters": [
20020
- {
20021
- "name": "context",
20022
- "type": {
20023
- "text": "ElementDefinitionContext"
20024
- }
20025
- },
20026
- {
20027
- "name": "definition",
20028
- "type": {
20029
- "text": "FoundationElementDefinition"
20030
- }
20031
- }
20032
- ]
20033
- }
20034
- ],
20035
- "exports": [
20036
- {
20037
- "kind": "js",
20038
- "name": "foundationIconStyles",
20039
- "declaration": {
20040
- "name": "foundationIconStyles",
20041
- "module": "src/icon/icon.styles.ts"
20042
- }
20043
- }
20044
- ]
20045
- },
20046
- {
20047
- "kind": "javascript-module",
20048
- "path": "src/icon/icon.template.ts",
20049
- "declarations": [
20050
- {
20051
- "kind": "variable",
20052
- "name": "foundationIconTemplate",
20053
- "type": {
20054
- "text": "ViewTemplate"
20055
- },
20056
- "default": "html<Icon>`\n <template>\n <i\n ${ref('iElement')}\n class=${(x) => `fa-${x.name} fa-${x.size} fa-${x.variant}`}\n part=${(x) => `icon-${x.name}-${x.size}-${x.variant}`}\n >\n <slot></slot>\n </i>\n </template>\n`"
20057
- }
20058
- ],
20059
- "exports": [
20060
- {
20061
- "kind": "js",
20062
- "name": "foundationIconTemplate",
20063
- "declaration": {
20064
- "name": "foundationIconTemplate",
20065
- "module": "src/icon/icon.template.ts"
20066
- }
20067
- }
20068
- ]
20069
- },
20070
- {
20071
- "kind": "javascript-module",
20072
- "path": "src/icon/icon.ts",
20073
- "declarations": [
20074
- {
20075
- "kind": "variable",
20076
- "name": "foundationIconShadowOptions",
20077
- "type": {
20078
- "text": "ShadowRootInit"
20079
- },
20080
- "default": "{\n mode: 'open',\n delegatesFocus: true,\n}"
20081
- },
20082
- {
20083
- "kind": "variable",
20084
- "name": "defaultIconConfig",
20085
- "type": {
20086
- "text": "object"
20087
- },
20088
- "default": "{}"
20089
- },
20090
- {
20091
- "kind": "class",
20092
- "description": "",
20093
- "name": "Icon",
20094
- "members": [
20095
- {
20096
- "kind": "field",
20097
- "name": "iElement",
20098
- "type": {
20099
- "text": "HTMLElement"
20100
- }
20101
- },
20102
- {
20103
- "kind": "field",
20104
- "name": "name",
20105
- "type": {
20106
- "text": "IconName"
20107
- }
20108
20029
  },
20109
20030
  {
20110
20031
  "kind": "method",
20111
- "name": "nameChanged",
20032
+ "name": "scrollInView",
20033
+ "privacy": "public",
20034
+ "return": {
20035
+ "type": {
20036
+ "text": "void"
20037
+ }
20038
+ },
20112
20039
  "parameters": [
20113
20040
  {
20114
- "name": "oldValue",
20041
+ "name": "item",
20042
+ "type": {
20043
+ "text": "HTMLElement | number"
20044
+ },
20045
+ "description": "An item index, a scroll item or a child of one of the scroll items"
20046
+ },
20047
+ {
20048
+ "name": "padding",
20049
+ "default": "0",
20115
20050
  "type": {
20116
- "text": "string"
20117
- }
20051
+ "text": "number"
20052
+ },
20053
+ "description": "Padding of the viewport where the active item shouldn't be"
20118
20054
  },
20119
20055
  {
20120
- "name": "newValue",
20056
+ "name": "rightPadding",
20057
+ "optional": true,
20121
20058
  "type": {
20122
- "text": "string"
20123
- }
20059
+ "text": "number"
20060
+ },
20061
+ "description": "Optional right padding. Uses the padding if not defined"
20124
20062
  }
20125
- ]
20126
- },
20127
- {
20128
- "kind": "field",
20129
- "name": "size",
20130
- "type": {
20131
- "text": "FaSize"
20132
- },
20133
- "default": "'sm'"
20063
+ ],
20064
+ "description": "Function that can scroll an item into view.",
20065
+ "inheritedFrom": {
20066
+ "name": "HorizontalScroll",
20067
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20068
+ }
20134
20069
  },
20135
20070
  {
20136
20071
  "kind": "method",
20137
- "name": "sizeChanged",
20072
+ "name": "keyupHandler",
20073
+ "privacy": "public",
20138
20074
  "parameters": [
20139
20075
  {
20140
- "name": "oldValue",
20141
- "type": {
20142
- "text": "string"
20143
- }
20144
- },
20145
- {
20146
- "name": "newValue",
20076
+ "name": "e",
20147
20077
  "type": {
20148
- "text": "string"
20149
- }
20078
+ "text": "Event & KeyboardEvent"
20079
+ },
20080
+ "description": "Keyboard event"
20150
20081
  }
20151
- ]
20082
+ ],
20083
+ "description": "Lets the user arrow left and right through the horizontal scroll",
20084
+ "inheritedFrom": {
20085
+ "name": "HorizontalScroll",
20086
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20087
+ }
20152
20088
  },
20153
20089
  {
20154
- "kind": "field",
20155
- "name": "variant",
20156
- "type": {
20157
- "text": "IconStyle"
20090
+ "kind": "method",
20091
+ "name": "scrollToPrevious",
20092
+ "privacy": "public",
20093
+ "return": {
20094
+ "type": {
20095
+ "text": "void"
20096
+ }
20158
20097
  },
20159
- "default": "'solid'"
20098
+ "description": "Scrolls items to the left",
20099
+ "inheritedFrom": {
20100
+ "name": "HorizontalScroll",
20101
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20102
+ }
20160
20103
  },
20161
20104
  {
20162
20105
  "kind": "method",
20163
- "name": "variantChanged",
20106
+ "name": "scrollToNext",
20107
+ "privacy": "public",
20108
+ "return": {
20109
+ "type": {
20110
+ "text": "void"
20111
+ }
20112
+ },
20113
+ "description": "Scrolls items to the right",
20114
+ "inheritedFrom": {
20115
+ "name": "HorizontalScroll",
20116
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20117
+ }
20118
+ },
20119
+ {
20120
+ "kind": "method",
20121
+ "name": "scrollToPosition",
20122
+ "privacy": "public",
20123
+ "return": {
20124
+ "type": {
20125
+ "text": "void"
20126
+ }
20127
+ },
20164
20128
  "parameters": [
20165
20129
  {
20166
- "name": "oldValue",
20130
+ "name": "newPosition",
20167
20131
  "type": {
20168
- "text": "string"
20169
- }
20132
+ "text": "number"
20133
+ },
20134
+ "description": "position to scroll to"
20170
20135
  },
20171
20136
  {
20172
- "name": "newValue",
20137
+ "name": "position",
20138
+ "default": "this.scrollContainer.scrollLeft",
20173
20139
  "type": {
20174
- "text": "string"
20175
- }
20140
+ "text": "number"
20141
+ },
20142
+ "description": "starting position"
20176
20143
  }
20177
- ]
20144
+ ],
20145
+ "description": "Handles scrolling with easing",
20146
+ "inheritedFrom": {
20147
+ "name": "HorizontalScroll",
20148
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20149
+ }
20178
20150
  },
20179
20151
  {
20180
20152
  "kind": "method",
20181
- "name": "loadIcon",
20182
- "privacy": "public"
20153
+ "name": "resized",
20154
+ "privacy": "public",
20155
+ "return": {
20156
+ "type": {
20157
+ "text": "void"
20158
+ }
20159
+ },
20160
+ "description": "Monitors resize event on the horizontal-scroll element",
20161
+ "inheritedFrom": {
20162
+ "name": "HorizontalScroll",
20163
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20164
+ }
20165
+ },
20166
+ {
20167
+ "kind": "method",
20168
+ "name": "scrolled",
20169
+ "privacy": "public",
20170
+ "return": {
20171
+ "type": {
20172
+ "text": "void"
20173
+ }
20174
+ },
20175
+ "description": "Monitors scrolled event on the content container",
20176
+ "inheritedFrom": {
20177
+ "name": "HorizontalScroll",
20178
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20179
+ }
20183
20180
  },
20184
20181
  {
20185
20182
  "kind": "field",
@@ -20293,83 +20290,86 @@
20293
20290
  }
20294
20291
  }
20295
20292
  ],
20296
- "attributes": [
20297
- {
20298
- "name": "name",
20299
- "type": {
20300
- "text": "IconName"
20301
- },
20302
- "fieldName": "name"
20303
- },
20293
+ "events": [
20304
20294
  {
20305
- "name": "size",
20306
- "type": {
20307
- "text": "FaSize"
20308
- },
20309
- "default": "'sm'",
20310
- "fieldName": "size"
20295
+ "description": "Fires a custom 'scrollstart' event when scrolling",
20296
+ "name": "scrollstart",
20297
+ "inheritedFrom": {
20298
+ "name": "HorizontalScroll",
20299
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20300
+ }
20311
20301
  },
20312
20302
  {
20313
- "name": "variant",
20314
- "type": {
20315
- "text": "IconStyle"
20316
- },
20317
- "default": "'solid'",
20318
- "fieldName": "variant"
20303
+ "description": "Fires a custom 'scrollend' event when scrolling stops",
20304
+ "name": "scrollend",
20305
+ "inheritedFrom": {
20306
+ "name": "HorizontalScroll",
20307
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20308
+ }
20319
20309
  }
20320
- ],
20321
- "superclass": {
20322
- "name": "FoundationElement",
20323
- "package": "@microsoft/fast-foundation"
20310
+ ]
20311
+ },
20312
+ {
20313
+ "kind": "variable",
20314
+ "name": "foundationHorizontalScrollShadowOptions",
20315
+ "type": {
20316
+ "text": "ShadowRootInit"
20324
20317
  },
20325
- "tagName": "%%prefix%%-icon",
20326
- "customElement": true
20318
+ "default": "{\n delegatesFocus: true,\n mode: 'open',\n}"
20327
20319
  },
20328
20320
  {
20329
20321
  "kind": "variable",
20330
- "name": "foundationIcon",
20331
- "description": "The Foundation Icon",
20322
+ "name": "defaultHorizontalScrollConfig",
20323
+ "type": {
20324
+ "text": "object"
20325
+ },
20326
+ "default": "{\n nextFlipper: html`\n <foundation-flipper\n @click=\"${(x) => x.scrollToNext()}\"\n aria-hidden=\"${(x) => x.flippersHiddenFromAT}\"\n ></foundation-flipper>\n `,\n previousFlipper: html`\n <foundation-flipper\n @click=\"${(x) => x.scrollToPrevious()}\"\n direction=\"previous\"\n aria-hidden=\"${(x) => x.flippersHiddenFromAT}\"\n ></foundation-flipper>\n `,\n}"
20327
+ },
20328
+ {
20329
+ "kind": "variable",
20330
+ "name": "foundationHorizontalScroll",
20331
+ "description": "The Foundation HorizontalScroll",
20332
20332
  "privacy": "public"
20333
20333
  }
20334
20334
  ],
20335
20335
  "exports": [
20336
20336
  {
20337
20337
  "kind": "js",
20338
- "name": "foundationIconShadowOptions",
20338
+ "name": "HorizontalScroll",
20339
20339
  "declaration": {
20340
- "name": "foundationIconShadowOptions",
20341
- "module": "src/icon/icon.ts"
20340
+ "name": "HorizontalScroll",
20341
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20342
20342
  }
20343
20343
  },
20344
20344
  {
20345
20345
  "kind": "js",
20346
- "name": "defaultIconConfig",
20346
+ "name": "foundationHorizontalScrollShadowOptions",
20347
20347
  "declaration": {
20348
- "name": "defaultIconConfig",
20349
- "module": "src/icon/icon.ts"
20348
+ "name": "foundationHorizontalScrollShadowOptions",
20349
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20350
20350
  }
20351
20351
  },
20352
20352
  {
20353
20353
  "kind": "js",
20354
- "name": "Icon",
20354
+ "name": "defaultHorizontalScrollConfig",
20355
20355
  "declaration": {
20356
- "name": "Icon",
20357
- "module": "src/icon/icon.ts"
20356
+ "name": "defaultHorizontalScrollConfig",
20357
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20358
20358
  }
20359
20359
  },
20360
20360
  {
20361
20361
  "kind": "js",
20362
- "name": "foundationIcon",
20362
+ "name": "foundationHorizontalScroll",
20363
20363
  "declaration": {
20364
- "name": "foundationIcon",
20365
- "module": "src/icon/icon.ts"
20364
+ "name": "foundationHorizontalScroll",
20365
+ "module": "src/horizontal-scroll/horizontal-scroll.ts"
20366
20366
  }
20367
20367
  }
20368
20368
  ]
20369
20369
  },
20370
20370
  {
20371
20371
  "kind": "javascript-module",
20372
- "path": "src/icon/index.ts",
20372
+ "path": "src/horizontal-scroll/index.ts",
20373
20373
  "declarations": [],
20374
20374
  "exports": [
20375
20375
  {
@@ -20377,7 +20377,7 @@
20377
20377
  "name": "*",
20378
20378
  "declaration": {
20379
20379
  "name": "*",
20380
- "package": "./icon.styles"
20380
+ "package": "./horizontal-scroll.template"
20381
20381
  }
20382
20382
  },
20383
20383
  {
@@ -20385,7 +20385,7 @@
20385
20385
  "name": "*",
20386
20386
  "declaration": {
20387
20387
  "name": "*",
20388
- "package": "./icon.template"
20388
+ "package": "./horizontal-scroll.styles"
20389
20389
  }
20390
20390
  },
20391
20391
  {
@@ -20393,7 +20393,7 @@
20393
20393
  "name": "*",
20394
20394
  "declaration": {
20395
20395
  "name": "*",
20396
- "package": "./icon"
20396
+ "package": "./horizontal-scroll"
20397
20397
  }
20398
20398
  }
20399
20399
  ]
@@ -25539,6 +25539,13 @@
25539
25539
  "text": "string"
25540
25540
  }
25541
25541
  },
25542
+ {
25543
+ "kind": "field",
25544
+ "name": "optionElement",
25545
+ "type": {
25546
+ "text": "string"
25547
+ }
25548
+ },
25542
25549
  {
25543
25550
  "kind": "field",
25544
25551
  "name": "valueField",
@@ -25585,15 +25592,6 @@
25585
25592
  },
25586
25593
  "privacy": "protected"
25587
25594
  },
25588
- {
25589
- "kind": "field",
25590
- "name": "optionElement",
25591
- "type": {
25592
- "text": "string"
25593
- },
25594
- "privacy": "public",
25595
- "default": "'fast-option'"
25596
- },
25597
25595
  {
25598
25596
  "kind": "field",
25599
25597
  "name": "isSnapshot",
@@ -26267,6 +26265,13 @@
26267
26265
  },
26268
26266
  "fieldName": "labelField"
26269
26267
  },
26268
+ {
26269
+ "name": "option-element",
26270
+ "type": {
26271
+ "text": "string"
26272
+ },
26273
+ "fieldName": "optionElement"
26274
+ },
26270
26275
  {
26271
26276
  "name": "value-field",
26272
26277
  "type": {