@ukic/docs 3.2.5 → 3.3.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.
Files changed (2) hide show
  1. package/docs.json +679 -11
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -534,6 +534,670 @@
534
534
  ]
535
535
  }
536
536
  },
537
+ {
538
+ "filePath": "src/components/ic-action-chip/ic-action-chip.tsx",
539
+ "encapsulation": "shadow",
540
+ "tag": "ic-action-chip",
541
+ "readme": "# ic-action-chip\n\n\n",
542
+ "docs": "",
543
+ "docsTags": [
544
+ {
545
+ "name": "slot",
546
+ "text": "badge - Badge component overlaying the top right of the chip."
547
+ },
548
+ {
549
+ "name": "slot",
550
+ "text": "icon - Content will be rendered at the start of the chip."
551
+ }
552
+ ],
553
+ "usage": {},
554
+ "props": [
555
+ {
556
+ "name": "disabled",
557
+ "type": "boolean",
558
+ "complexType": {
559
+ "original": "boolean",
560
+ "resolved": "boolean",
561
+ "references": {}
562
+ },
563
+ "mutable": false,
564
+ "attr": "disabled",
565
+ "reflectToAttr": false,
566
+ "docs": "If `true`, the chip will appear disabled.",
567
+ "docsTags": [],
568
+ "default": "false",
569
+ "values": [
570
+ {
571
+ "type": "boolean"
572
+ }
573
+ ],
574
+ "optional": false,
575
+ "required": false,
576
+ "getter": false,
577
+ "setter": false
578
+ },
579
+ {
580
+ "name": "download",
581
+ "type": "boolean | string",
582
+ "complexType": {
583
+ "original": "string | boolean",
584
+ "resolved": "boolean | string",
585
+ "references": {}
586
+ },
587
+ "mutable": false,
588
+ "attr": "download",
589
+ "reflectToAttr": false,
590
+ "docs": "If `true`, the user can save the linked URL instead of navigating to it.",
591
+ "docsTags": [],
592
+ "default": "false",
593
+ "values": [
594
+ {
595
+ "type": "boolean"
596
+ },
597
+ {
598
+ "type": "string"
599
+ }
600
+ ],
601
+ "optional": false,
602
+ "required": false,
603
+ "getter": false,
604
+ "setter": false
605
+ },
606
+ {
607
+ "name": "form",
608
+ "type": "string | undefined",
609
+ "complexType": {
610
+ "original": "string",
611
+ "resolved": "string | undefined",
612
+ "references": {}
613
+ },
614
+ "mutable": false,
615
+ "attr": "form",
616
+ "reflectToAttr": false,
617
+ "docs": "The <form> element to associate the chip with.",
618
+ "docsTags": [],
619
+ "values": [
620
+ {
621
+ "type": "string"
622
+ },
623
+ {
624
+ "type": "undefined"
625
+ }
626
+ ],
627
+ "optional": true,
628
+ "required": false,
629
+ "getter": false,
630
+ "setter": false
631
+ },
632
+ {
633
+ "name": "formaction",
634
+ "type": "string | undefined",
635
+ "complexType": {
636
+ "original": "string",
637
+ "resolved": "string | undefined",
638
+ "references": {}
639
+ },
640
+ "mutable": false,
641
+ "attr": "formaction",
642
+ "reflectToAttr": false,
643
+ "docs": "The URL that processes the information submitted by the chip. It overrides the action attribute of the chip's form owner. Does nothing if there is no form owner.",
644
+ "docsTags": [],
645
+ "values": [
646
+ {
647
+ "type": "string"
648
+ },
649
+ {
650
+ "type": "undefined"
651
+ }
652
+ ],
653
+ "optional": true,
654
+ "required": false,
655
+ "getter": false,
656
+ "setter": false
657
+ },
658
+ {
659
+ "name": "formenctype",
660
+ "type": "string | undefined",
661
+ "complexType": {
662
+ "original": "string",
663
+ "resolved": "string | undefined",
664
+ "references": {}
665
+ },
666
+ "mutable": false,
667
+ "attr": "formenctype",
668
+ "reflectToAttr": false,
669
+ "docs": "The way the submitted form data is encoded.",
670
+ "docsTags": [],
671
+ "values": [
672
+ {
673
+ "type": "string"
674
+ },
675
+ {
676
+ "type": "undefined"
677
+ }
678
+ ],
679
+ "optional": true,
680
+ "required": false,
681
+ "getter": false,
682
+ "setter": false
683
+ },
684
+ {
685
+ "name": "formmethod",
686
+ "type": "string | undefined",
687
+ "complexType": {
688
+ "original": "string",
689
+ "resolved": "string | undefined",
690
+ "references": {}
691
+ },
692
+ "mutable": false,
693
+ "attr": "formmethod",
694
+ "reflectToAttr": false,
695
+ "docs": "The HTTP method used to submit the form.",
696
+ "docsTags": [],
697
+ "values": [
698
+ {
699
+ "type": "string"
700
+ },
701
+ {
702
+ "type": "undefined"
703
+ }
704
+ ],
705
+ "optional": true,
706
+ "required": false,
707
+ "getter": false,
708
+ "setter": false
709
+ },
710
+ {
711
+ "name": "formnovalidate",
712
+ "type": "boolean | undefined",
713
+ "complexType": {
714
+ "original": "boolean",
715
+ "resolved": "boolean | undefined",
716
+ "references": {}
717
+ },
718
+ "mutable": false,
719
+ "attr": "formnovalidate",
720
+ "reflectToAttr": false,
721
+ "docs": "If `true`, the form will not be validated when submitted.",
722
+ "docsTags": [],
723
+ "values": [
724
+ {
725
+ "type": "boolean"
726
+ },
727
+ {
728
+ "type": "undefined"
729
+ }
730
+ ],
731
+ "optional": true,
732
+ "required": false,
733
+ "getter": false,
734
+ "setter": false
735
+ },
736
+ {
737
+ "name": "formtarget",
738
+ "type": "string | undefined",
739
+ "complexType": {
740
+ "original": "string",
741
+ "resolved": "string | undefined",
742
+ "references": {}
743
+ },
744
+ "mutable": false,
745
+ "attr": "formtarget",
746
+ "reflectToAttr": false,
747
+ "docs": "The place to display the response from submitting the form. It overrides the target attribute of the chip's form owner.",
748
+ "docsTags": [],
749
+ "values": [
750
+ {
751
+ "type": "string"
752
+ },
753
+ {
754
+ "type": "undefined"
755
+ }
756
+ ],
757
+ "optional": true,
758
+ "required": false,
759
+ "getter": false,
760
+ "setter": false
761
+ },
762
+ {
763
+ "name": "href",
764
+ "type": "string | undefined",
765
+ "complexType": {
766
+ "original": "string",
767
+ "resolved": "string | undefined",
768
+ "references": {}
769
+ },
770
+ "mutable": false,
771
+ "attr": "href",
772
+ "reflectToAttr": false,
773
+ "docs": "The URL that the link points to. This will render the chip as an \"a\" tag.",
774
+ "docsTags": [],
775
+ "values": [
776
+ {
777
+ "type": "string"
778
+ },
779
+ {
780
+ "type": "undefined"
781
+ }
782
+ ],
783
+ "optional": true,
784
+ "required": false,
785
+ "getter": false,
786
+ "setter": false
787
+ },
788
+ {
789
+ "name": "hreflang",
790
+ "type": "string | undefined",
791
+ "complexType": {
792
+ "original": "string",
793
+ "resolved": "string | undefined",
794
+ "references": {}
795
+ },
796
+ "mutable": false,
797
+ "attr": "hreflang",
798
+ "reflectToAttr": false,
799
+ "docs": "The human language of the linked URL.",
800
+ "docsTags": [],
801
+ "values": [
802
+ {
803
+ "type": "string"
804
+ },
805
+ {
806
+ "type": "undefined"
807
+ }
808
+ ],
809
+ "optional": true,
810
+ "required": false,
811
+ "getter": false,
812
+ "setter": false
813
+ },
814
+ {
815
+ "name": "label",
816
+ "type": "string",
817
+ "complexType": {
818
+ "original": "string",
819
+ "resolved": "string",
820
+ "references": {}
821
+ },
822
+ "mutable": false,
823
+ "attr": "label",
824
+ "reflectToAttr": false,
825
+ "docs": "The text rendered within the chip.",
826
+ "docsTags": [],
827
+ "values": [
828
+ {
829
+ "type": "string"
830
+ }
831
+ ],
832
+ "optional": false,
833
+ "required": true,
834
+ "getter": false,
835
+ "setter": false
836
+ },
837
+ {
838
+ "name": "monochrome",
839
+ "type": "boolean",
840
+ "complexType": {
841
+ "original": "boolean",
842
+ "resolved": "boolean",
843
+ "references": {}
844
+ },
845
+ "mutable": false,
846
+ "attr": "monochrome",
847
+ "reflectToAttr": false,
848
+ "docs": "If `true`, the button will display as monochromatic in either `light` or `dark` theme.",
849
+ "docsTags": [],
850
+ "default": "false",
851
+ "values": [
852
+ {
853
+ "type": "boolean"
854
+ }
855
+ ],
856
+ "optional": false,
857
+ "required": false,
858
+ "getter": false,
859
+ "setter": false
860
+ },
861
+ {
862
+ "name": "referrerpolicy",
863
+ "type": "\"\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | undefined",
864
+ "complexType": {
865
+ "original": "ReferrerPolicy",
866
+ "resolved": "\"\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | undefined",
867
+ "references": {
868
+ "ReferrerPolicy": {
869
+ "location": "global",
870
+ "id": "global::ReferrerPolicy"
871
+ }
872
+ }
873
+ },
874
+ "mutable": false,
875
+ "attr": "referrerpolicy",
876
+ "reflectToAttr": false,
877
+ "docs": "How much of the referrer to send when following the link.",
878
+ "docsTags": [],
879
+ "values": [
880
+ {
881
+ "type": "\"\""
882
+ },
883
+ {
884
+ "value": "no-referrer",
885
+ "type": "string"
886
+ },
887
+ {
888
+ "value": "no-referrer-when-downgrade",
889
+ "type": "string"
890
+ },
891
+ {
892
+ "value": "origin",
893
+ "type": "string"
894
+ },
895
+ {
896
+ "value": "origin-when-cross-origin",
897
+ "type": "string"
898
+ },
899
+ {
900
+ "value": "same-origin",
901
+ "type": "string"
902
+ },
903
+ {
904
+ "value": "strict-origin",
905
+ "type": "string"
906
+ },
907
+ {
908
+ "value": "strict-origin-when-cross-origin",
909
+ "type": "string"
910
+ },
911
+ {
912
+ "value": "unsafe-url",
913
+ "type": "string"
914
+ },
915
+ {
916
+ "type": "undefined"
917
+ }
918
+ ],
919
+ "optional": true,
920
+ "required": false,
921
+ "getter": false,
922
+ "setter": false
923
+ },
924
+ {
925
+ "name": "rel",
926
+ "type": "string | undefined",
927
+ "complexType": {
928
+ "original": "string",
929
+ "resolved": "string | undefined",
930
+ "references": {}
931
+ },
932
+ "mutable": false,
933
+ "attr": "rel",
934
+ "reflectToAttr": false,
935
+ "docs": "The relationship of the linked URL as space-separated link types.",
936
+ "docsTags": [],
937
+ "values": [
938
+ {
939
+ "type": "string"
940
+ },
941
+ {
942
+ "type": "undefined"
943
+ }
944
+ ],
945
+ "optional": true,
946
+ "required": false,
947
+ "getter": false,
948
+ "setter": false
949
+ },
950
+ {
951
+ "name": "size",
952
+ "type": "\"large\" | \"medium\" | \"small\"",
953
+ "complexType": {
954
+ "original": "IcSizes",
955
+ "resolved": "\"large\" | \"medium\" | \"small\"",
956
+ "references": {
957
+ "IcSizes": {
958
+ "location": "import",
959
+ "path": "../../utils/types",
960
+ "id": "src/utils/types.ts::IcSizes"
961
+ }
962
+ }
963
+ },
964
+ "mutable": false,
965
+ "attr": "size",
966
+ "reflectToAttr": false,
967
+ "docs": "The size of the chip.",
968
+ "docsTags": [],
969
+ "default": "\"medium\"",
970
+ "values": [
971
+ {
972
+ "value": "large",
973
+ "type": "string"
974
+ },
975
+ {
976
+ "value": "medium",
977
+ "type": "string"
978
+ },
979
+ {
980
+ "value": "small",
981
+ "type": "string"
982
+ }
983
+ ],
984
+ "optional": false,
985
+ "required": false,
986
+ "getter": false,
987
+ "setter": false
988
+ },
989
+ {
990
+ "name": "target",
991
+ "type": "string | undefined",
992
+ "complexType": {
993
+ "original": "string",
994
+ "resolved": "string | undefined",
995
+ "references": {}
996
+ },
997
+ "mutable": false,
998
+ "attr": "target",
999
+ "reflectToAttr": false,
1000
+ "docs": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
1001
+ "docsTags": [],
1002
+ "values": [
1003
+ {
1004
+ "type": "string"
1005
+ },
1006
+ {
1007
+ "type": "undefined"
1008
+ }
1009
+ ],
1010
+ "optional": true,
1011
+ "required": false,
1012
+ "getter": false,
1013
+ "setter": false
1014
+ },
1015
+ {
1016
+ "name": "theme",
1017
+ "type": "\"dark\" | \"inherit\" | \"light\"",
1018
+ "complexType": {
1019
+ "original": "IcThemeMode",
1020
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
1021
+ "references": {
1022
+ "IcThemeMode": {
1023
+ "location": "import",
1024
+ "path": "../../utils/types",
1025
+ "id": "src/utils/types.ts::IcThemeMode"
1026
+ }
1027
+ }
1028
+ },
1029
+ "mutable": false,
1030
+ "attr": "theme",
1031
+ "reflectToAttr": false,
1032
+ "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.",
1033
+ "docsTags": [],
1034
+ "default": "\"inherit\"",
1035
+ "values": [
1036
+ {
1037
+ "value": "dark",
1038
+ "type": "string"
1039
+ },
1040
+ {
1041
+ "value": "inherit",
1042
+ "type": "string"
1043
+ },
1044
+ {
1045
+ "value": "light",
1046
+ "type": "string"
1047
+ }
1048
+ ],
1049
+ "optional": false,
1050
+ "required": false,
1051
+ "getter": false,
1052
+ "setter": false
1053
+ },
1054
+ {
1055
+ "name": "transparentBackground",
1056
+ "type": "boolean",
1057
+ "complexType": {
1058
+ "original": "boolean",
1059
+ "resolved": "boolean",
1060
+ "references": {}
1061
+ },
1062
+ "mutable": false,
1063
+ "attr": "transparent-background",
1064
+ "reflectToAttr": false,
1065
+ "docs": "If `true`, the outlined variant of chip will have a transparent background rather than the theme defined color.",
1066
+ "docsTags": [],
1067
+ "default": "true",
1068
+ "values": [
1069
+ {
1070
+ "type": "boolean"
1071
+ }
1072
+ ],
1073
+ "optional": false,
1074
+ "required": false,
1075
+ "getter": false,
1076
+ "setter": false
1077
+ },
1078
+ {
1079
+ "name": "type",
1080
+ "type": "\"button\" | \"reset\" | \"submit\"",
1081
+ "complexType": {
1082
+ "original": "IcButtonTypes",
1083
+ "resolved": "\"button\" | \"reset\" | \"submit\"",
1084
+ "references": {
1085
+ "IcButtonTypes": {
1086
+ "location": "import",
1087
+ "path": "../ic-button/ic-button.types",
1088
+ "id": "src/components/ic-button/ic-button.types.ts::IcButtonTypes"
1089
+ }
1090
+ }
1091
+ },
1092
+ "mutable": false,
1093
+ "attr": "type",
1094
+ "reflectToAttr": false,
1095
+ "docs": "The type of the chip.",
1096
+ "docsTags": [],
1097
+ "default": "\"button\"",
1098
+ "values": [
1099
+ {
1100
+ "value": "button",
1101
+ "type": "string"
1102
+ },
1103
+ {
1104
+ "value": "reset",
1105
+ "type": "string"
1106
+ },
1107
+ {
1108
+ "value": "submit",
1109
+ "type": "string"
1110
+ }
1111
+ ],
1112
+ "optional": false,
1113
+ "required": false,
1114
+ "getter": false,
1115
+ "setter": false
1116
+ },
1117
+ {
1118
+ "name": "variant",
1119
+ "type": "\"filled\" | \"outlined\"",
1120
+ "complexType": {
1121
+ "original": "IcEmphasisType",
1122
+ "resolved": "\"filled\" | \"outlined\"",
1123
+ "references": {
1124
+ "IcEmphasisType": {
1125
+ "location": "import",
1126
+ "path": "../../utils/types",
1127
+ "id": "src/utils/types.ts::IcEmphasisType"
1128
+ }
1129
+ }
1130
+ },
1131
+ "mutable": false,
1132
+ "attr": "variant",
1133
+ "reflectToAttr": false,
1134
+ "docs": "The emphasis of the chip.",
1135
+ "docsTags": [],
1136
+ "default": "\"filled\"",
1137
+ "values": [
1138
+ {
1139
+ "value": "filled",
1140
+ "type": "string"
1141
+ },
1142
+ {
1143
+ "value": "outlined",
1144
+ "type": "string"
1145
+ }
1146
+ ],
1147
+ "optional": false,
1148
+ "required": false,
1149
+ "getter": false,
1150
+ "setter": false
1151
+ }
1152
+ ],
1153
+ "methods": [
1154
+ {
1155
+ "name": "setFocus",
1156
+ "returns": {
1157
+ "type": "Promise<void>",
1158
+ "docs": ""
1159
+ },
1160
+ "complexType": {
1161
+ "signature": "() => Promise<void>",
1162
+ "parameters": [],
1163
+ "references": {
1164
+ "Promise": {
1165
+ "location": "global",
1166
+ "id": "global::Promise"
1167
+ }
1168
+ },
1169
+ "return": "Promise<void>"
1170
+ },
1171
+ "signature": "setFocus() => Promise<void>",
1172
+ "parameters": [],
1173
+ "docs": "Sets focus on the chip.",
1174
+ "docsTags": []
1175
+ }
1176
+ ],
1177
+ "events": [],
1178
+ "listeners": [],
1179
+ "styles": [],
1180
+ "slots": [
1181
+ {
1182
+ "name": "badge",
1183
+ "docs": "Badge component overlaying the top right of the chip."
1184
+ },
1185
+ {
1186
+ "name": "icon",
1187
+ "docs": "Content will be rendered at the start of the chip."
1188
+ }
1189
+ ],
1190
+ "parts": [],
1191
+ "dependents": [],
1192
+ "dependencies": [
1193
+ "ic-typography"
1194
+ ],
1195
+ "dependencyGraph": {
1196
+ "ic-action-chip": [
1197
+ "ic-typography"
1198
+ ]
1199
+ }
1200
+ },
537
1201
  {
538
1202
  "filePath": "src/components/ic-alert/ic-alert.tsx",
539
1203
  "encapsulation": "shadow",
@@ -20582,7 +21246,7 @@
20582
21246
  }
