@ukic/docs 2.9.2 → 2.9.4
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 +211 -13
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"timestamp": "2024-
|
|
2
|
+
"timestamp": "2024-02-28T15:28:24",
|
|
3
3
|
"compiler": {
|
|
4
4
|
"name": "@stencil/core",
|
|
5
|
-
"version": "4.
|
|
6
|
-
"typescriptVersion": "5.
|
|
5
|
+
"version": "4.10.0",
|
|
6
|
+
"typescriptVersion": "5.3.3"
|
|
7
7
|
},
|
|
8
8
|
"components": [
|
|
9
9
|
{
|
|
@@ -1335,6 +1335,28 @@
|
|
|
1335
1335
|
],
|
|
1336
1336
|
"usage": {},
|
|
1337
1337
|
"props": [
|
|
1338
|
+
{
|
|
1339
|
+
"name": "accept",
|
|
1340
|
+
"type": "string",
|
|
1341
|
+
"complexType": {
|
|
1342
|
+
"original": "string",
|
|
1343
|
+
"resolved": "string",
|
|
1344
|
+
"references": {}
|
|
1345
|
+
},
|
|
1346
|
+
"mutable": false,
|
|
1347
|
+
"attr": "accept",
|
|
1348
|
+
"reflectToAttr": false,
|
|
1349
|
+
"docs": "If `fileUpload` is set to `true`, this is the accepted list of file types.",
|
|
1350
|
+
"docsTags": [],
|
|
1351
|
+
"default": "\"*\"",
|
|
1352
|
+
"values": [
|
|
1353
|
+
{
|
|
1354
|
+
"type": "string"
|
|
1355
|
+
}
|
|
1356
|
+
],
|
|
1357
|
+
"optional": true,
|
|
1358
|
+
"required": false
|
|
1359
|
+
},
|
|
1338
1360
|
{
|
|
1339
1361
|
"name": "appearance",
|
|
1340
1362
|
"type": "\"dark\" | \"default\" | \"light\"",
|
|
@@ -1485,6 +1507,50 @@
|
|
|
1485
1507
|
"optional": true,
|
|
1486
1508
|
"required": false
|
|
1487
1509
|
},
|
|
1510
|
+
{
|
|
1511
|
+
"name": "fileInputName",
|
|
1512
|
+
"type": "string",
|
|
1513
|
+
"complexType": {
|
|
1514
|
+
"original": "string",
|
|
1515
|
+
"resolved": "string",
|
|
1516
|
+
"references": {}
|
|
1517
|
+
},
|
|
1518
|
+
"mutable": false,
|
|
1519
|
+
"attr": "file-input-name",
|
|
1520
|
+
"reflectToAttr": false,
|
|
1521
|
+
"docs": "The name of the control for the file input, which is submitted with the form data.",
|
|
1522
|
+
"docsTags": [],
|
|
1523
|
+
"default": "`ic-button-file-upload-input-${buttonIds++}`",
|
|
1524
|
+
"values": [
|
|
1525
|
+
{
|
|
1526
|
+
"type": "string"
|
|
1527
|
+
}
|
|
1528
|
+
],
|
|
1529
|
+
"optional": false,
|
|
1530
|
+
"required": false
|
|
1531
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
"name": "fileUpload",
|
|
1534
|
+
"type": "boolean",
|
|
1535
|
+
"complexType": {
|
|
1536
|
+
"original": "boolean",
|
|
1537
|
+
"resolved": "boolean",
|
|
1538
|
+
"references": {}
|
|
1539
|
+
},
|
|
1540
|
+
"mutable": false,
|
|
1541
|
+
"attr": "file-upload",
|
|
1542
|
+
"reflectToAttr": false,
|
|
1543
|
+
"docs": "If `true`, when the button is clicked the native file explorer will be launched.",
|
|
1544
|
+
"docsTags": [],
|
|
1545
|
+
"default": "false",
|
|
1546
|
+
"values": [
|
|
1547
|
+
{
|
|
1548
|
+
"type": "boolean"
|
|
1549
|
+
}
|
|
1550
|
+
],
|
|
1551
|
+
"optional": true,
|
|
1552
|
+
"required": false
|
|
1553
|
+
},
|
|
1488
1554
|
{
|
|
1489
1555
|
"name": "form",
|
|
1490
1556
|
"type": "string",
|
|
@@ -1697,6 +1763,28 @@
|
|
|
1697
1763
|
"optional": true,
|
|
1698
1764
|
"required": false
|
|
1699
1765
|
},
|
|
1766
|
+
{
|
|
1767
|
+
"name": "multiple",
|
|
1768
|
+
"type": "boolean",
|
|
1769
|
+
"complexType": {
|
|
1770
|
+
"original": "boolean",
|
|
1771
|
+
"resolved": "boolean",
|
|
1772
|
+
"references": {}
|
|
1773
|
+
},
|
|
1774
|
+
"mutable": false,
|
|
1775
|
+
"attr": "multiple",
|
|
1776
|
+
"reflectToAttr": false,
|
|
1777
|
+
"docs": "If `fileUpload` is set to `true`, this boolean determines whether multiple files are accepted.",
|
|
1778
|
+
"docsTags": [],
|
|
1779
|
+
"default": "false",
|
|
1780
|
+
"values": [
|
|
1781
|
+
{
|
|
1782
|
+
"type": "boolean"
|
|
1783
|
+
}
|
|
1784
|
+
],
|
|
1785
|
+
"optional": true,
|
|
1786
|
+
"required": false
|
|
1787
|
+
},
|
|
1700
1788
|
{
|
|
1701
1789
|
"name": "referrerpolicy",
|
|
1702
1790
|
"type": "\"\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\"",
|
|
@@ -1776,6 +1864,31 @@
|
|
|
1776
1864
|
"optional": true,
|
|
1777
1865
|
"required": false
|
|
1778
1866
|
},
|
|
1867
|
+
{
|
|
1868
|
+
"name": "selectedFiles",
|
|
1869
|
+
"type": "FileList",
|
|
1870
|
+
"complexType": {
|
|
1871
|
+
"original": "FileList",
|
|
1872
|
+
"resolved": "FileList",
|
|
1873
|
+
"references": {
|
|
1874
|
+
"FileList": {
|
|
1875
|
+
"location": "global",
|
|
1876
|
+
"id": "global::FileList"
|
|
1877
|
+
}
|
|
1878
|
+
}
|
|
1879
|
+
},
|
|
1880
|
+
"mutable": false,
|
|
1881
|
+
"reflectToAttr": false,
|
|
1882
|
+
"docs": "The list of the files that have been selected by a user.",
|
|
1883
|
+
"docsTags": [],
|
|
1884
|
+
"values": [
|
|
1885
|
+
{
|
|
1886
|
+
"type": "FileList"
|
|
1887
|
+
}
|
|
1888
|
+
],
|
|
1889
|
+
"optional": false,
|
|
1890
|
+
"required": false
|
|
1891
|
+
},
|
|
1779
1892
|
{
|
|
1780
1893
|
"name": "size",
|
|
1781
1894
|
"type": "\"default\" | \"large\" | \"small\"",
|
|
@@ -2019,6 +2132,25 @@
|
|
|
2019
2132
|
"docs": "Emitted when button has blur",
|
|
2020
2133
|
"docsTags": []
|
|
2021
2134
|
},
|
|
2135
|
+
{
|
|
2136
|
+
"event": "icFileSelection",
|
|
2137
|
+
"detail": "FileList",
|
|
2138
|
+
"bubbles": true,
|
|
2139
|
+
"complexType": {
|
|
2140
|
+
"original": "FileList",
|
|
2141
|
+
"resolved": "FileList",
|
|
2142
|
+
"references": {
|
|
2143
|
+
"FileList": {
|
|
2144
|
+
"location": "global",
|
|
2145
|
+
"id": "global::FileList"
|
|
2146
|
+
}
|
|
2147
|
+
}
|
|
2148
|
+
},
|
|
2149
|
+
"cancelable": true,
|
|
2150
|
+
"composed": true,
|
|
2151
|
+
"docs": "If `fileUpload` is set to `true`, this will be emitted when a file is selected in the native explorer.",
|
|
2152
|
+
"docsTags": []
|
|
2153
|
+
},
|
|
2022
2154
|
{
|
|
2023
2155
|
"event": "icFocus",
|
|
2024
2156
|
"detail": "void",
|
|
@@ -2318,15 +2450,15 @@
|
|
|
2318
2450
|
"mutable": false,
|
|
2319
2451
|
"attr": "heading",
|
|
2320
2452
|
"reflectToAttr": false,
|
|
2321
|
-
"docs": "The heading for the card.",
|
|
2453
|
+
"docs": "The heading for the card. This is required, unless a slotted heading is used.",
|
|
2322
2454
|
"docsTags": [],
|
|
2323
2455
|
"values": [
|
|
2324
2456
|
{
|
|
2325
2457
|
"type": "string"
|
|
2326
2458
|
}
|
|
2327
2459
|
],
|
|
2328
|
-
"optional":
|
|
2329
|
-
"required":
|
|
2460
|
+
"optional": true,
|
|
2461
|
+
"required": false
|
|
2330
2462
|
},
|
|
2331
2463
|
{
|
|
2332
2464
|
"name": "href",
|
|
@@ -4374,6 +4506,28 @@
|
|
|
4374
4506
|
"optional": true,
|
|
4375
4507
|
"required": false
|
|
4376
4508
|
},
|
|
4509
|
+
{
|
|
4510
|
+
"name": "disableWidthConstraint",
|
|
4511
|
+
"type": "boolean",
|
|
4512
|
+
"complexType": {
|
|
4513
|
+
"original": "boolean",
|
|
4514
|
+
"resolved": "boolean",
|
|
4515
|
+
"references": {}
|
|
4516
|
+
},
|
|
4517
|
+
"mutable": false,
|
|
4518
|
+
"attr": "disable-width-constraint",
|
|
4519
|
+
"reflectToAttr": false,
|
|
4520
|
+
"docs": "If set to `true`, the content area width property is removed, allowing content to take the full width of the dialog when using the large variant.",
|
|
4521
|
+
"docsTags": [],
|
|
4522
|
+
"default": "false",
|
|
4523
|
+
"values": [
|
|
4524
|
+
{
|
|
4525
|
+
"type": "boolean"
|
|
4526
|
+
}
|
|
4527
|
+
],
|
|
4528
|
+
"optional": true,
|
|
4529
|
+
"required": false
|
|
4530
|
+
},
|
|
4377
4531
|
{
|
|
4378
4532
|
"name": "dismissLabel",
|
|
4379
4533
|
"type": "string",
|
|
@@ -13483,7 +13637,7 @@
|
|
|
13483
13637
|
"mutable": false,
|
|
13484
13638
|
"attr": "expanded",
|
|
13485
13639
|
"reflectToAttr": false,
|
|
13486
|
-
"docs": "If `true`, the side navigation will
|
|
13640
|
+
"docs": "If `true`, the side navigation will display in an expanded state.",
|
|
13487
13641
|
"docsTags": [],
|
|
13488
13642
|
"default": "false",
|
|
13489
13643
|
"values": [
|
|
@@ -15674,6 +15828,28 @@
|
|
|
15674
15828
|
"optional": false,
|
|
15675
15829
|
"required": false
|
|
15676
15830
|
},
|
|
15831
|
+
{
|
|
15832
|
+
"name": "maxCharacters",
|
|
15833
|
+
"type": "number",
|
|
15834
|
+
"complexType": {
|
|
15835
|
+
"original": "number",
|
|
15836
|
+
"resolved": "number",
|
|
15837
|
+
"references": {}
|
|
15838
|
+
},
|
|
15839
|
+
"mutable": false,
|
|
15840
|
+
"attr": "max-characters",
|
|
15841
|
+
"reflectToAttr": false,
|
|
15842
|
+
"docs": "The maximum number of characters that can be entered in the field.",
|
|
15843
|
+
"docsTags": [],
|
|
15844
|
+
"default": "0",
|
|
15845
|
+
"values": [
|
|
15846
|
+
{
|
|
15847
|
+
"type": "number"
|
|
15848
|
+
}
|
|
15849
|
+
],
|
|
15850
|
+
"optional": false,
|
|
15851
|
+
"required": false
|
|
15852
|
+
},
|
|
15677
15853
|
{
|
|
15678
15854
|
"name": "maxLength",
|
|
15679
15855
|
"type": "number",
|
|
@@ -15685,7 +15861,7 @@
|
|
|
15685
15861
|
"mutable": false,
|
|
15686
15862
|
"attr": "max-length",
|
|
15687
15863
|
"reflectToAttr": false,
|
|
15688
|
-
"docs": "The maximum number of characters that can be entered in the field.",
|
|
15864
|
+
"docs": "The label for maximum number of characters that can be entered in the field.",
|
|
15689
15865
|
"docsTags": [],
|
|
15690
15866
|
"default": "0",
|
|
15691
15867
|
"values": [
|
|
@@ -15721,6 +15897,28 @@
|
|
|
15721
15897
|
"optional": false,
|
|
15722
15898
|
"required": false
|
|
15723
15899
|
},
|
|
15900
|
+
{
|
|
15901
|
+
"name": "minCharacters",
|
|
15902
|
+
"type": "number",
|
|
15903
|
+
"complexType": {
|
|
15904
|
+
"original": "number",
|
|
15905
|
+
"resolved": "number",
|
|
15906
|
+
"references": {}
|
|
15907
|
+
},
|
|
15908
|
+
"mutable": false,
|
|
15909
|
+
"attr": "min-characters",
|
|
15910
|
+
"reflectToAttr": false,
|
|
15911
|
+
"docs": "The minimum number of characters that can be entered in the field.",
|
|
15912
|
+
"docsTags": [],
|
|
15913
|
+
"default": "0",
|
|
15914
|
+
"values": [
|
|
15915
|
+
{
|
|
15916
|
+
"type": "number"
|
|
15917
|
+
}
|
|
15918
|
+
],
|
|
15919
|
+
"optional": false,
|
|
15920
|
+
"required": false
|
|
15921
|
+
},
|
|
15724
15922
|
{
|
|
15725
15923
|
"name": "name",
|
|
15726
15924
|
"type": "string",
|
|
@@ -18090,6 +18288,11 @@
|
|
|
18090
18288
|
"docstring": "",
|
|
18091
18289
|
"path": "src/components/ic-tab/ic-tab.types.ts"
|
|
18092
18290
|
},
|
|
18291
|
+
"src/components/ic-tooltip/ic-tooltip.types.ts::IcTooltipPlacements": {
|
|
18292
|
+
"declaration": "export type IcTooltipPlacements =\n | \"top-start\"\n | \"top\"\n | \"top-end\"\n | \"right-start\"\n | \"right\"\n | \"right-end\"\n | \"bottom-end\"\n | \"bottom\"\n | \"bottom-start\"\n | \"left-end\"\n | \"left\"\n | \"left-start\";",
|
|
18293
|
+
"docstring": "",
|
|
18294
|
+
"path": "src/components/ic-tooltip/ic-tooltip.types.ts"
|
|
18295
|
+
},
|
|
18093
18296
|
"src/utils/types.ts::IcAdditionalFieldTypes": {
|
|
18094
18297
|
"declaration": "export type IcAdditionalFieldTypes = \"static\" | \"dynamic\";",
|
|
18095
18298
|
"docstring": "",
|
|
@@ -18299,11 +18502,6 @@
|
|
|
18299
18502
|
"declaration": "{\n mode: IcThemeForeground;\n color: IcColorRGB;\n}",
|
|
18300
18503
|
"docstring": "",
|
|
18301
18504
|
"path": "src/utils/types.ts"
|
|
18302
|
-
},
|
|
18303
|
-
"src/components/ic-tooltip/ic-tooltip.types.ts::IcTooltipPlacements": {
|
|
18304
|
-
"declaration": "export type IcTooltipPlacements =\n | \"top-start\"\n | \"top\"\n | \"top-end\"\n | \"right-start\"\n | \"right\"\n | \"right-end\"\n | \"bottom-end\"\n | \"bottom\"\n | \"bottom-start\"\n | \"left-end\"\n | \"left\"\n | \"left-start\";",
|
|
18305
|
-
"docstring": "",
|
|
18306
|
-
"path": "src/components/ic-tooltip/ic-tooltip.types.ts"
|
|
18307
18505
|
}
|
|
18308
18506
|
}
|
|
18309
18507
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/docs",
|
|
4
|
-
"version": "2.9.
|
|
4
|
+
"version": "2.9.4",
|
|
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": "851d7863c504a1890a0d1a09f4bc8dbd5c94a4ba"
|
|
22
22
|
}
|