@ukic/docs 2.10.3 → 2.11.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.
- package/docs.json +143 -13
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"timestamp": "2024-
|
|
2
|
+
"timestamp": "2024-05-10T14:30:05",
|
|
3
3
|
"compiler": {
|
|
4
4
|
"name": "@stencil/core",
|
|
5
5
|
"version": "4.10.0",
|
|
@@ -204,7 +204,12 @@
|
|
|
204
204
|
"tag": "ic-accordion-group",
|
|
205
205
|
"readme": "# ic-accordion-title\n\n\n",
|
|
206
206
|
"docs": "",
|
|
207
|
-
"docsTags": [
|
|
207
|
+
"docsTags": [
|
|
208
|
+
{
|
|
209
|
+
"name": "slot",
|
|
210
|
+
"text": "group-title - Content is placed as the accordion group title."
|
|
211
|
+
}
|
|
212
|
+
],
|
|
208
213
|
"usage": {},
|
|
209
214
|
"props": [
|
|
210
215
|
{
|
|
@@ -403,7 +408,12 @@
|
|
|
403
408
|
}
|
|
404
409
|
],
|
|
405
410
|
"styles": [],
|
|
406
|
-
"slots": [
|
|
411
|
+
"slots": [
|
|
412
|
+
{
|
|
413
|
+
"name": "group-title",
|
|
414
|
+
"docs": "Content is placed as the accordion group title."
|
|
415
|
+
}
|
|
416
|
+
],
|
|
407
417
|
"parts": [],
|
|
408
418
|
"dependents": [],
|
|
409
419
|
"dependencies": [
|
|
@@ -712,6 +722,39 @@
|
|
|
712
722
|
],
|
|
713
723
|
"optional": false,
|
|
714
724
|
"required": true
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
"name": "variant",
|
|
728
|
+
"type": "\"default\" | \"icon\"",
|
|
729
|
+
"complexType": {
|
|
730
|
+
"original": "IcBackToTopVariants",
|
|
731
|
+
"resolved": "\"default\" | \"icon\"",
|
|
732
|
+
"references": {
|
|
733
|
+
"IcBackToTopVariants": {
|
|
734
|
+
"location": "import",
|
|
735
|
+
"path": "./ic-back-to-top.types",
|
|
736
|
+
"id": "src/components/ic-back-to-top/ic-back-to-top.types.ts::IcBackToTopVariants"
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
},
|
|
740
|
+
"mutable": false,
|
|
741
|
+
"attr": "variant",
|
|
742
|
+
"reflectToAttr": false,
|
|
743
|
+
"docs": "The variant of the button to render",
|
|
744
|
+
"docsTags": [],
|
|
745
|
+
"default": "\"default\"",
|
|
746
|
+
"values": [
|
|
747
|
+
{
|
|
748
|
+
"value": "default",
|
|
749
|
+
"type": "string"
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
"value": "icon",
|
|
753
|
+
"type": "string"
|
|
754
|
+
}
|
|
755
|
+
],
|
|
756
|
+
"optional": false,
|
|
757
|
+
"required": false
|
|
715
758
|
}
|
|
716
759
|
],
|
|
717
760
|
"methods": [],
|
|
@@ -728,10 +771,15 @@
|
|
|
728
771
|
"parts": [],
|
|
729
772
|
"dependents": [],
|
|
730
773
|
"dependencies": [
|
|
731
|
-
"ic-typography"
|
|
774
|
+
"ic-typography",
|
|
775
|
+
"ic-tooltip"
|
|
732
776
|
],
|
|
733
777
|
"dependencyGraph": {
|
|
734
778
|
"ic-back-to-top": [
|
|
779
|
+
"ic-typography",
|
|
780
|
+
"ic-tooltip"
|
|
781
|
+
],
|
|
782
|
+
"ic-tooltip": [
|
|
735
783
|
"ic-typography"
|
|
736
784
|
]
|
|
737
785
|
}
|
|
@@ -780,8 +828,8 @@
|
|
|
780
828
|
"references": {
|
|
781
829
|
"IcColor": {
|
|
782
830
|
"location": "import",
|
|
783
|
-
"path": "
|
|
784
|
-
"id": "src/
|
|
831
|
+
"path": "../../utils/types",
|
|
832
|
+
"id": "src/utils/types.ts::IcColor"
|
|
785
833
|
}
|
|
786
834
|
}
|
|
787
835
|
},
|
|
@@ -3669,6 +3717,40 @@
|
|
|
3669
3717
|
"optional": true,
|
|
3670
3718
|
"required": false
|
|
3671
3719
|
},
|
|
3720
|
+
{
|
|
3721
|
+
"name": "customColor",
|
|
3722
|
+
"type": "`#${string}` | `rgb(${string})` | `rgba(${string})`",
|
|
3723
|
+
"complexType": {
|
|
3724
|
+
"original": "IcColor",
|
|
3725
|
+
"resolved": "`#${string}` | `rgb(${string})` | `rgba(${string})`",
|
|
3726
|
+
"references": {
|
|
3727
|
+
"IcColor": {
|
|
3728
|
+
"location": "import",
|
|
3729
|
+
"path": "../../utils/types",
|
|
3730
|
+
"id": "src/utils/types.ts::IcColor"
|
|
3731
|
+
}
|
|
3732
|
+
}
|
|
3733
|
+
},
|
|
3734
|
+
"mutable": false,
|
|
3735
|
+
"attr": "custom-color",
|
|
3736
|
+
"reflectToAttr": false,
|
|
3737
|
+
"docs": "The custom chip colour. This prop will be applied to the chip component if `dismissible` is set to `false`.\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
|
|
3738
|
+
"docsTags": [],
|
|
3739
|
+
"default": "null",
|
|
3740
|
+
"values": [
|
|
3741
|
+
{
|
|
3742
|
+
"type": "`#${string}`"
|
|
3743
|
+
},
|
|
3744
|
+
{
|
|
3745
|
+
"type": "`rgb(${string})`"
|
|
3746
|
+
},
|
|
3747
|
+
{
|
|
3748
|
+
"type": "`rgba(${string})`"
|
|
3749
|
+
}
|
|
3750
|
+
],
|
|
3751
|
+
"optional": true,
|
|
3752
|
+
"required": false
|
|
3753
|
+
},
|
|
3672
3754
|
{
|
|
3673
3755
|
"name": "disabled",
|
|
3674
3756
|
"type": "boolean",
|
|
@@ -14461,6 +14543,33 @@
|
|
|
14461
14543
|
"optional": true,
|
|
14462
14544
|
"required": false
|
|
14463
14545
|
},
|
|
14546
|
+
{
|
|
14547
|
+
"name": "appearance",
|
|
14548
|
+
"type": "\"default\" | \"light\"",
|
|
14549
|
+
"complexType": {
|
|
14550
|
+
"original": "\"light\" | \"default\"",
|
|
14551
|
+
"resolved": "\"default\" | \"light\"",
|
|
14552
|
+
"references": {}
|
|
14553
|
+
},
|
|
14554
|
+
"mutable": false,
|
|
14555
|
+
"attr": "appearance",
|
|
14556
|
+
"reflectToAttr": false,
|
|
14557
|
+
"docs": "The appearance of the stepper.",
|
|
14558
|
+
"docsTags": [],
|
|
14559
|
+
"default": "\"default\"",
|
|
14560
|
+
"values": [
|
|
14561
|
+
{
|
|
14562
|
+
"value": "default",
|
|
14563
|
+
"type": "string"
|
|
14564
|
+
},
|
|
14565
|
+
{
|
|
14566
|
+
"value": "light",
|
|
14567
|
+
"type": "string"
|
|
14568
|
+
}
|
|
14569
|
+
],
|
|
14570
|
+
"optional": true,
|
|
14571
|
+
"required": false
|
|
14572
|
+
},
|
|
14464
14573
|
{
|
|
14465
14574
|
"name": "connectorWidth",
|
|
14466
14575
|
"type": "number",
|
|
@@ -16561,11 +16670,17 @@
|
|
|
16561
16670
|
"props": [
|
|
16562
16671
|
{
|
|
16563
16672
|
"name": "color",
|
|
16564
|
-
"type": "string",
|
|
16673
|
+
"type": "`#${string}` | `rgb(${string})` | `rgba(${string})`",
|
|
16565
16674
|
"complexType": {
|
|
16566
|
-
"original": "
|
|
16567
|
-
"resolved": "string",
|
|
16568
|
-
"references": {
|
|
16675
|
+
"original": "IcColor",
|
|
16676
|
+
"resolved": "`#${string}` | `rgb(${string})` | `rgba(${string})`",
|
|
16677
|
+
"references": {
|
|
16678
|
+
"IcColor": {
|
|
16679
|
+
"location": "import",
|
|
16680
|
+
"path": "../../utils/types",
|
|
16681
|
+
"id": "src/utils/types.ts::IcColor"
|
|
16682
|
+
}
|
|
16683
|
+
}
|
|
16569
16684
|
},
|
|
16570
16685
|
"mutable": false,
|
|
16571
16686
|
"attr": "color",
|
|
@@ -16575,7 +16690,13 @@
|
|
|
16575
16690
|
"default": "null",
|
|
16576
16691
|
"values": [
|
|
16577
16692
|
{
|
|
16578
|
-
"type": "string"
|
|
16693
|
+
"type": "`#${string}`"
|
|
16694
|
+
},
|
|
16695
|
+
{
|
|
16696
|
+
"type": "`rgb(${string})`"
|
|
16697
|
+
},
|
|
16698
|
+
{
|
|
16699
|
+
"type": "`rgba(${string})`"
|
|
16579
16700
|
}
|
|
16580
16701
|
],
|
|
16581
16702
|
"optional": true,
|
|
@@ -17880,6 +18001,7 @@
|
|
|
17880
18001
|
"slots": [],
|
|
17881
18002
|
"parts": [],
|
|
17882
18003
|
"dependents": [
|
|
18004
|
+
"ic-back-to-top",
|
|
17883
18005
|
"ic-button",
|
|
17884
18006
|
"ic-card",
|
|
17885
18007
|
"ic-chip",
|
|
@@ -17892,6 +18014,9 @@
|
|
|
17892
18014
|
"ic-tooltip": [
|
|
17893
18015
|
"ic-typography"
|
|
17894
18016
|
],
|
|
18017
|
+
"ic-back-to-top": [
|
|
18018
|
+
"ic-tooltip"
|
|
18019
|
+
],
|
|
17895
18020
|
"ic-button": [
|
|
17896
18021
|
"ic-tooltip"
|
|
17897
18022
|
],
|
|
@@ -18680,6 +18805,11 @@
|
|
|
18680
18805
|
"docstring": "",
|
|
18681
18806
|
"path": "src/utils/types.ts"
|
|
18682
18807
|
},
|
|
18808
|
+
"src/components/ic-back-to-top/ic-back-to-top.types.ts::IcBackToTopVariants": {
|
|
18809
|
+
"declaration": "export type IcBackToTopVariants = \"default\" | \"icon\";",
|
|
18810
|
+
"docstring": "",
|
|
18811
|
+
"path": "src/components/ic-back-to-top/ic-back-to-top.types.ts"
|
|
18812
|
+
},
|
|
18683
18813
|
"src/components/ic-classification-banner/ic-classification-banner.types.tsx::IcProtectiveMarkings": {
|
|
18684
18814
|
"declaration": "export type IcProtectiveMarkings =\n | \"default\"\n | \"official\"\n | \"official-sensitive\"\n | \"secret\"\n | \"top-secret\";",
|
|
18685
18815
|
"docstring": "",
|
|
@@ -18695,10 +18825,10 @@
|
|
|
18695
18825
|
"docstring": "",
|
|
18696
18826
|
"path": "src/components/ic-footer/ic-footer.types.tsx"
|
|
18697
18827
|
},
|
|
18698
|
-
"src/
|
|
18828
|
+
"src/utils/types.ts::IcColor": {
|
|
18699
18829
|
"declaration": "export type IcColor = RGB | RGBA | HEX;",
|
|
18700
18830
|
"docstring": "",
|
|
18701
|
-
"path": "src/
|
|
18831
|
+
"path": "src/utils/types.ts"
|
|
18702
18832
|
},
|
|
18703
18833
|
"src/components/ic-badge/ic-badge.types.ts::IcBadgePositions": {
|
|
18704
18834
|
"declaration": "export type IcBadgePositions = \"far\" | \"near\" | \"inline\";",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/docs",
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.11.0",
|
|
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": "bee9250acbbeec465702a621ad5a68bf74cd91f4"
|
|
22
22
|
}
|