20583
21247
  }
20584
21248
  },
20585
- "mutable": true,
21249
+ "mutable": false,
20586
21250
  "attr": "placement",
20587
21251
  "reflectToAttr": false,
20588
21252
  "docs": "The position of the tooltip in relation to the parent element.",
@@ -21542,6 +22206,7 @@
21542
22206
  "dependents": [
21543
22207
  "ic-accordion",
21544
22208
  "ic-accordion-group",
22209
+ "ic-action-chip",
21545
22210
  "ic-alert",
21546
22211
  "ic-badge",
21547
22212
  "ic-button",
@@ -21588,6 +22253,9 @@
21588
22253
  "ic-accordion-group": [
21589
22254
  "ic-typography"
21590
22255
  ],
22256
+ "ic-action-chip": [
22257
+ "ic-typography"
22258
+ ],
21591
22259
  "ic-alert": [
21592
22260
  "ic-typography"
21593
22261
  ],
@@ -21713,6 +22381,16 @@
21713
22381
  "docstring": "",
21714
22382
  "path": "src/utils/types.ts"
21715
22383
  },
22384
+ "src/components/ic-button/ic-button.types.ts::IcButtonTypes": {
22385
+ "declaration": "export type IcButtonTypes = \"reset\" | \"submit\" | \"button\";",
22386
+ "docstring": "",
22387
+ "path": "src/components/ic-button/ic-button.types.ts"
22388
+ },
22389
+ "src/utils/types.ts::IcEmphasisType": {
22390
+ "declaration": "export type IcEmphasisType = \"filled\" | \"outlined\";",
22391
+ "docstring": "",
22392
+ "path": "src/utils/types.ts"
22393
+ },
21716
22394
  "src/utils/types.ts::IcStatusVariants": {
21717
22395
  "declaration": "export type IcStatusVariants =\n | \"neutral\"\n | \"info\"\n | \"warning\"\n | \"error\"\n | \"success\";",
21718
22396
  "docstring": "",
@@ -21748,11 +22426,6 @@
21748
22426
  "docstring": "",
21749
22427
  "path": "src/utils/types.ts"
21750
22428
  },
