@ukic/canary-docs 2.0.0-canary.20 → 3.0.0-canary.1

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 +201 -213
  2. 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": "{ [key: string]: any; }[]",
467
+ "type": "IcDataTableDataType[]",
469
468
  "complexType": {
470
- "original": "{ [key: string]: any }[]",
471
- "resolved": "{ [key: string]: any; }[]",
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": "{ [key: string]: any; }[]"
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 longer text in cells where textWrap is `false`.\nThe `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.",
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",
@@ -1734,10 +1872,10 @@
1734
1872
  },
1735
1873
  {
1736
1874
  "name": "size",
1737
- "type": "\"default\" | \"large\" | \"small\"",
1875
+ "type": "\"large\" | \"medium\" | \"small\"",
1738
1876
  "complexType": {
1739
1877
  "original": "IcSizes",
1740
- "resolved": "\"default\" | \"large\" | \"small\"",
1878
+ "resolved": "\"large\" | \"medium\" | \"small\"",
1741
1879
  "references": {
1742
1880
  "IcSizes": {
1743
1881
  "location": "import",
@@ -1751,14 +1889,14 @@
1751
1889
  "reflectToAttr": false,
1752
1890
  "docs": "The size of the date input to be displayed.",
1753
1891
  "docsTags": [],
1754
- "default": "\"default\"",
1892
+ "default": "\"medium\"",
1755
1893
  "values": [
1756
1894
  {
1757
- "value": "default",
1895
+ "value": "large",
1758
1896
  "type": "string"
1759
1897
  },
1760
1898
  {
1761
- "value": "large",
1899
+ "value": "medium",
1762
1900
  "type": "string"
1763
1901
  },
1764
1902
  {
@@ -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",
@@ -2488,10 +2648,10 @@
2488
2648
  },
2489
2649
  {
2490
2650
  "name": "size",
2491
- "type": "\"default\" | \"large\" | \"small\"",
2651
+ "type": "\"large\" | \"medium\" | \"small\"",
2492
2652
  "complexType": {
2493
2653
  "original": "IcSizes",
2494
- "resolved": "\"default\" | \"large\" | \"small\"",
2654
+ "resolved": "\"large\" | \"medium\" | \"small\"",
2495
2655
  "references": {
2496
2656
  "IcSizes": {
2497
2657
  "location": "import",
@@ -2505,14 +2665,14 @@
2505
2665
  "reflectToAttr": false,
2506
2666
  "docs": "The size of the date picker to be displayed.",
2507
2667
  "docsTags": [],
2508
- "default": "\"default\"",
2668
+ "default": "\"medium\"",
2509
2669
  "values": [
2510
2670
  {
2511
- "value": "default",
2671
+ "value": "large",
2512
2672
  "type": "string"
2513
2673
  },
2514
2674
  {
2515
- "value": "large",
2675
+ "value": "medium",
2516
2676
  "type": "string"
2517
2677
  },
2518
2678
  {
@@ -3030,10 +3190,10 @@
3030
3190
  },
3031
3191
  {
3032
3192
  "name": "size",
3033
- "type": "\"default\" | \"large\" | \"small\"",
3193
+ "type": "\"large\" | \"medium\" | \"small\"",
3034
3194
  "complexType": {
3035
3195
  "original": "IcSizes",
3036
- "resolved": "\"default\" | \"large\" | \"small\"",
3196
+ "resolved": "\"large\" | \"medium\" | \"small\"",
3037
3197
  "references": {
3038
3198
  "IcSizes": {
3039
3199
  "location": "import",
@@ -3047,14 +3207,14 @@
3047
3207
  "reflectToAttr": false,
3048
3208
  "docs": "The size of the menu.",
3049
3209
  "docsTags": [],
3050
- "default": "\"default\"",
3210
+ "default": "\"medium\"",
3051
3211
  "values": [
3052
3212
  {
3053
- "value": "default",
3213
+ "value": "large",
3054
3214
  "type": "string"
3055
3215
  },
3056
3216
  {
3057
- "value": "large",
3217
+ "value": "medium",
3058
3218
  "type": "string"
3059
3219
  },
3060
3220
  {
@@ -3065,34 +3225,6 @@
3065
3225
  "optional": true,
3066
3226
  "required": false
3067
3227
  },
3068
- {
3069
- "name": "small",
3070
- "type": "boolean",
3071
- "complexType": {
3072
- "original": "boolean",
3073
- "resolved": "boolean",
3074
- "references": {}
3075
- },
3076
- "mutable": false,
3077
- "attr": "small",
3078
- "reflectToAttr": false,
3079
- "docs": "",
3080
- "docsTags": [
3081
- {
3082
- "name": "deprecated",
3083
- "text": "This prop should not be used anymore. Set prop `size` to \"small\" instead."
3084
- }
3085
- ],
3086
- "default": "false",
3087
- "deprecation": "This prop should not be used anymore. Set prop `size` to \"small\" instead.",
3088
- "values": [
3089
- {
3090
- "type": "boolean"
3091
- }
3092
- ],
3093
- "optional": true,
3094
- "required": false
3095
- },
3096
3228
  {
3097
3229
  "name": "value",
3098
3230
  "type": "string | string[]",
@@ -3645,28 +3777,6 @@
3645
3777
  "docsTags": [],
3646
3778
  "usage": {},
3647
3779
  "props": [
3648
- {
3649
- "name": "charactersUntilSuggestions",
3650
- "type": "number",
3651
- "complexType": {
3652
- "original": "number",
3653
- "resolved": "number",
3654
- "references": {}
3655
- },
3656
- "mutable": false,
3657
- "attr": "characters-until-suggestions",
3658
- "reflectToAttr": false,
3659
- "docs": "**[DEPRECATED]** This prop should not be used anymore.",
3660
- "docsTags": [],
3661
- "default": "0",
3662
- "values": [
3663
- {
3664
- "type": "number"
3665
- }
3666
- ],
3667
- "optional": true,
3668
- "required": false
3669
- },
3670
3780
  {
3671
3781
  "name": "debounce",
3672
3782
  "type": "number",
@@ -3690,7 +3800,7 @@
3690
3800
  "required": false
3691
3801
  },
3692
3802
  {
3693
- "name": "disableFilter",
3803
+ "name": "disableAutoFiltering",
3694
3804
  "type": "boolean",
3695
3805
  "complexType": {
3696
3806
  "original": "boolean",
@@ -3698,7 +3808,7 @@
3698
3808
  "references": {}
3699
3809
  },
3700
3810
  "mutable": false,
3701
- "attr": "disable-filter",
3811
+ "attr": "disable-auto-filtering",
3702
3812
  "reflectToAttr": false,
3703
3813
  "docs": "If `true`, the built in filtering will be disabled for a searchable variant. For example, if options will already be filtered from external source.",
3704
3814
  "docsTags": [],
@@ -3776,111 +3886,6 @@
3776
3886
  "optional": true,
3777
3887
  "required": false
3778
3888
  },
3779
- {
3780
- "name": "formaction",
3781
- "type": "string",
3782
- "complexType": {
3783
- "original": "string",
3784
- "resolved": "string",
3785
- "references": {}
3786
- },
3787
- "mutable": false,
3788
- "attr": "formaction",
3789
- "reflectToAttr": false,
3790
- "docs": "The URL that processes the information submitted by the select. It overrides the action attribute of the select's form owner. Does nothing if there is no form owner.\nThis prop should only be used with searchable select and will only be applied if searchable is true.",
3791
- "docsTags": [],
3792
- "values": [
3793
- {
3794
- "type": "string"
3795
- }
3796
- ],
3797
- "optional": true,
3798
- "required": false
3799
- },
3800
- {
3801
- "name": "formenctype",
3802
- "type": "string",
3803
- "complexType": {
3804
- "original": "string",
3805
- "resolved": "string",
3806
- "references": {}
3807
- },
3808
- "mutable": false,
3809
- "attr": "formenctype",
3810
- "reflectToAttr": false,
3811
- "docs": "The way the submitted form data is encoded. This prop should only be used with searchable select and will only be applied if searchable is true.",
3812
- "docsTags": [],
3813
- "values": [
3814
- {
3815
- "type": "string"
3816
- }
3817
- ],
3818
- "optional": true,
3819
- "required": false
3820
- },
3821
- {
3822
- "name": "formmethod",
3823
- "type": "string",
3824
- "complexType": {
3825
- "original": "string",
3826
- "resolved": "string",
3827
- "references": {}
3828
- },
3829
- "mutable": false,
3830
- "attr": "formmethod",
3831
- "reflectToAttr": false,
3832
- "docs": "The HTTP method used to submit the form. This prop should only be used with searchable select and will only be applied if searchable is true.",
3833
- "docsTags": [],
3834
- "values": [
3835
- {
3836
- "type": "string"
3837
- }
3838
- ],
3839
- "optional": true,
3840
- "required": false
3841
- },
3842
- {
3843
- "name": "formnovalidate",
3844
- "type": "boolean",
3845
- "complexType": {
3846
- "original": "boolean",
3847
- "resolved": "boolean",
3848
- "references": {}
3849
- },
3850
- "mutable": false,
3851
- "attr": "formnovalidate",
3852
- "reflectToAttr": false,
3853
- "docs": "If `true`, the form will not be validated when submitted. This prop should only be used with searchable select and will only be applied if searchable is true.",
3854
- "docsTags": [],
3855
- "values": [
3856
- {
3857
- "type": "boolean"
3858
- }
3859
- ],
3860
- "optional": true,
3861
- "required": false
3862
- },
3863
- {
3864
- "name": "formtarget",
3865
- "type": "string",
3866
- "complexType": {
3867
- "original": "string",
3868
- "resolved": "string",
3869
- "references": {}
3870
- },
3871
- "mutable": false,
3872
- "attr": "formtarget",
3873
- "reflectToAttr": false,
3874
- "docs": "The place to display the response from submitting the form. It overrides the target attribute of the select's form owner.\nThis prop should only be used with searchable select and will only be applied if searchable is true.",
3875
- "docsTags": [],
3876
- "values": [
3877
- {
3878
- "type": "string"
3879
- }
3880
- ],
3881
- "optional": true,
3882
- "required": false
3883
- },
3884
3889
  {
3885
3890
  "name": "fullWidth",
3886
3891
  "type": "boolean",
@@ -4316,10 +4321,10 @@
4316
4321
  },
4317
4322
  {
4318
4323
  "name": "size",
4319
- "type": "\"default\" | \"large\" | \"small\"",
4324
+ "type": "\"large\" | \"medium\" | \"small\"",
4320
4325
  "complexType": {
4321
4326
  "original": "IcSizes",
4322
- "resolved": "\"default\" | \"large\" | \"small\"",
4327
+ "resolved": "\"large\" | \"medium\" | \"small\"",
4323
4328
  "references": {
4324
4329
  "IcSizes": {
4325
4330
  "location": "import",
@@ -4333,14 +4338,14 @@
4333
4338
  "reflectToAttr": false,
4334
4339
  "docs": "The size of the select.",
4335
4340
  "docsTags": [],
4336
- "default": "\"default\"",
4341
+ "default": "\"medium\"",
4337
4342
  "values": [
4338
4343
  {
4339
- "value": "default",
4344
+ "value": "large",
4340
4345
  "type": "string"
4341
4346
  },
4342
4347
  {
4343
- "value": "large",
4348
+ "value": "medium",
4344
4349
  "type": "string"
4345
4350
  },
4346
4351
  {
@@ -4351,28 +4356,6 @@
4351
4356
  "optional": true,
4352
4357
  "required": false
4353
4358
  },
4354
- {
4355
- "name": "small",
4356
- "type": "boolean",
4357
- "complexType": {
4358
- "original": "boolean",
4359
- "resolved": "boolean",
4360
- "references": {}
4361
- },
4362
- "mutable": false,
4363
- "attr": "small",
4364
- "reflectToAttr": false,
4365
- "docs": "**[DEPRECATED]** This prop should not be used anymore. Set prop `size` to \"small\" instead.",
4366
- "docsTags": [],
4367
- "default": "false",
4368
- "values": [
4369
- {
4370
- "type": "boolean"
4371
- }
4372
- ],
4373
- "optional": true,
4374
- "required": false
4375
- },
4376
4359
  {
4377
4360
  "name": "timeout",
4378
4361
  "type": "number",
@@ -5097,10 +5080,10 @@
5097
5080
  },
5098
5081
  {
5099
5082
  "name": "size",
5100
- "type": "\"default\" | \"large\" | \"small\"",
5083
+ "type": "\"large\" | \"medium\" | \"small\"",
5101
5084
  "complexType": {
5102
5085
  "original": "IcSizes",
5103
- "resolved": "\"default\" | \"large\" | \"small\"",
5086
+ "resolved": "\"large\" | \"medium\" | \"small\"",
5104
5087
  "references": {
5105
5088
  "IcSizes": {
5106
5089
  "location": "import",
@@ -5114,14 +5097,14 @@
5114
5097
  "reflectToAttr": false,
5115
5098
  "docs": "The size of the tree view.",
5116
5099
  "docsTags": [],
5117
- "default": "\"default\"",
5100
+ "default": "\"medium\"",
5118
5101
  "values": [
5119
5102
  {
5120
- "value": "default",
5103
+ "value": "large",
5121
5104
  "type": "string"
5122
5105
  },
5123
5106
  {
5124
- "value": "large",
5107
+ "value": "medium",
5125
5108
  "type": "string"
5126
5109
  },
5127
5110
  {
@@ -5183,7 +5166,12 @@
5183
5166
  "path": "src/components/ic-card-horizontal/ic-card-horizontal.types.ts"
5184
5167
  },
5185
5168
  "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?: IcDataTableRowOptions;\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}",
5169
+ "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}",
5170
+ "docstring": "",
5171
+ "path": "src/components/ic-data-table/ic-data-table.types.tsx"
5172
+ },
5173
+ "src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableDataType": {
5174
+ "declaration": "{ [key: string]: any }",
5187
5175
  "docstring": "",
5188
5176
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
5189
5177
  },
@@ -5258,7 +5246,7 @@
5258
5246
  "path": "src/utils/types.ts"
5259
5247
  },
5260
5248
  "src/utils/types.ts::IcSizes": {
5261
- "declaration": "export type IcSizes = \"default\" | \"large\" | \"small\";",
5249
+ "declaration": "export type IcSizes = \"medium\" | \"large\" | \"small\";",
5262
5250
  "docstring": "",
5263
5251
  "path": "src/utils/types.ts"
5264
5252
  },
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.20",
4
+ "version": "3.0.0-canary.1",
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": "44512a54cc667c1e09d428515a274d34b3c050ec"
21
+ "gitHead": "1c5671823f89c50f5e16d4f40e1bc15ae2310518"
22
22
  }