@ukic/canary-docs 2.0.0-canary.20 → 2.0.0-canary.22
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,5 +1,4 @@
|
|
|
1
1
|
{
|
|
2
|
-
"timestamp": "2024-09-05T11:01:59",
|
|
3
2
|
"compiler": {
|
|
4
3
|
"name": "@stencil/core",
|
|
5
4
|
"version": "4.9.0",
|
|
@@ -465,11 +464,17 @@
|
|
|
465
464
|
},
|
|
466
465
|
{
|
|
467
466
|
"name": "data",
|
|
468
|
-
"type": "
|
|
467
|
+
"type": "IcDataTableDataType[]",
|
|
469
468
|
"complexType": {
|
|
470
|
-
"original": "
|
|
471
|
-
"resolved": "
|
|
472
|
-
"references": {
|
|
469
|
+
"original": "IcDataTableDataType[]",
|
|
470
|
+
"resolved": "IcDataTableDataType[]",
|
|
471
|
+
"references": {
|
|
472
|
+
"IcDataTableDataType": {
|
|
473
|
+
"location": "import",
|
|
474
|
+
"path": "./ic-data-table.types",
|
|
475
|
+
"id": "src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableDataType"
|
|
476
|
+
}
|
|
477
|
+
}
|
|
473
478
|
},
|
|
474
479
|
"mutable": false,
|
|
475
480
|
"reflectToAttr": false,
|
|
@@ -477,7 +482,7 @@
|
|
|
477
482
|
"docsTags": [],
|
|
478
483
|
"values": [
|
|
479
484
|
{
|
|
480
|
-
"type": "
|
|
485
|
+
"type": "IcDataTableDataType[]"
|
|
481
486
|
}
|
|
482
487
|
],
|
|
483
488
|
"optional": false,
|
|
@@ -574,6 +579,27 @@
|
|
|
574
579
|
"optional": true,
|
|
575
580
|
"required": false
|
|
576
581
|
},
|
|
582
|
+
{
|
|
583
|
+
"name": "height",
|
|
584
|
+
"type": "string",
|
|
585
|
+
"complexType": {
|
|
586
|
+
"original": "string",
|
|
587
|
+
"resolved": "string",
|
|
588
|
+
"references": {}
|
|
589
|
+
},
|
|
590
|
+
"mutable": false,
|
|
591
|
+
"attr": "height",
|
|
592
|
+
"reflectToAttr": false,
|
|
593
|
+
"docs": "Sets the table height. Can be set to `auto` or a specific value in `px`, `rem`, or `%`.",
|
|
594
|
+
"docsTags": [],
|
|
595
|
+
"values": [
|
|
596
|
+
{
|
|
597
|
+
"type": "string"
|
|
598
|
+
}
|
|
599
|
+
],
|
|
600
|
+
"optional": true,
|
|
601
|
+
"required": false
|
|
602
|
+
},
|
|
577
603
|
{
|
|
578
604
|
"name": "hideColumnHeaders",
|
|
579
605
|
"type": "boolean",
|
|
@@ -644,6 +670,48 @@
|
|
|
644
670
|
"optional": true,
|
|
645
671
|
"required": false
|
|
646
672
|
},
|
|
673
|
+
{
|
|
674
|
+
"name": "maxWidth",
|
|
675
|
+
"type": "string",
|
|
676
|
+
"complexType": {
|
|
677
|
+
"original": "string",
|
|
678
|
+
"resolved": "string",
|
|
679
|
+
"references": {}
|
|
680
|
+
},
|
|
681
|
+
"mutable": false,
|
|
682
|
+
"attr": "max-width",
|
|
683
|
+
"reflectToAttr": false,
|
|
684
|
+
"docs": "Sets the maximum width of the data table. Can be set in `px`, `rem`, or `%`.",
|
|
685
|
+
"docsTags": [],
|
|
686
|
+
"values": [
|
|
687
|
+
{
|
|
688
|
+
"type": "string"
|
|
689
|
+
}
|
|
690
|
+
],
|
|
691
|
+
"optional": true,
|
|
692
|
+
"required": false
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
"name": "minWidth",
|
|
696
|
+
"type": "string",
|
|
697
|
+
"complexType": {
|
|
698
|
+
"original": "string",
|
|
699
|
+
"resolved": "string",
|
|
700
|
+
"references": {}
|
|
701
|
+
},
|
|
702
|
+
"mutable": false,
|
|
703
|
+
"attr": "min-width",
|
|
704
|
+
"reflectToAttr": false,
|
|
705
|
+
"docs": "Sets the minimum width of the data table. Can be set in `px`, `rem`, or `%`.",
|
|
706
|
+
"docsTags": [],
|
|
707
|
+
"values": [
|
|
708
|
+
{
|
|
709
|
+
"type": "string"
|
|
710
|
+
}
|
|
711
|
+
],
|
|
712
|
+
"optional": true,
|
|
713
|
+
"required": false
|
|
714
|
+
},
|
|
647
715
|
{
|
|
648
716
|
"name": "minimumLoadingDisplayDuration",
|
|
649
717
|
"type": "number",
|
|
@@ -808,6 +876,33 @@
|
|
|
808
876
|
"optional": true,
|
|
809
877
|
"required": false
|
|
810
878
|
},
|
|
879
|
+
{
|
|
880
|
+
"name": "tableLayout",
|
|
881
|
+
"type": "\"auto\" | \"fixed\"",
|
|
882
|
+
"complexType": {
|
|
883
|
+
"original": "\"fixed\" | \"auto\"",
|
|
884
|
+
"resolved": "\"auto\" | \"fixed\"",
|
|
885
|
+
"references": {}
|
|
886
|
+
},
|
|
887
|
+
"mutable": false,
|
|
888
|
+
"attr": "table-layout",
|
|
889
|
+
"reflectToAttr": false,
|
|
890
|
+
"docs": "Sets the layout of the table",
|
|
891
|
+
"docsTags": [],
|
|
892
|
+
"default": "\"fixed\"",
|
|
893
|
+
"values": [
|
|
894
|
+
{
|
|
895
|
+
"value": "auto",
|
|
896
|
+
"type": "string"
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"value": "fixed",
|
|
900
|
+
"type": "string"
|
|
901
|
+
}
|
|
902
|
+
],
|
|
903
|
+
"optional": true,
|
|
904
|
+
"required": false
|
|
905
|
+
},
|
|
811
906
|
{
|
|
812
907
|
"name": "truncationPattern",
|
|
813
908
|
"type": "\"show-hide\" | \"tooltip\"",
|
|
@@ -825,7 +920,7 @@
|
|
|
825
920
|
"mutable": false,
|
|
826
921
|
"attr": "truncation-pattern",
|
|
827
922
|
"reflectToAttr": false,
|
|
828
|
-
"docs": "Sets the method used to truncate
|
|
923
|
+
"docs": "Sets the method used to truncate long text in cells where textWrap is `false`. The `tooltip` truncation pattern allows the overflowing text to be seen in a tooltip. The `show-hide` truncation pattern allows the overflowing text to be shown and hidden using the ic-typography \"See more\"/\"See less\" buttons.",
|
|
829
924
|
"docsTags": [],
|
|
830
925
|
"values": [
|
|
831
926
|
{
|
|
@@ -913,6 +1008,27 @@
|
|
|
913
1008
|
],
|
|
914
1009
|
"optional": true,
|
|
915
1010
|
"required": false
|
|
1011
|
+
},
|
|
1012
|
+
{
|
|
1013
|
+
"name": "width",
|
|
1014
|
+
"type": "string",
|
|
1015
|
+
"complexType": {
|
|
1016
|
+
"original": "string",
|
|
1017
|
+
"resolved": "string",
|
|
1018
|
+
"references": {}
|
|
1019
|
+
},
|
|
1020
|
+
"mutable": false,
|
|
1021
|
+
"attr": "width",
|
|
1022
|
+
"reflectToAttr": false,
|
|
1023
|
+
"docs": "Sets the table width. Can be set to `auto` or a specific value in `px`, `rem`, or `%`.",
|
|
1024
|
+
"docsTags": [],
|
|
1025
|
+
"values": [
|
|
1026
|
+
{
|
|
1027
|
+
"type": "string"
|
|
1028
|
+
}
|
|
1029
|
+
],
|
|
1030
|
+
"optional": true,
|
|
1031
|
+
"required": false
|
|
916
1032
|
}
|
|
917
1033
|
],
|
|
918
1034
|
"methods": [
|
|
@@ -1585,6 +1701,28 @@
|
|
|
1585
1701
|
"optional": true,
|
|
1586
1702
|
"required": false
|
|
1587
1703
|
},
|
|
1704
|
+
{
|
|
1705
|
+
"name": "invalidDateMessage",
|
|
1706
|
+
"type": "string",
|
|
1707
|
+
"complexType": {
|
|
1708
|
+
"original": "string",
|
|
1709
|
+
"resolved": "string",
|
|
1710
|
+
"references": {}
|
|
1711
|
+
},
|
|
1712
|
+
"mutable": false,
|
|
1713
|
+
"attr": "invalid-date-message",
|
|
1714
|
+
"reflectToAttr": false,
|
|
1715
|
+
"docs": "The text to display as the validation message when an invalid date is entered.",
|
|
1716
|
+
"docsTags": [],
|
|
1717
|
+
"default": "\"Please enter a valid date.\"",
|
|
1718
|
+
"values": [
|
|
1719
|
+
{
|
|
1720
|
+
"type": "string"
|
|
1721
|
+
}
|
|
1722
|
+
],
|
|
1723
|
+
"optional": true,
|
|
1724
|
+
"required": false
|
|
1725
|
+
},
|
|
1588
1726
|
{
|
|
1589
1727
|
"name": "label",
|
|
1590
1728
|
"type": "string",
|
|
@@ -2266,6 +2404,28 @@
|
|
|
2266
2404
|
"optional": true,
|
|
2267
2405
|
"required": false
|
|
2268
2406
|
},
|
|
2407
|
+
{
|
|
2408
|
+
"name": "invalidDateMessage",
|
|
2409
|
+
"type": "string",
|
|
2410
|
+
"complexType": {
|
|
2411
|
+
"original": "string",
|
|
2412
|
+
"resolved": "string",
|
|
2413
|
+
"references": {}
|
|
2414
|
+
},
|
|
2415
|
+
"mutable": false,
|
|
2416
|
+
"attr": "invalid-date-message",
|
|
2417
|
+
"reflectToAttr": false,
|
|
2418
|
+
"docs": "The text to display as the validation message when an invalid date is entered.",
|
|
2419
|
+
"docsTags": [],
|
|
2420
|
+
"default": "\"Please enter a valid date.\"",
|
|
2421
|
+
"values": [
|
|
2422
|
+
{
|
|
2423
|
+
"type": "string"
|
|
2424
|
+
}
|
|
2425
|
+
],
|
|
2426
|
+
"optional": true,
|
|
2427
|
+
"required": false
|
|
2428
|
+
},
|
|
2269
2429
|
{
|
|
2270
2430
|
"name": "label",
|
|
2271
2431
|
"type": "string",
|
|
@@ -3308,6 +3468,28 @@
|
|
|
3308
3468
|
"optional": true,
|
|
3309
3469
|
"required": false
|
|
3310
3470
|
},
|
|
3471
|
+
{
|
|
3472
|
+
"name": "currentPage",
|
|
3473
|
+
"type": "number",
|
|
3474
|
+
"complexType": {
|
|
3475
|
+
"original": "number",
|
|
3476
|
+
"resolved": "number",
|
|
3477
|
+
"references": {}
|
|
3478
|
+
},
|
|
3479
|
+
"mutable": false,
|
|
3480
|
+
"attr": "current-page",
|
|
3481
|
+
"reflectToAttr": false,
|
|
3482
|
+
"docs": "The current page number to be displayed on the pagination bar.",
|
|
3483
|
+
"docsTags": [],
|
|
3484
|
+
"default": "1",
|
|
3485
|
+
"values": [
|
|
3486
|
+
{
|
|
3487
|
+
"type": "number"
|
|
3488
|
+
}
|
|
3489
|
+
],
|
|
3490
|
+
"optional": true,
|
|
3491
|
+
"required": false
|
|
3492
|
+
},
|
|
3311
3493
|
{
|
|
3312
3494
|
"name": "hideRangeLabel",
|
|
3313
3495
|
"type": "boolean",
|
|
@@ -3544,16 +3726,22 @@
|
|
|
3544
3726
|
},
|
|
3545
3727
|
{
|
|
3546
3728
|
"event": "icPageChange",
|
|
3547
|
-
"detail": "
|
|
3729
|
+
"detail": "IcPageChangeEventDetail",
|
|
3548
3730
|
"bubbles": true,
|
|
3549
3731
|
"complexType": {
|
|
3550
|
-
"original": "
|
|
3551
|
-
"resolved": "
|
|
3552
|
-
"references": {
|
|
3732
|
+
"original": "IcPageChangeEventDetail",
|
|
3733
|
+
"resolved": "IcPageChangeEventDetail",
|
|
3734
|
+
"references": {
|
|
3735
|
+
"IcPageChangeEventDetail": {
|
|
3736
|
+
"location": "import",
|
|
3737
|
+
"path": "./ic-pagination-bar.types",
|
|
3738
|
+
"id": "src/components/ic-pagination-bar/ic-pagination-bar.types.ts::IcPageChangeEventDetail"
|
|
3739
|
+
}
|
|
3740
|
+
}
|
|
3553
3741
|
},
|
|
3554
3742
|
"cancelable": true,
|
|
3555
3743
|
"composed": true,
|
|
3556
|
-
"docs": "Emitted when a page is navigated to via the 'go to' input.",
|
|
3744
|
+
"docs": "Emitted when a page is navigated to via the 'go to' input.\nThe `detail` property contains `value` (i.e. the page number) and a `fromItemsPerPage` flag to indicate if the event was triggered by the `icItemsPerPageChange` event also occurring.",
|
|
3557
3745
|
"docsTags": []
|
|
3558
3746
|
}
|
|
3559
3747
|
],
|
|
@@ -5183,7 +5371,12 @@
|
|
|
5183
5371
|
"path": "src/components/ic-card-horizontal/ic-card-horizontal.types.ts"
|
|
5184
5372
|
},
|
|
5185
5373
|
"src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableColumnObject": {
|
|
5186
|
-
"declaration": "{\n key: string;\n title: string;\n dataType: IcDataTableColumnDataTypes;\n columnAlignment?: {\n horizontal?: string;\n vertical?: string;\n };\n rowOptions?:
|
|
5374
|
+
"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}",
|
|
5375
|
+
"docstring": "",
|
|
5376
|
+
"path": "src/components/ic-data-table/ic-data-table.types.tsx"
|
|
5377
|
+
},
|
|
5378
|
+
"src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableDataType": {
|
|
5379
|
+
"declaration": "{ [key: string]: any }",
|
|
5187
5380
|
"docstring": "",
|
|
5188
5381
|
"path": "src/components/ic-data-table/ic-data-table.types.tsx"
|
|
5189
5382
|
},
|
|
@@ -5242,6 +5435,11 @@
|
|
|
5242
5435
|
"docstring": "",
|
|
5243
5436
|
"path": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts"
|
|
5244
5437
|
},
|
|
5438
|
+
"src/components/ic-pagination-bar/ic-pagination-bar.types.ts::IcPageChangeEventDetail": {
|
|
5439
|
+
"declaration": "export interface IcPageChangeEventDetail {\n value: number;\n fromItemsPerPage?: boolean;\n}",
|
|
5440
|
+
"docstring": "",
|
|
5441
|
+
"path": "src/components/ic-pagination-bar/ic-pagination-bar.types.ts"
|
|
5442
|
+
},
|
|
5245
5443
|
"src/components/ic-data-table/ic-data-table.types.tsx::IcDensityUpdateEventDetail": {
|
|
5246
5444
|
"declaration": "export interface IcDensityUpdateEventDetail {\n value: IcDataTableDensityOptions;\n}",
|
|
5247
5445
|
"docstring": "",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/canary-docs",
|
|
4
|
-
"version": "2.0.0-canary.
|
|
4
|
+
"version": "2.0.0-canary.22",
|
|
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": "3722eb9496a95846172a9a41c70055d75265cdd6"
|
|
22
22
|
}
|