21751
- "src/components/ic-button/ic-button.types.ts::IcButtonTypes": {
21752
- "declaration": "export type IcButtonTypes = \"reset\" | \"submit\" | \"button\";",
21753
- "docstring": "",
21754
- "path": "src/components/ic-button/ic-button.types.ts"
21755
- },
21756
22429
  "src/components/ic-button/ic-button.types.ts::IcButtonVariants": {
21757
22430
  "declaration": "export type IcButtonVariants =\n | \"primary\"\n | \"secondary\"\n | \"tertiary\"\n | \"destructive\"\n | \"icon\"\n | \"icon-primary\"\n | \"icon-secondary\"\n | \"icon-tertiary\"\n | \"icon-destructive\";",
21758
22431
  "docstring": "",
@@ -21778,11 +22451,6 @@
21778
22451
  "docstring": "",
21779
22452
  "path": "src/components/ic-badge/ic-badge.types.ts"
21780
22453
  },
21781
- "src/utils/types.ts::IcEmphasisType": {
21782
- "declaration": "export type IcEmphasisType = \"filled\" | \"outlined\";",
21783
- "docstring": "",
21784
- "path": "src/utils/types.ts"
21785
- },
21786
22454
  "src/components/ic-tab/ic-tab.types.ts::IcTabClickEventDetail": {
21787
22455
  "declaration": "export interface IcTabClickEventDetail {\n tabId: string;\n contextId: string;\n position: number;\n}",
21788
22456
  "docstring": "",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/docs",
4
- "version": "3.2.5",
4
+ "version": "3.3.0",
5
5
  "description": "API documentation for @ukic components",
6
6
  "main": "docs.json",
7
7
  "types": "docs.d.ts",
@@ -19,5 +19,5 @@
19
19
  },
20
20
  "license": "MIT",
21
21
  "packageManager": "^npm@10.9.2",
22
- "gitHead": "8dda3100111ba9731294bca0a22cdd04b128deaf"
22
+ "gitHead": "db93fe7649cd716a63d1a61be6a5098809af165d"
23
23
  }