@ukic/docs 3.0.0-alpha.1 → 3.0.0-alpha.3
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.
- package/docs.json +335 -92
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -556,7 +556,7 @@
|
|
|
556
556
|
"mutable": false,
|
|
557
557
|
"attr": "show-default-icon",
|
|
558
558
|
"reflectToAttr": false,
|
|
559
|
-
"docs": "If `true`, the default icon for the neutral variant will
|
|
559
|
+
"docs": "If `true`, the default icon for the neutral variant will appear on the left of the alert.",
|
|
560
560
|
"docsTags": [],
|
|
561
561
|
"default": "true",
|
|
562
562
|
"values": [
|
|
@@ -3582,7 +3582,7 @@
|
|
|
3582
3582
|
"mutable": false,
|
|
3583
3583
|
"attr": "custom-color",
|
|
3584
3584
|
"reflectToAttr": false,
|
|
3585
|
-
"docs": "The custom chip colour. This
|
|
3585
|
+
"docs": "The custom chip colour. This will override the theme colour.\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
|
|
3586
3586
|
"docsTags": [],
|
|
3587
3587
|
"default": "null",
|
|
3588
3588
|
"values": [
|
|
@@ -3701,6 +3701,37 @@
|
|
|
3701
3701
|
"optional": true,
|
|
3702
3702
|
"required": false
|
|
3703
3703
|
},
|
|
3704
|
+
{
|
|
3705
|
+
"name": "theme",
|
|
3706
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
3707
|
+
"complexType": {
|
|
3708
|
+
"original": "\"dark\" | \"light\" | \"inherit\"",
|
|
3709
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
3710
|
+
"references": {}
|
|
3711
|
+
},
|
|
3712
|
+
"mutable": false,
|
|
3713
|
+
"attr": "theme",
|
|
3714
|
+
"reflectToAttr": false,
|
|
3715
|
+
"docs": "Sets the chip to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.\nSetting the \"customColor\" prop will override this.",
|
|
3716
|
+
"docsTags": [],
|
|
3717
|
+
"default": "\"inherit\"",
|
|
3718
|
+
"values": [
|
|
3719
|
+
{
|
|
3720
|
+
"value": "dark",
|
|
3721
|
+
"type": "string"
|
|
3722
|
+
},
|
|
3723
|
+
{
|
|
3724
|
+
"value": "inherit",
|
|
3725
|
+
"type": "string"
|
|
3726
|
+
},
|
|
3727
|
+
{
|
|
3728
|
+
"value": "light",
|
|
3729
|
+
"type": "string"
|
|
3730
|
+
}
|
|
3731
|
+
],
|
|
3732
|
+
"optional": true,
|
|
3733
|
+
"required": false
|
|
3734
|
+
},
|
|
3704
3735
|
{
|
|
3705
3736
|
"name": "transparentBackground",
|
|
3706
3737
|
"type": "boolean",
|
|
@@ -3712,7 +3743,7 @@
|
|
|
3712
3743
|
"mutable": false,
|
|
3713
3744
|
"attr": "transparent-background",
|
|
3714
3745
|
"reflectToAttr": false,
|
|
3715
|
-
"docs": "If `true`, the outlined variant of chip will have a transparent background rather than
|
|
3746
|
+
"docs": "If `true`, the outlined variant of chip will have a transparent background rather than the theme defined color.",
|
|
3716
3747
|
"docsTags": [],
|
|
3717
3748
|
"default": "true",
|
|
3718
3749
|
"values": [
|
|
@@ -6318,6 +6349,28 @@
|
|
|
6318
6349
|
"optional": false,
|
|
6319
6350
|
"required": false
|
|
6320
6351
|
},
|
|
6352
|
+
{
|
|
6353
|
+
"name": "hideLabel",
|
|
6354
|
+
"type": "boolean",
|
|
6355
|
+
"complexType": {
|
|
6356
|
+
"original": "boolean",
|
|
6357
|
+
"resolved": "boolean",
|
|
6358
|
+
"references": {}
|
|
6359
|
+
},
|
|
6360
|
+
"mutable": false,
|
|
6361
|
+
"attr": "hide-label",
|
|
6362
|
+
"reflectToAttr": false,
|
|
6363
|
+
"docs": "The label will be visually hidden.",
|
|
6364
|
+
"docsTags": [],
|
|
6365
|
+
"default": "false",
|
|
6366
|
+
"values": [
|
|
6367
|
+
{
|
|
6368
|
+
"type": "boolean"
|
|
6369
|
+
}
|
|
6370
|
+
],
|
|
6371
|
+
"optional": false,
|
|
6372
|
+
"required": false
|
|
6373
|
+
},
|
|
6321
6374
|
{
|
|
6322
6375
|
"name": "label",
|
|
6323
6376
|
"type": "string",
|
|
@@ -6943,39 +6996,6 @@
|
|
|
6943
6996
|
"docsTags": [],
|
|
6944
6997
|
"usage": {},
|
|
6945
6998
|
"props": [
|
|
6946
|
-
{
|
|
6947
|
-
"name": "appearance",
|
|
6948
|
-
"type": "\"dark\" | \"light\"",
|
|
6949
|
-
"complexType": {
|
|
6950
|
-
"original": "IcThemeForegroundNoDefault",
|
|
6951
|
-
"resolved": "\"dark\" | \"light\"",
|
|
6952
|
-
"references": {
|
|
6953
|
-
"IcThemeForegroundNoDefault": {
|
|
6954
|
-
"location": "import",
|
|
6955
|
-
"path": "../../utils/types",
|
|
6956
|
-
"id": "src/utils/types.ts::IcThemeForegroundNoDefault"
|
|
6957
|
-
}
|
|
6958
|
-
}
|
|
6959
|
-
},
|
|
6960
|
-
"mutable": false,
|
|
6961
|
-
"attr": "appearance",
|
|
6962
|
-
"reflectToAttr": false,
|
|
6963
|
-
"docs": "The appearance of the loading indicator, e.g. dark or light.",
|
|
6964
|
-
"docsTags": [],
|
|
6965
|
-
"default": "\"dark\"",
|
|
6966
|
-
"values": [
|
|
6967
|
-
{
|
|
6968
|
-
"value": "dark",
|
|
6969
|
-
"type": "string"
|
|
6970
|
-
},
|
|
6971
|
-
{
|
|
6972
|
-
"value": "light",
|
|
6973
|
-
"type": "string"
|
|
6974
|
-
}
|
|
6975
|
-
],
|
|
6976
|
-
"optional": true,
|
|
6977
|
-
"required": false
|
|
6978
|
-
},
|
|
6979
6999
|
{
|
|
6980
7000
|
"name": "description",
|
|
6981
7001
|
"type": "string",
|
|
@@ -7110,6 +7130,28 @@
|
|
|
7110
7130
|
"optional": true,
|
|
7111
7131
|
"required": false
|
|
7112
7132
|
},
|
|
7133
|
+
{
|
|
7134
|
+
"name": "monochrome",
|
|
7135
|
+
"type": "boolean",
|
|
7136
|
+
"complexType": {
|
|
7137
|
+
"original": "boolean",
|
|
7138
|
+
"resolved": "boolean",
|
|
7139
|
+
"references": {}
|
|
7140
|
+
},
|
|
7141
|
+
"mutable": false,
|
|
7142
|
+
"attr": "monochrome",
|
|
7143
|
+
"reflectToAttr": false,
|
|
7144
|
+
"docs": "If `true`, the element will display as black and white.",
|
|
7145
|
+
"docsTags": [],
|
|
7146
|
+
"default": "false",
|
|
7147
|
+
"values": [
|
|
7148
|
+
{
|
|
7149
|
+
"type": "boolean"
|
|
7150
|
+
}
|
|
7151
|
+
],
|
|
7152
|
+
"optional": true,
|
|
7153
|
+
"required": false
|
|
7154
|
+
},
|
|
7113
7155
|
{
|
|
7114
7156
|
"name": "progress",
|
|
7115
7157
|
"type": "number",
|
|
@@ -7172,6 +7214,43 @@
|
|
|
7172
7214
|
"optional": true,
|
|
7173
7215
|
"required": false
|
|
7174
7216
|
},
|
|
7217
|
+
{
|
|
7218
|
+
"name": "theme",
|
|
7219
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
7220
|
+
"complexType": {
|
|
7221
|
+
"original": "IcThemeMode",
|
|
7222
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
7223
|
+
"references": {
|
|
7224
|
+
"IcThemeMode": {
|
|
7225
|
+
"location": "import",
|
|
7226
|
+
"path": "../../utils/types",
|
|
7227
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
7228
|
+
}
|
|
7229
|
+
}
|
|
7230
|
+
},
|
|
7231
|
+
"mutable": false,
|
|
7232
|
+
"attr": "theme",
|
|
7233
|
+
"reflectToAttr": false,
|
|
7234
|
+
"docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
|
|
7235
|
+
"docsTags": [],
|
|
7236
|
+
"default": "\"inherit\"",
|
|
7237
|
+
"values": [
|
|
7238
|
+
{
|
|
7239
|
+
"value": "dark",
|
|
7240
|
+
"type": "string"
|
|
7241
|
+
},
|
|
7242
|
+
{
|
|
7243
|
+
"value": "inherit",
|
|
7244
|
+
"type": "string"
|
|
7245
|
+
},
|
|
7246
|
+
{
|
|
7247
|
+
"value": "light",
|
|
7248
|
+
"type": "string"
|
|
7249
|
+
}
|
|
7250
|
+
],
|
|
7251
|
+
"optional": false,
|
|
7252
|
+
"required": false
|
|
7253
|
+
},
|
|
7175
7254
|
{
|
|
7176
7255
|
"name": "type",
|
|
7177
7256
|
"type": "\"circular\" | \"linear\"",
|
|
@@ -7317,6 +7396,28 @@
|
|
|
7317
7396
|
"optional": false,
|
|
7318
7397
|
"required": true
|
|
7319
7398
|
},
|
|
7399
|
+
{
|
|
7400
|
+
"name": "closeOnSelect",
|
|
7401
|
+
"type": "boolean",
|
|
7402
|
+
"complexType": {
|
|
7403
|
+
"original": "boolean",
|
|
7404
|
+
"resolved": "boolean",
|
|
7405
|
+
"references": {}
|
|
7406
|
+
},
|
|
7407
|
+
"mutable": false,
|
|
7408
|
+
"attr": "close-on-select",
|
|
7409
|
+
"reflectToAttr": false,
|
|
7410
|
+
"docs": "If `true`, the menu will close when an option is selected.",
|
|
7411
|
+
"docsTags": [],
|
|
7412
|
+
"default": "true",
|
|
7413
|
+
"values": [
|
|
7414
|
+
{
|
|
7415
|
+
"type": "boolean"
|
|
7416
|
+
}
|
|
7417
|
+
],
|
|
7418
|
+
"optional": false,
|
|
7419
|
+
"required": false
|
|
7420
|
+
},
|
|
7320
7421
|
{
|
|
7321
7422
|
"name": "fullWidth",
|
|
7322
7423
|
"type": "boolean",
|
|
@@ -7525,7 +7626,7 @@
|
|
|
7525
7626
|
"mutable": false,
|
|
7526
7627
|
"attr": "size",
|
|
7527
7628
|
"reflectToAttr": false,
|
|
7528
|
-
"docs": "The size of the menu
|
|
7629
|
+
"docs": "The size of the menu.",
|
|
7529
7630
|
"docsTags": [],
|
|
7530
7631
|
"default": "\"medium\"",
|
|
7531
7632
|
"values": [
|
|
@@ -7547,20 +7648,23 @@
|
|
|
7547
7648
|
},
|
|
7548
7649
|
{
|
|
7549
7650
|
"name": "value",
|
|
7550
|
-
"type": "string",
|
|
7651
|
+
"type": "string | string[]",
|
|
7551
7652
|
"complexType": {
|
|
7552
|
-
"original": "string",
|
|
7553
|
-
"resolved": "string",
|
|
7653
|
+
"original": "string | string[]",
|
|
7654
|
+
"resolved": "string | string[]",
|
|
7554
7655
|
"references": {}
|
|
7555
7656
|
},
|
|
7556
|
-
"mutable":
|
|
7657
|
+
"mutable": false,
|
|
7557
7658
|
"attr": "value",
|
|
7558
7659
|
"reflectToAttr": false,
|
|
7559
|
-
"docs": "The value of the currently selected option.",
|
|
7660
|
+
"docs": "The value of the currently selected option - or array of values (if multiple options allowed).",
|
|
7560
7661
|
"docsTags": [],
|
|
7561
7662
|
"values": [
|
|
7562
7663
|
{
|
|
7563
7664
|
"type": "string"
|
|
7665
|
+
},
|
|
7666
|
+
{
|
|
7667
|
+
"type": "string[]"
|
|
7564
7668
|
}
|
|
7565
7669
|
],
|
|
7566
7670
|
"optional": false,
|
|
@@ -9849,6 +9953,43 @@
|
|
|
9849
9953
|
],
|
|
9850
9954
|
"optional": true,
|
|
9851
9955
|
"required": false
|
|
9956
|
+
},
|
|
9957
|
+
{
|
|
9958
|
+
"name": "theme",
|
|
9959
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
9960
|
+
"complexType": {
|
|
9961
|
+
"original": "IcThemeMode",
|
|
9962
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
9963
|
+
"references": {
|
|
9964
|
+
"IcThemeMode": {
|
|
9965
|
+
"location": "import",
|
|
9966
|
+
"path": "../../utils/types",
|
|
9967
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
9968
|
+
}
|
|
9969
|
+
}
|
|
9970
|
+
},
|
|
9971
|
+
"mutable": false,
|
|
9972
|
+
"attr": "theme",
|
|
9973
|
+
"reflectToAttr": false,
|
|
9974
|
+
"docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
|
|
9975
|
+
"docsTags": [],
|
|
9976
|
+
"default": "\"inherit\"",
|
|
9977
|
+
"values": [
|
|
9978
|
+
{
|
|
9979
|
+
"value": "dark",
|
|
9980
|
+
"type": "string"
|
|
9981
|
+
},
|
|
9982
|
+
{
|
|
9983
|
+
"value": "inherit",
|
|
9984
|
+
"type": "string"
|
|
9985
|
+
},
|
|
9986
|
+
{
|
|
9987
|
+
"value": "light",
|
|
9988
|
+
"type": "string"
|
|
9989
|
+
}
|
|
9990
|
+
],
|
|
9991
|
+
"optional": true,
|
|
9992
|
+
"required": false
|
|
9852
9993
|
}
|
|
9853
9994
|
],
|
|
9854
9995
|
"methods": [],
|
|
@@ -11986,7 +12127,7 @@
|
|
|
11986
12127
|
"mutable": false,
|
|
11987
12128
|
"attr": "full-width",
|
|
11988
12129
|
"reflectToAttr": false,
|
|
11989
|
-
"docs": "If `true`, the select
|
|
12130
|
+
"docs": "If `true`, the select will fill the width of the container.",
|
|
11990
12131
|
"docsTags": [],
|
|
11991
12132
|
"default": "false",
|
|
11992
12133
|
"values": [
|
|
@@ -12172,6 +12313,28 @@
|
|
|
12172
12313
|
"optional": true,
|
|
12173
12314
|
"required": false
|
|
12174
12315
|
},
|
|
12316
|
+
{
|
|
12317
|
+
"name": "multiple",
|
|
12318
|
+
"type": "boolean",
|
|
12319
|
+
"complexType": {
|
|
12320
|
+
"original": "boolean",
|
|
12321
|
+
"resolved": "boolean",
|
|
12322
|
+
"references": {}
|
|
12323
|
+
},
|
|
12324
|
+
"mutable": false,
|
|
12325
|
+
"attr": "multiple",
|
|
12326
|
+
"reflectToAttr": false,
|
|
12327
|
+
"docs": "If `true`, multiple options can be selected.",
|
|
12328
|
+
"docsTags": [],
|
|
12329
|
+
"default": "false",
|
|
12330
|
+
"values": [
|
|
12331
|
+
{
|
|
12332
|
+
"type": "boolean"
|
|
12333
|
+
}
|
|
12334
|
+
],
|
|
12335
|
+
"optional": true,
|
|
12336
|
+
"required": false
|
|
12337
|
+
},
|
|
12175
12338
|
{
|
|
12176
12339
|
"name": "name",
|
|
12177
12340
|
"type": "string",
|
|
@@ -12353,7 +12516,7 @@
|
|
|
12353
12516
|
"mutable": false,
|
|
12354
12517
|
"attr": "select-on-enter",
|
|
12355
12518
|
"reflectToAttr": false,
|
|
12356
|
-
"docs": "If `true`, the icOptionSelect event will be fired on enter instead of ArrowUp and ArrowDown.",
|
|
12519
|
+
"docs": "If `true`, the icOptionSelect event will be fired on enter instead of ArrowUp and ArrowDown on the single select.",
|
|
12357
12520
|
"docsTags": [],
|
|
12358
12521
|
"default": "false",
|
|
12359
12522
|
"values": [
|
|
@@ -12403,7 +12566,7 @@
|
|
|
12403
12566
|
"mutable": false,
|
|
12404
12567
|
"attr": "size",
|
|
12405
12568
|
"reflectToAttr": false,
|
|
12406
|
-
"docs": "The size of the select
|
|
12569
|
+
"docs": "The size of the select.",
|
|
12407
12570
|
"docsTags": [],
|
|
12408
12571
|
"default": "\"medium\"",
|
|
12409
12572
|
"values": [
|
|
@@ -12508,20 +12671,23 @@
|
|
|
12508
12671
|
},
|
|
12509
12672
|
{
|
|
12510
12673
|
"name": "value",
|
|
12511
|
-
"type": "string",
|
|
12674
|
+
"type": "string | string[]",
|
|
12512
12675
|
"complexType": {
|
|
12513
|
-
"original": "string",
|
|
12514
|
-
"resolved": "string",
|
|
12676
|
+
"original": "string | string[]",
|
|
12677
|
+
"resolved": "string | string[]",
|
|
12515
12678
|
"references": {}
|
|
12516
12679
|
},
|
|
12517
12680
|
"mutable": true,
|
|
12518
12681
|
"attr": "value",
|
|
12519
12682
|
"reflectToAttr": false,
|
|
12520
|
-
"docs": "The value of the select, reflected by the value of the currently selected option
|
|
12683
|
+
"docs": "The value of the select, reflected by the value of the currently selected option.\nFor the searchable variant, the value is also reflected by the user input.\nFor the multi-select variant, the value must be an array of option values.",
|
|
12521
12684
|
"docsTags": [],
|
|
12522
12685
|
"values": [
|
|
12523
12686
|
{
|
|
12524
12687
|
"type": "string"
|
|
12688
|
+
},
|
|
12689
|
+
{
|
|
12690
|
+
"type": "string[]"
|
|
12525
12691
|
}
|
|
12526
12692
|
],
|
|
12527
12693
|
"optional": true,
|
|
@@ -12663,6 +12829,26 @@
|
|
|
12663
12829
|
"docs": "Emitted when the select options menu is opened.",
|
|
12664
12830
|
"docsTags": []
|
|
12665
12831
|
},
|
|
12832
|
+
{
|
|
12833
|
+
"event": "icOptionDeselect",
|
|
12834
|
+
"detail": "IcOptionSelectEventDetail",
|
|
12835
|
+
"bubbles": true,
|
|
12836
|
+
"complexType": {
|
|
12837
|
+
"original": "IcOptionSelectEventDetail",
|
|
12838
|
+
"resolved": "IcOptionSelectEventDetail",
|
|
12839
|
+
"references": {
|
|
12840
|
+
"IcOptionSelectEventDetail": {
|
|
12841
|
+
"location": "import",
|
|
12842
|
+
"path": "../ic-menu/ic-menu.types",
|
|
12843
|
+
"id": "src/components/ic-menu/ic-menu.types.ts::IcOptionSelectEventDetail"
|
|
12844
|
+
}
|
|
12845
|
+
}
|
|
12846
|
+
},
|
|
12847
|
+
"cancelable": true,
|
|
12848
|
+
"composed": true,
|
|
12849
|
+
"docs": "Emitted when `multiple` is `true` and an option is deselected.",
|
|
12850
|
+
"docsTags": []
|
|
12851
|
+
},
|
|
12666
12852
|
{
|
|
12667
12853
|
"event": "icOptionSelect",
|
|
12668
12854
|
"detail": "IcOptionSelectEventDetail",
|
|
@@ -12680,7 +12866,7 @@
|
|
|
12680
12866
|
},
|
|
12681
12867
|
"cancelable": true,
|
|
12682
12868
|
"composed": true,
|
|
12683
|
-
"docs": "Emitted when an option is
|
|
12869
|
+
"docs": "Emitted when an option is selected.\nSelecting an option will also trigger an `icChange/onIcChange` due to the value being updated.",
|
|
12684
12870
|
"docsTags": []
|
|
12685
12871
|
},
|
|
12686
12872
|
{
|
|
@@ -12715,6 +12901,11 @@
|
|
|
12715
12901
|
"name": "--input-width",
|
|
12716
12902
|
"annotation": "prop",
|
|
12717
12903
|
"docs": "Width of the input field"
|
|
12904
|
+
},
|
|
12905
|
+
{
|
|
12906
|
+
"name": "--menu-width",
|
|
12907
|
+
"annotation": "prop",
|
|
12908
|
+
"docs": "Width of the dropdown menu"
|
|
12718
12909
|
}
|
|
12719
12910
|
],
|
|
12720
12911
|
"slots": [
|
|
@@ -13102,22 +13293,32 @@
|
|
|
13102
13293
|
"usage": {},
|
|
13103
13294
|
"props": [
|
|
13104
13295
|
{
|
|
13105
|
-
"name": "
|
|
13106
|
-
"type": "\"
|
|
13296
|
+
"name": "theme",
|
|
13297
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
13107
13298
|
"complexType": {
|
|
13108
|
-
"original": "
|
|
13109
|
-
"resolved": "\"
|
|
13110
|
-
"references": {
|
|
13299
|
+
"original": "IcThemeMode",
|
|
13300
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
13301
|
+
"references": {
|
|
13302
|
+
"IcThemeMode": {
|
|
13303
|
+
"location": "import",
|
|
13304
|
+
"path": "../../utils/types",
|
|
13305
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
13306
|
+
}
|
|
13307
|
+
}
|
|
13111
13308
|
},
|
|
13112
13309
|
"mutable": false,
|
|
13113
|
-
"attr": "
|
|
13310
|
+
"attr": "theme",
|
|
13114
13311
|
"reflectToAttr": false,
|
|
13115
|
-
"docs": "
|
|
13312
|
+
"docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
|
|
13116
13313
|
"docsTags": [],
|
|
13117
|
-
"default": "\"
|
|
13314
|
+
"default": "\"inherit\"",
|
|
13118
13315
|
"values": [
|
|
13119
13316
|
{
|
|
13120
|
-
"value": "
|
|
13317
|
+
"value": "dark",
|
|
13318
|
+
"type": "string"
|
|
13319
|
+
},
|
|
13320
|
+
{
|
|
13321
|
+
"value": "inherit",
|
|
13121
13322
|
"type": "string"
|
|
13122
13323
|
},
|
|
13123
13324
|
{
|
|
@@ -13575,33 +13776,6 @@
|
|
|
13575
13776
|
"optional": true,
|
|
13576
13777
|
"required": false
|
|
13577
13778
|
},
|
|
13578
|
-
{
|
|
13579
|
-
"name": "appearance",
|
|
13580
|
-
"type": "\"default\" | \"light\"",
|
|
13581
|
-
"complexType": {
|
|
13582
|
-
"original": "\"light\" | \"default\"",
|
|
13583
|
-
"resolved": "\"default\" | \"light\"",
|
|
13584
|
-
"references": {}
|
|
13585
|
-
},
|
|
13586
|
-
"mutable": false,
|
|
13587
|
-
"attr": "appearance",
|
|
13588
|
-
"reflectToAttr": false,
|
|
13589
|
-
"docs": "The appearance of the stepper.",
|
|
13590
|
-
"docsTags": [],
|
|
13591
|
-
"default": "\"default\"",
|
|
13592
|
-
"values": [
|
|
13593
|
-
{
|
|
13594
|
-
"value": "default",
|
|
13595
|
-
"type": "string"
|
|
13596
|
-
},
|
|
13597
|
-
{
|
|
13598
|
-
"value": "light",
|
|
13599
|
-
"type": "string"
|
|
13600
|
-
}
|
|
13601
|
-
],
|
|
13602
|
-
"optional": true,
|
|
13603
|
-
"required": false
|
|
13604
|
-
},
|
|
13605
13779
|
{
|
|
13606
13780
|
"name": "connectorWidth",
|
|
13607
13781
|
"type": "number",
|
|
@@ -13646,6 +13820,43 @@
|
|
|
13646
13820
|
"optional": true,
|
|
13647
13821
|
"required": false
|
|
13648
13822
|
},
|
|
13823
|
+
{
|
|
13824
|
+
"name": "theme",
|
|
13825
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
13826
|
+
"complexType": {
|
|
13827
|
+
"original": "IcThemeMode",
|
|
13828
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
13829
|
+
"references": {
|
|
13830
|
+
"IcThemeMode": {
|
|
13831
|
+
"location": "import",
|
|
13832
|
+
"path": "../../utils/types",
|
|
13833
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
13834
|
+
}
|
|
13835
|
+
}
|
|
13836
|
+
},
|
|
13837
|
+
"mutable": false,
|
|
13838
|
+
"attr": "theme",
|
|
13839
|
+
"reflectToAttr": false,
|
|
13840
|
+
"docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
|
|
13841
|
+
"docsTags": [],
|
|
13842
|
+
"default": "\"inherit\"",
|
|
13843
|
+
"values": [
|
|
13844
|
+
{
|
|
13845
|
+
"value": "dark",
|
|
13846
|
+
"type": "string"
|
|
13847
|
+
},
|
|
13848
|
+
{
|
|
13849
|
+
"value": "inherit",
|
|
13850
|
+
"type": "string"
|
|
13851
|
+
},
|
|
13852
|
+
{
|
|
13853
|
+
"value": "light",
|
|
13854
|
+
"type": "string"
|
|
13855
|
+
}
|
|
13856
|
+
],
|
|
13857
|
+
"optional": true,
|
|
13858
|
+
"required": false
|
|
13859
|
+
},
|
|
13649
13860
|
{
|
|
13650
13861
|
"name": "variant",
|
|
13651
13862
|
"type": "\"compact\" | \"default\"",
|
|
@@ -13890,6 +14101,43 @@
|
|
|
13890
14101
|
"optional": true,
|
|
13891
14102
|
"required": false
|
|
13892
14103
|
},
|
|
14104
|
+
{
|
|
14105
|
+
"name": "theme",
|
|
14106
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
14107
|
+
"complexType": {
|
|
14108
|
+
"original": "IcThemeMode",
|
|
14109
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
14110
|
+
"references": {
|
|
14111
|
+
"IcThemeMode": {
|
|
14112
|
+
"location": "import",
|
|
14113
|
+
"path": "../../utils/types",
|
|
14114
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
14115
|
+
}
|
|
14116
|
+
}
|
|
14117
|
+
},
|
|
14118
|
+
"mutable": false,
|
|
14119
|
+
"attr": "theme",
|
|
14120
|
+
"reflectToAttr": false,
|
|
14121
|
+
"docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
|
|
14122
|
+
"docsTags": [],
|
|
14123
|
+
"default": "\"inherit\"",
|
|
14124
|
+
"values": [
|
|
14125
|
+
{
|
|
14126
|
+
"value": "dark",
|
|
14127
|
+
"type": "string"
|
|
14128
|
+
},
|
|
14129
|
+
{
|
|
14130
|
+
"value": "inherit",
|
|
14131
|
+
"type": "string"
|
|
14132
|
+
},
|
|
14133
|
+
{
|
|
14134
|
+
"value": "light",
|
|
14135
|
+
"type": "string"
|
|
14136
|
+
}
|
|
14137
|
+
],
|
|
14138
|
+
"optional": true,
|
|
14139
|
+
"required": false
|
|
14140
|
+
},
|
|
13893
14141
|
{
|
|
13894
14142
|
"name": "value",
|
|
13895
14143
|
"type": "string",
|
|
@@ -17893,7 +18141,7 @@
|
|
|
17893
18141
|
"path": "src/components/ic-text-field/ic-text-field.types.ts"
|
|
17894
18142
|
},
|
|
17895
18143
|
"src/utils/types.ts::IcValueEventDetail": {
|
|
17896
|
-
"declaration": "export interface IcValueEventDetail {\n value: string;\n keyPressed?: string;\n}",
|
|
18144
|
+
"declaration": "export interface IcValueEventDetail {\n value: string | string[];\n keyPressed?: string;\n}",
|
|
17897
18145
|
"docstring": "",
|
|
17898
18146
|
"path": "src/utils/types.ts"
|
|
17899
18147
|
},
|
|
@@ -17917,11 +18165,6 @@
|
|
|
17917
18165
|
"docstring": "",
|
|
17918
18166
|
"path": "src/components/ic-input-validation/ic-input-validation.types.tsx"
|
|
17919
18167
|
},
|
|
17920
|
-
"src/utils/types.ts::IcThemeForegroundNoDefault": {
|
|
17921
|
-
"declaration": "export type IcThemeForegroundNoDefault = \"dark\" | \"light\";",
|
|
17922
|
-
"docstring": "",
|
|
17923
|
-
"path": "src/utils/types.ts"
|
|
17924
|
-
},
|
|
17925
18168
|
"src/components/ic-loading-indicator/ic-loading-indicator.types.tsx::IcLoadingSizes": {
|
|
17926
18169
|
"declaration": "export type IcLoadingSizes = \"medium\" | \"small\" | \"large\" | \"icon\";",
|
|
17927
18170
|
"docstring": "",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/docs",
|
|
4
|
-
"version": "3.0.0-alpha.
|
|
4
|
+
"version": "3.0.0-alpha.3",
|
|
5
5
|
"description": "API documentation for @ukic components",
|
|
6
6
|
"main": "docs.json",
|
|
7
7
|
"types": "docs.d.ts",
|
|
@@ -18,5 +18,5 @@
|
|
|
18
18
|
"email": "icds@gchq.gov.uk"
|
|
19
19
|
},
|
|
20
20
|
"license": "MIT",
|
|
21
|
-
"gitHead": "
|
|
21
|
+
"gitHead": "e2f5cd049a05214c50b3bb26dd3806318f18075f"
|
|
22
22
|
}
|