@ukic/canary-docs 3.0.0-canary.3 → 3.0.0-canary.5
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 +326 -115
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -305,6 +305,43 @@
|
|
|
305
305
|
],
|
|
306
306
|
"optional": true,
|
|
307
307
|
"required": false
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
"name": "theme",
|
|
311
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
312
|
+
"complexType": {
|
|
313
|
+
"original": "IcThemeMode",
|
|
314
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
315
|
+
"references": {
|
|
316
|
+
"IcThemeMode": {
|
|
317
|
+
"location": "import",
|
|
318
|
+
"path": "../../utils/types",
|
|
319
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
"mutable": false,
|
|
324
|
+
"attr": "theme",
|
|
325
|
+
"reflectToAttr": false,
|
|
326
|
+
"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.",
|
|
327
|
+
"docsTags": [],
|
|
328
|
+
"default": "\"inherit\"",
|
|
329
|
+
"values": [
|
|
330
|
+
{
|
|
331
|
+
"value": "dark",
|
|
332
|
+
"type": "string"
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"value": "inherit",
|
|
336
|
+
"type": "string"
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"value": "light",
|
|
340
|
+
"type": "string"
|
|
341
|
+
}
|
|
342
|
+
],
|
|
343
|
+
"optional": true,
|
|
344
|
+
"required": false
|
|
308
345
|
}
|
|
309
346
|
],
|
|
310
347
|
"methods": [
|
|
@@ -436,6 +473,28 @@
|
|
|
436
473
|
"optional": false,
|
|
437
474
|
"required": true
|
|
438
475
|
},
|
|
476
|
+
{
|
|
477
|
+
"name": "columnHeaderTruncation",
|
|
478
|
+
"type": "boolean",
|
|
479
|
+
"complexType": {
|
|
480
|
+
"original": "boolean",
|
|
481
|
+
"resolved": "boolean",
|
|
482
|
+
"references": {}
|
|
483
|
+
},
|
|
484
|
+
"mutable": false,
|
|
485
|
+
"attr": "column-header-truncation",
|
|
486
|
+
"reflectToAttr": false,
|
|
487
|
+
"docs": "Determines whether the column header should be truncated and display a tooltip. Default is `false`.",
|
|
488
|
+
"docsTags": [],
|
|
489
|
+
"default": "false",
|
|
490
|
+
"values": [
|
|
491
|
+
{
|
|
492
|
+
"type": "boolean"
|
|
493
|
+
}
|
|
494
|
+
],
|
|
495
|
+
"optional": false,
|
|
496
|
+
"required": false
|
|
497
|
+
},
|
|
439
498
|
{
|
|
440
499
|
"name": "columns",
|
|
441
500
|
"type": "IcDataTableColumnObject[]",
|
|
@@ -485,7 +544,7 @@
|
|
|
485
544
|
"type": "IcDataTableDataType[]"
|
|
486
545
|
}
|
|
487
546
|
],
|
|
488
|
-
"optional":
|
|
547
|
+
"optional": true,
|
|
489
548
|
"required": false
|
|
490
549
|
},
|
|
491
550
|
{
|
|
@@ -646,17 +705,11 @@
|
|
|
646
705
|
},
|
|
647
706
|
{
|
|
648
707
|
"name": "loadingOptions",
|
|
649
|
-
"type": "{
|
|
708
|
+
"type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
|
|
650
709
|
"complexType": {
|
|
651
|
-
"original": "{\n
|
|
652
|
-
"resolved": "{
|
|
653
|
-
"references": {
|
|
654
|
-
"IcThemeForegroundNoDefault": {
|
|
655
|
-
"location": "import",
|
|
656
|
-
"path": "@ukic/web-components/dist/types/utils/types",
|
|
657
|
-
"id": "../web-components/dist/types/utils/types.d.ts::IcThemeForegroundNoDefault"
|
|
658
|
-
}
|
|
659
|
-
}
|
|
710
|
+
"original": "{\n description?: string;\n label?: string;\n labelDuration?: number;\n max?: number;\n min?: number;\n progress?: number;\n showBackground?: boolean;\n monochrome?: boolean;\n }",
|
|
711
|
+
"resolved": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
|
|
712
|
+
"references": {}
|
|
660
713
|
},
|
|
661
714
|
"mutable": false,
|
|
662
715
|
"reflectToAttr": false,
|
|
@@ -664,7 +717,7 @@
|
|
|
664
717
|
"docsTags": [],
|
|
665
718
|
"values": [
|
|
666
719
|
{
|
|
667
|
-
"type": "{
|
|
720
|
+
"type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }"
|
|
668
721
|
}
|
|
669
722
|
],
|
|
670
723
|
"optional": true,
|
|
@@ -752,7 +805,7 @@
|
|
|
752
805
|
"reflectToAttr": false,
|
|
753
806
|
"docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
|
|
754
807
|
"docsTags": [],
|
|
755
|
-
"default": "{\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n rangeLabelType: \"page\",\n type: \"simple\",\n showItemsPerPageControl: true,\n showGoToPageControl: true,\n alignment: \"right\",\n
|
|
808
|
+
"default": "{\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n rangeLabelType: \"page\",\n type: \"simple\",\n showItemsPerPageControl: true,\n showGoToPageControl: true,\n alignment: \"right\",\n itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n hideAllFromItemsPerPage: false,\n monochrome: false,\n }",
|
|
756
809
|
"values": [
|
|
757
810
|
{
|
|
758
811
|
"type": "IcPaginationBarOptions"
|
|
@@ -903,6 +956,43 @@
|
|
|
903
956
|
"optional": true,
|
|
904
957
|
"required": false
|
|
905
958
|
},
|
|
959
|
+
{
|
|
960
|
+
"name": "theme",
|
|
961
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
962
|
+
"complexType": {
|
|
963
|
+
"original": "IcThemeMode",
|
|
964
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
965
|
+
"references": {
|
|
966
|
+
"IcThemeMode": {
|
|
967
|
+
"location": "import",
|
|
968
|
+
"path": "../../utils/types",
|
|
969
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
970
|
+
}
|
|
971
|
+
}
|
|
972
|
+
},
|
|
973
|
+
"mutable": false,
|
|
974
|
+
"attr": "theme",
|
|
975
|
+
"reflectToAttr": false,
|
|
976
|
+
"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.",
|
|
977
|
+
"docsTags": [],
|
|
978
|
+
"default": "\"inherit\"",
|
|
979
|
+
"values": [
|
|
980
|
+
{
|
|
981
|
+
"value": "dark",
|
|
982
|
+
"type": "string"
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"value": "inherit",
|
|
986
|
+
"type": "string"
|
|
987
|
+
},
|
|
988
|
+
{
|
|
989
|
+
"value": "light",
|
|
990
|
+
"type": "string"
|
|
991
|
+
}
|
|
992
|
+
],
|
|
993
|
+
"optional": true,
|
|
994
|
+
"required": false
|
|
995
|
+
},
|
|
906
996
|
{
|
|
907
997
|
"name": "truncationPattern",
|
|
908
998
|
"type": "\"show-hide\" | \"tooltip\"",
|
|
@@ -959,17 +1049,11 @@
|
|
|
959
1049
|
},
|
|
960
1050
|
{
|
|
961
1051
|
"name": "updatingOptions",
|
|
962
|
-
"type": "{
|
|
1052
|
+
"type": "{ description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }",
|
|
963
1053
|
"complexType": {
|
|
964
|
-
"original": "{\n
|
|
965
|
-
"resolved": "{
|
|
966
|
-
"references": {
|
|
967
|
-
"IcThemeForegroundNoDefault": {
|
|
968
|
-
"location": "import",
|
|
969
|
-
"path": "@ukic/web-components/dist/types/utils/types",
|
|
970
|
-
"id": "../web-components/dist/types/utils/types.d.ts::IcThemeForegroundNoDefault"
|
|
971
|
-
}
|
|
972
|
-
}
|
|
1054
|
+
"original": "{\n description?: string;\n max?: number;\n min?: number;\n progress?: number;\n monochrome?: boolean;\n }",
|
|
1055
|
+
"resolved": "{ description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }",
|
|
1056
|
+
"references": {}
|
|
973
1057
|
},
|
|
974
1058
|
"mutable": false,
|
|
975
1059
|
"reflectToAttr": false,
|
|
@@ -977,7 +1061,7 @@
|
|
|
977
1061
|
"docsTags": [],
|
|
978
1062
|
"values": [
|
|
979
1063
|
{
|
|
980
|
-
"type": "{
|
|
1064
|
+
"type": "{ description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }"
|
|
981
1065
|
}
|
|
982
1066
|
],
|
|
983
1067
|
"optional": true,
|
|
@@ -1160,8 +1244,8 @@
|
|
|
1160
1244
|
"ic-loading-indicator",
|
|
1161
1245
|
"ic-typography",
|
|
1162
1246
|
"ic-link",
|
|
1163
|
-
"ic-button",
|
|
1164
1247
|
"ic-tooltip",
|
|
1248
|
+
"ic-button",
|
|
1165
1249
|
"ic-empty-state",
|
|
1166
1250
|
"ic-pagination-bar"
|
|
1167
1251
|
],
|
|
@@ -1170,21 +1254,21 @@
|
|
|
1170
1254
|
"ic-loading-indicator",
|
|
1171
1255
|
"ic-typography",
|
|
1172
1256
|
"ic-link",
|
|
1173
|
-
"ic-button",
|
|
1174
1257
|
"ic-tooltip",
|
|
1258
|
+
"ic-button",
|
|
1175
1259
|
"ic-empty-state",
|
|
1176
1260
|
"ic-pagination-bar"
|
|
1177
1261
|
],
|
|
1178
1262
|
"ic-loading-indicator": [
|
|
1179
1263
|
"ic-typography"
|
|
1180
1264
|
],
|
|
1265
|
+
"ic-tooltip": [
|
|
1266
|
+
"ic-typography"
|
|
1267
|
+
],
|
|
1181
1268
|
"ic-button": [
|
|
1182
1269
|
"ic-loading-indicator",
|
|
1183
1270
|
"ic-tooltip"
|
|
1184
1271
|
],
|
|
1185
|
-
"ic-tooltip": [
|
|
1186
|
-
"ic-typography"
|
|
1187
|
-
],
|
|
1188
1272
|
"ic-empty-state": [
|
|
1189
1273
|
"ic-typography"
|
|
1190
1274
|
],
|
|
@@ -1929,6 +2013,43 @@
|
|
|
1929
2013
|
"optional": true,
|
|
1930
2014
|
"required": false
|
|
1931
2015
|
},
|
|
2016
|
+
{
|
|
2017
|
+
"name": "theme",
|
|
2018
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
2019
|
+
"complexType": {
|
|
2020
|
+
"original": "IcThemeMode",
|
|
2021
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
2022
|
+
"references": {
|
|
2023
|
+
"IcThemeMode": {
|
|
2024
|
+
"location": "import",
|
|
2025
|
+
"path": "../../utils/types",
|
|
2026
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
2027
|
+
}
|
|
2028
|
+
}
|
|
2029
|
+
},
|
|
2030
|
+
"mutable": false,
|
|
2031
|
+
"attr": "theme",
|
|
2032
|
+
"reflectToAttr": false,
|
|
2033
|
+
"docs": "Sets the date picker to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.",
|
|
2034
|
+
"docsTags": [],
|
|
2035
|
+
"default": "\"inherit\"",
|
|
2036
|
+
"values": [
|
|
2037
|
+
{
|
|
2038
|
+
"value": "dark",
|
|
2039
|
+
"type": "string"
|
|
2040
|
+
},
|
|
2041
|
+
{
|
|
2042
|
+
"value": "inherit",
|
|
2043
|
+
"type": "string"
|
|
2044
|
+
},
|
|
2045
|
+
{
|
|
2046
|
+
"value": "light",
|
|
2047
|
+
"type": "string"
|
|
2048
|
+
}
|
|
2049
|
+
],
|
|
2050
|
+
"optional": true,
|
|
2051
|
+
"required": false
|
|
2052
|
+
},
|
|
1932
2053
|
{
|
|
1933
2054
|
"name": "validationStatus",
|
|
1934
2055
|
"type": "\"\" | \"error\" | \"success\" | \"warning\"",
|
|
@@ -2773,6 +2894,43 @@
|
|
|
2773
2894
|
"optional": true,
|
|
2774
2895
|
"required": false
|
|
2775
2896
|
},
|
|
2897
|
+
{
|
|
2898
|
+
"name": "theme",
|
|
2899
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
2900
|
+
"complexType": {
|
|
2901
|
+
"original": "IcThemeMode",
|
|
2902
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
2903
|
+
"references": {
|
|
2904
|
+
"IcThemeMode": {
|
|
2905
|
+
"location": "import",
|
|
2906
|
+
"path": "../../utils/types",
|
|
2907
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
2908
|
+
}
|
|
2909
|
+
}
|
|
2910
|
+
},
|
|
2911
|
+
"mutable": false,
|
|
2912
|
+
"attr": "theme",
|
|
2913
|
+
"reflectToAttr": false,
|
|
2914
|
+
"docs": "Sets the date picker to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.",
|
|
2915
|
+
"docsTags": [],
|
|
2916
|
+
"default": "\"inherit\"",
|
|
2917
|
+
"values": [
|
|
2918
|
+
{
|
|
2919
|
+
"value": "dark",
|
|
2920
|
+
"type": "string"
|
|
2921
|
+
},
|
|
2922
|
+
{
|
|
2923
|
+
"value": "inherit",
|
|
2924
|
+
"type": "string"
|
|
2925
|
+
},
|
|
2926
|
+
{
|
|
2927
|
+
"value": "light",
|
|
2928
|
+
"type": "string"
|
|
2929
|
+
}
|
|
2930
|
+
],
|
|
2931
|
+
"optional": true,
|
|
2932
|
+
"required": false
|
|
2933
|
+
},
|
|
2776
2934
|
{
|
|
2777
2935
|
"name": "validationStatus",
|
|
2778
2936
|
"type": "\"\" | \"error\" | \"success\" | \"warning\"",
|
|
@@ -2998,43 +3156,6 @@
|
|
|
2998
3156
|
"optional": true,
|
|
2999
3157
|
"required": false
|
|
3000
3158
|
},
|
|
3001
|
-
{
|
|
3002
|
-
"name": "appearance",
|
|
3003
|
-
"type": "\"dark\" | \"default\" | \"light\"",
|
|
3004
|
-
"complexType": {
|
|
3005
|
-
"original": "IcThemeForeground",
|
|
3006
|
-
"resolved": "\"dark\" | \"default\" | \"light\"",
|
|
3007
|
-
"references": {
|
|
3008
|
-
"IcThemeForeground": {
|
|
3009
|
-
"location": "import",
|
|
3010
|
-
"path": "@ukic/web-components/dist/types/interface",
|
|
3011
|
-
"id": "../web-components/dist/types/interface.d.ts::IcThemeForeground"
|
|
3012
|
-
}
|
|
3013
|
-
}
|
|
3014
|
-
},
|
|
3015
|
-
"mutable": false,
|
|
3016
|
-
"attr": "appearance",
|
|
3017
|
-
"reflectToAttr": false,
|
|
3018
|
-
"docs": "Sets the styling for the items in the pagination bar.",
|
|
3019
|
-
"docsTags": [],
|
|
3020
|
-
"default": "\"default\"",
|
|
3021
|
-
"values": [
|
|
3022
|
-
{
|
|
3023
|
-
"value": "dark",
|
|
3024
|
-
"type": "string"
|
|
3025
|
-
},
|
|
3026
|
-
{
|
|
3027
|
-
"value": "default",
|
|
3028
|
-
"type": "string"
|
|
3029
|
-
},
|
|
3030
|
-
{
|
|
3031
|
-
"value": "light",
|
|
3032
|
-
"type": "string"
|
|
3033
|
-
}
|
|
3034
|
-
],
|
|
3035
|
-
"optional": true,
|
|
3036
|
-
"required": false
|
|
3037
|
-
},
|
|
3038
3159
|
{
|
|
3039
3160
|
"name": "currentPage",
|
|
3040
3161
|
"type": "number",
|
|
@@ -3143,6 +3264,28 @@
|
|
|
3143
3264
|
"optional": true,
|
|
3144
3265
|
"required": false
|
|
3145
3266
|
},
|
|
3267
|
+
{
|
|
3268
|
+
"name": "monochrome",
|
|
3269
|
+
"type": "boolean",
|
|
3270
|
+
"complexType": {
|
|
3271
|
+
"original": "boolean",
|
|
3272
|
+
"resolved": "boolean",
|
|
3273
|
+
"references": {}
|
|
3274
|
+
},
|
|
3275
|
+
"mutable": false,
|
|
3276
|
+
"attr": "monochrome",
|
|
3277
|
+
"reflectToAttr": false,
|
|
3278
|
+
"docs": "If `true`, the pagination bar will display as black in the light theme, and white in dark theme.",
|
|
3279
|
+
"docsTags": [],
|
|
3280
|
+
"default": "false",
|
|
3281
|
+
"values": [
|
|
3282
|
+
{
|
|
3283
|
+
"type": "boolean"
|
|
3284
|
+
}
|
|
3285
|
+
],
|
|
3286
|
+
"optional": true,
|
|
3287
|
+
"required": false
|
|
3288
|
+
},
|
|
3146
3289
|
{
|
|
3147
3290
|
"name": "pageLabel",
|
|
3148
3291
|
"type": "string",
|
|
@@ -3242,6 +3385,43 @@
|
|
|
3242
3385
|
"optional": true,
|
|
3243
3386
|
"required": false
|
|
3244
3387
|
},
|
|
3388
|
+
{
|
|
3389
|
+
"name": "theme",
|
|
3390
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
3391
|
+
"complexType": {
|
|
3392
|
+
"original": "IcThemeMode",
|
|
3393
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
3394
|
+
"references": {
|
|
3395
|
+
"IcThemeMode": {
|
|
3396
|
+
"location": "import",
|
|
3397
|
+
"path": "../../utils/types",
|
|
3398
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
3399
|
+
}
|
|
3400
|
+
}
|
|
3401
|
+
},
|
|
3402
|
+
"mutable": false,
|
|
3403
|
+
"attr": "theme",
|
|
3404
|
+
"reflectToAttr": false,
|
|
3405
|
+
"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.",
|
|
3406
|
+
"docsTags": [],
|
|
3407
|
+
"default": "\"inherit\"",
|
|
3408
|
+
"values": [
|
|
3409
|
+
{
|
|
3410
|
+
"value": "dark",
|
|
3411
|
+
"type": "string"
|
|
3412
|
+
},
|
|
3413
|
+
{
|
|
3414
|
+
"value": "inherit",
|
|
3415
|
+
"type": "string"
|
|
3416
|
+
},
|
|
3417
|
+
{
|
|
3418
|
+
"value": "light",
|
|
3419
|
+
"type": "string"
|
|
3420
|
+
}
|
|
3421
|
+
],
|
|
3422
|
+
"optional": true,
|
|
3423
|
+
"required": false
|
|
3424
|
+
},
|
|
3245
3425
|
{
|
|
3246
3426
|
"name": "totalItems",
|
|
3247
3427
|
"type": "number",
|
|
@@ -3665,6 +3845,43 @@
|
|
|
3665
3845
|
],
|
|
3666
3846
|
"optional": true,
|
|
3667
3847
|
"required": false
|
|
3848
|
+
},
|
|
3849
|
+
{
|
|
3850
|
+
"name": "theme",
|
|
3851
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
3852
|
+
"complexType": {
|
|
3853
|
+
"original": "IcThemeMode",
|
|
3854
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
3855
|
+
"references": {
|
|
3856
|
+
"IcThemeMode": {
|
|
3857
|
+
"location": "import",
|
|
3858
|
+
"path": "../../utils/types",
|
|
3859
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
3860
|
+
}
|
|
3861
|
+
}
|
|
3862
|
+
},
|
|
3863
|
+
"mutable": false,
|
|
3864
|
+
"attr": "theme",
|
|
3865
|
+
"reflectToAttr": false,
|
|
3866
|
+
"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.",
|
|
3867
|
+
"docsTags": [],
|
|
3868
|
+
"default": "\"inherit\"",
|
|
3869
|
+
"values": [
|
|
3870
|
+
{
|
|
3871
|
+
"value": "dark",
|
|
3872
|
+
"type": "string"
|
|
3873
|
+
},
|
|
3874
|
+
{
|
|
3875
|
+
"value": "inherit",
|
|
3876
|
+
"type": "string"
|
|
3877
|
+
},
|
|
3878
|
+
{
|
|
3879
|
+
"value": "light",
|
|
3880
|
+
"type": "string"
|
|
3881
|
+
}
|
|
3882
|
+
],
|
|
3883
|
+
"optional": true,
|
|
3884
|
+
"required": false
|
|
3668
3885
|
}
|
|
3669
3886
|
],
|
|
3670
3887
|
"methods": [
|
|
@@ -3763,39 +3980,6 @@
|
|
|
3763
3980
|
],
|
|
3764
3981
|
"usage": {},
|
|
3765
3982
|
"props": [
|
|
3766
|
-
{
|
|
3767
|
-
"name": "appearance",
|
|
3768
|
-
"type": "\"dark\" | \"light\"",
|
|
3769
|
-
"complexType": {
|
|
3770
|
-
"original": "IcThemeForegroundNoDefault",
|
|
3771
|
-
"resolved": "\"dark\" | \"light\"",
|
|
3772
|
-
"references": {
|
|
3773
|
-
"IcThemeForegroundNoDefault": {
|
|
3774
|
-
"location": "import",
|
|
3775
|
-
"path": "../../utils/types",
|
|
3776
|
-
"id": "src/utils/types.ts::IcThemeForegroundNoDefault"
|
|
3777
|
-
}
|
|
3778
|
-
}
|
|
3779
|
-
},
|
|
3780
|
-
"mutable": false,
|
|
3781
|
-
"attr": "appearance",
|
|
3782
|
-
"reflectToAttr": false,
|
|
3783
|
-
"docs": "The appearance of the tree view, e.g. dark, or light.",
|
|
3784
|
-
"docsTags": [],
|
|
3785
|
-
"default": "\"dark\"",
|
|
3786
|
-
"values": [
|
|
3787
|
-
{
|
|
3788
|
-
"value": "dark",
|
|
3789
|
-
"type": "string"
|
|
3790
|
-
},
|
|
3791
|
-
{
|
|
3792
|
-
"value": "light",
|
|
3793
|
-
"type": "string"
|
|
3794
|
-
}
|
|
3795
|
-
],
|
|
3796
|
-
"optional": true,
|
|
3797
|
-
"required": false
|
|
3798
|
-
},
|
|
3799
3983
|
{
|
|
3800
3984
|
"name": "focusInset",
|
|
3801
3985
|
"type": "boolean",
|
|
@@ -3876,6 +4060,43 @@
|
|
|
3876
4060
|
],
|
|
3877
4061
|
"optional": true,
|
|
3878
4062
|
"required": false
|
|
4063
|
+
},
|
|
4064
|
+
{
|
|
4065
|
+
"name": "theme",
|
|
4066
|
+
"type": "\"dark\" | \"inherit\" | \"light\"",
|
|
4067
|
+
"complexType": {
|
|
4068
|
+
"original": "IcThemeMode",
|
|
4069
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\"",
|
|
4070
|
+
"references": {
|
|
4071
|
+
"IcThemeMode": {
|
|
4072
|
+
"location": "import",
|
|
4073
|
+
"path": "../../utils/types",
|
|
4074
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
4075
|
+
}
|
|
4076
|
+
}
|
|
4077
|
+
},
|
|
4078
|
+
"mutable": false,
|
|
4079
|
+
"attr": "theme",
|
|
4080
|
+
"reflectToAttr": false,
|
|
4081
|
+
"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.",
|
|
4082
|
+
"docsTags": [],
|
|
4083
|
+
"default": "\"inherit\"",
|
|
4084
|
+
"values": [
|
|
4085
|
+
{
|
|
4086
|
+
"value": "dark",
|
|
4087
|
+
"type": "string"
|
|
4088
|
+
},
|
|
4089
|
+
{
|
|
4090
|
+
"value": "inherit",
|
|
4091
|
+
"type": "string"
|
|
4092
|
+
},
|
|
4093
|
+
{
|
|
4094
|
+
"value": "light",
|
|
4095
|
+
"type": "string"
|
|
4096
|
+
}
|
|
4097
|
+
],
|
|
4098
|
+
"optional": true,
|
|
4099
|
+
"required": false
|
|
3879
4100
|
}
|
|
3880
4101
|
],
|
|
3881
4102
|
"methods": [],
|
|
@@ -3927,6 +4148,11 @@
|
|
|
3927
4148
|
"docstring": "",
|
|
3928
4149
|
"path": "src/components/ic-card-horizontal/ic-card-horizontal.types.ts"
|
|
3929
4150
|
},
|
|
4151
|
+
"src/utils/types.ts::IcThemeMode": {
|
|
4152
|
+
"declaration": "export type IcThemeMode = \"dark\" | \"light\" | \"inherit\";",
|
|
4153
|
+
"docstring": "",
|
|
4154
|
+
"path": "src/utils/types.ts"
|
|
4155
|
+
},
|
|
3930
4156
|
"src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableColumnObject": {
|
|
3931
4157
|
"declaration": "{\n key: string;\n title: string;\n dataType: IcDataTableColumnDataTypes;\n columnAlignment?: {\n horizontal?: string;\n vertical?: string;\n };\n rowOptions?: {\n textWrap: boolean;\n };\n columnWidth?: string | IcDataTableColumnWidthTypes;\n textWrap?: boolean;\n cellAlignment?: string;\n emphasis?: string;\n colspan?: number;\n icon?: {\n icon: string;\n onAllCells?: boolean;\n hideOnHeader?: boolean;\n };\n}",
|
|
3932
4158
|
"docstring": "",
|
|
@@ -3947,13 +4173,8 @@
|
|
|
3947
4173
|
"docstring": "",
|
|
3948
4174
|
"path": "src/components/ic-data-table/ic-data-table.types.tsx"
|
|
3949
4175
|
},
|
|
3950
|
-
"../web-components/dist/types/utils/types.d.ts::IcThemeForegroundNoDefault": {
|
|
3951
|
-
"declaration": "export type IcThemeForegroundNoDefault = \"dark\" | \"light\";",
|
|
3952
|
-
"docstring": "",
|
|
3953
|
-
"path": "../web-components/dist/types/utils/types.d.ts"
|
|
3954
|
-
},
|
|
3955
4176
|
"src/utils/types.ts::IcPaginationBarOptions": {
|
|
3956
|
-
"declaration": "export interface IcPaginationBarOptions {\n itemsPerPageOptions?: { label: string; value: string }[];\n rangeLabelType?: IcPaginationLabelTypes;\n type?: IcPaginationTypes;\n showItemsPerPageControl?: boolean;\n showGoToPageControl?: boolean;\n alignment?: IcPaginationAlignmentOptions;\n
|
|
4177
|
+
"declaration": "export interface IcPaginationBarOptions {\n itemsPerPageOptions?: { label: string; value: string }[];\n rangeLabelType?: IcPaginationLabelTypes;\n type?: IcPaginationTypes;\n showItemsPerPageControl?: boolean;\n showGoToPageControl?: boolean;\n alignment?: IcPaginationAlignmentOptions;\n itemLabel?: string;\n pageLabel?: string;\n hideRangeLabel?: boolean;\n hideAllFromItemsPerPage?: boolean;\n theme?: IcThemeMode;\n monochrome?: boolean;\n}",
|
|
3957
4178
|
"docstring": "",
|
|
3958
4179
|
"path": "src/utils/types.ts"
|
|
3959
4180
|
},
|
|
@@ -3977,11 +4198,6 @@
|
|
|
3977
4198
|
"docstring": "",
|
|
3978
4199
|
"path": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts"
|
|
3979
4200
|
},
|
|
3980
|
-
"../web-components/dist/types/interface.d.ts::IcThemeForeground": {
|
|
3981
|
-
"declaration": "any",
|
|
3982
|
-
"docstring": "",
|
|
3983
|
-
"path": "../web-components/dist/types/interface.d.ts"
|
|
3984
|
-
},
|
|
3985
4201
|
"../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationTypes": {
|
|
3986
4202
|
"declaration": "export type IcPaginationTypes = \"simple\" | \"complex\";",
|
|
3987
4203
|
"docstring": "",
|
|
@@ -4021,11 +4237,6 @@
|
|
|
4021
4237
|
"declaration": "export type IcInformationStatusOrEmpty = \"warning\" | \"error\" | \"success\" | \"\";",
|
|
4022
4238
|
"docstring": "",
|
|
4023
4239
|
"path": "src/utils/types.ts"
|
|
4024
|
-
},
|
|
4025
|
-
"src/utils/types.ts::IcThemeForegroundNoDefault": {
|
|
4026
|
-
"declaration": "export type IcThemeForegroundNoDefault = \"dark\" | \"light\";",
|
|
4027
|
-
"docstring": "",
|
|
4028
|
-
"path": "src/utils/types.ts"
|
|
4029
4240
|
}
|
|
4030
4241
|
}
|
|
4031
4242
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/canary-docs",
|
|
4
|
-
"version": "3.0.0-canary.
|
|
4
|
+
"version": "3.0.0-canary.5",
|
|
5
5
|
"description": "API documentation for @ukic canary 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": "7204bc78595a8f362dc1e58e830b8622b6085d45"
|
|
22
22
|
}
|