@ukic/canary-docs 2.0.0-canary.21 → 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 +28 -205
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1872,10 +1872,10 @@
1872
1872
  },
1873
1873
  {
1874
1874
  "name": "size",
1875
- "type": "\"default\" | \"large\" | \"small\"",
1875
+ "type": "\"large\" | \"medium\" | \"small\"",
1876
1876
  "complexType": {
1877
1877
  "original": "IcSizes",
1878
- "resolved": "\"default\" | \"large\" | \"small\"",
1878
+ "resolved": "\"large\" | \"medium\" | \"small\"",
1879
1879
  "references": {
1880
1880
  "IcSizes": {
1881
1881
  "location": "import",
@@ -1889,14 +1889,14 @@
1889
1889
  "reflectToAttr": false,
1890
1890
  "docs": "The size of the date input to be displayed.",
1891
1891
  "docsTags": [],
1892
- "default": "\"default\"",
1892
+ "default": "\"medium\"",
1893
1893
  "values": [
1894
1894
  {
1895
- "value": "default",
1895
+ "value": "large",
1896
1896
  "type": "string"
1897
1897
  },
1898
1898
  {
1899
- "value": "large",
1899
+ "value": "medium",
1900
1900
  "type": "string"
1901
1901
  },
1902
1902
  {
@@ -2648,10 +2648,10 @@
2648
2648
  },
2649
2649
  {
2650
2650
  "name": "size",
2651
- "type": "\"default\" | \"large\" | \"small\"",
2651
+ "type": "\"large\" | \"medium\" | \"small\"",
2652
2652
  "complexType": {
2653
2653
  "original": "IcSizes",
2654
- "resolved": "\"default\" | \"large\" | \"small\"",
2654
+ "resolved": "\"large\" | \"medium\" | \"small\"",
2655
2655
  "references": {
2656
2656
  "IcSizes": {
2657
2657
  "location": "import",
@@ -2665,14 +2665,14 @@
2665
2665
  "reflectToAttr": false,
2666
2666
  "docs": "The size of the date picker to be displayed.",
2667
2667
  "docsTags": [],
2668
- "default": "\"default\"",
2668
+ "default": "\"medium\"",
2669
2669
  "values": [
2670
2670
  {
2671
- "value": "default",
2671
+ "value": "large",
2672
2672
  "type": "string"
2673
2673
  },
2674
2674
  {
2675
- "value": "large",
2675
+ "value": "medium",
2676
2676
  "type": "string"
2677
2677
  },
2678
2678
  {
@@ -3190,10 +3190,10 @@
3190
3190
  },
3191
3191
  {
3192
3192
  "name": "size",
3193
- "type": "\"default\" | \"large\" | \"small\"",
3193
+ "type": "\"large\" | \"medium\" | \"small\"",
3194
3194
  "complexType": {
3195
3195
  "original": "IcSizes",
3196
- "resolved": "\"default\" | \"large\" | \"small\"",
3196
+ "resolved": "\"large\" | \"medium\" | \"small\"",
3197
3197
  "references": {
3198
3198
  "IcSizes": {
3199
3199
  "location": "import",
@@ -3207,14 +3207,14 @@
3207
3207
  "reflectToAttr": false,
3208
3208
  "docs": "The size of the menu.",
3209
3209
  "docsTags": [],
3210
- "default": "\"default\"",
3210
+ "default": "\"medium\"",
3211
3211
  "values": [
3212
3212
  {
3213
- "value": "default",
3213
+ "value": "large",
3214
3214
  "type": "string"
3215
3215
  },
3216
3216
  {
3217
- "value": "large",
3217
+ "value": "medium",
3218
3218
  "type": "string"
3219
3219
  },
3220
3220
  {
@@ -3225,34 +3225,6 @@
3225
3225
  "optional": true,
3226
3226
  "required": false
3227
3227
  },
3228
- {
3229
- "name": "small",
3230
- "type": "boolean",
3231
- "complexType": {
3232
- "original": "boolean",
3233
- "resolved": "boolean",
3234
- "references": {}
3235
- },
3236
- "mutable": false,
3237
- "attr": "small",
3238
- "reflectToAttr": false,
3239
- "docs": "",
3240
- "docsTags": [
3241
- {
3242
- "name": "deprecated",
3243
- "text": "This prop should not be used anymore. Set prop `size` to \"small\" instead."
3244
- }
3245
- ],
3246
- "default": "false",
3247
- "deprecation": "This prop should not be used anymore. Set prop `size` to \"small\" instead.",
3248
- "values": [
3249
- {
3250
- "type": "boolean"
3251
- }
3252
- ],
3253
- "optional": true,
3254
- "required": false
3255
- },
3256
3228
  {
3257
3229
  "name": "value",
3258
3230
  "type": "string | string[]",
@@ -3805,28 +3777,6 @@
3805
3777
  "docsTags": [],
3806
3778
  "usage": {},
3807
3779
  "props": [
3808
- {
3809
- "name": "charactersUntilSuggestions",
3810
- "type": "number",
3811
- "complexType": {
3812
- "original": "number",
3813
- "resolved": "number",
3814
- "references": {}
3815
- },
3816
- "mutable": false,
3817
- "attr": "characters-until-suggestions",
3818
- "reflectToAttr": false,
3819
- "docs": "**[DEPRECATED]** This prop should not be used anymore.",
3820
- "docsTags": [],
3821
- "default": "0",
3822
- "values": [
3823
- {
3824
- "type": "number"
3825
- }
3826
- ],
3827
- "optional": true,
3828
- "required": false
3829
- },
3830
3780
  {
3831
3781
  "name": "debounce",
3832
3782
  "type": "number",
@@ -3850,7 +3800,7 @@
3850
3800
  "required": false
3851
3801
  },
3852
3802
  {
3853
- "name": "disableFilter",
3803
+ "name": "disableAutoFiltering",
3854
3804
  "type": "boolean",
3855
3805
  "complexType": {
3856
3806
  "original": "boolean",
@@ -3858,7 +3808,7 @@
3858
3808
  "references": {}
3859
3809
  },
3860
3810
  "mutable": false,
3861
- "attr": "disable-filter",
3811
+ "attr": "disable-auto-filtering",
3862
3812
  "reflectToAttr": false,
3863
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.",
3864
3814
  "docsTags": [],
@@ -3936,111 +3886,6 @@
3936
3886
  "optional": true,
3937
3887
  "required": false
3938
3888
  },
3939
- {
3940
- "name": "formaction",
3941
- "type": "string",
3942
- "complexType": {
3943
- "original": "string",
3944
- "resolved": "string",
3945
- "references": {}
3946
- },
3947
- "mutable": false,
3948
- "attr": "formaction",
3949
- "reflectToAttr": false,
3950
- "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.",
3951
- "docsTags": [],
3952
- "values": [
3953
- {
3954
- "type": "string"
3955
- }
3956
- ],
3957
- "optional": true,
3958
- "required": false
3959
- },
3960
- {
3961
- "name": "formenctype",
3962
- "type": "string",
3963
- "complexType": {
3964
- "original": "string",
3965
- "resolved": "string",
3966
- "references": {}
3967
- },
3968
- "mutable": false,
3969
- "attr": "formenctype",
3970
- "reflectToAttr": false,
3971
- "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.",
3972
- "docsTags": [],
3973
- "values": [
3974
- {
3975
- "type": "string"
3976
- }
3977
- ],
3978
- "optional": true,
3979
- "required": false
3980
- },
3981
- {
3982
- "name": "formmethod",
3983
- "type": "string",
3984
- "complexType": {
3985
- "original": "string",
3986
- "resolved": "string",
3987
- "references": {}
3988
- },
3989
- "mutable": false,
3990
- "attr": "formmethod",
3991
- "reflectToAttr": false,
3992
- "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.",
3993
- "docsTags": [],
3994
- "values": [
3995
- {
3996
- "type": "string"
3997
- }
3998
- ],
3999
- "optional": true,
4000
- "required": false
4001
- },
4002
- {
4003
- "name": "formnovalidate",
4004
- "type": "boolean",
4005
- "complexType": {
4006
- "original": "boolean",
4007
- "resolved": "boolean",
4008
- "references": {}
4009
- },
4010
- "mutable": false,
4011
- "attr": "formnovalidate",
4012
- "reflectToAttr": false,
4013
- "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.",
4014
- "docsTags": [],
4015
- "values": [
4016
- {
4017
- "type": "boolean"
4018
- }
4019
- ],
4020
- "optional": true,
4021
- "required": false
4022
- },
4023
- {
4024
- "name": "formtarget",
4025
- "type": "string",
4026
- "complexType": {
4027
- "original": "string",
4028
- "resolved": "string",
4029
- "references": {}
4030
- },
4031
- "mutable": false,
4032
- "attr": "formtarget",
4033
- "reflectToAttr": false,
4034
- "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.",
4035
- "docsTags": [],
4036
- "values": [
4037
- {
4038
- "type": "string"
4039
- }
4040
- ],
4041
- "optional": true,
4042
- "required": false
4043
- },
4044
3889
  {
4045
3890
  "name": "fullWidth",
4046
3891
  "type": "boolean",
@@ -4476,10 +4321,10 @@
4476
4321
  },
4477
4322
  {
4478
4323
  "name": "size",
4479
- "type": "\"default\" | \"large\" | \"small\"",
4324
+ "type": "\"large\" | \"medium\" | \"small\"",
4480
4325
  "complexType": {
4481
4326
  "original": "IcSizes",
4482
- "resolved": "\"default\" | \"large\" | \"small\"",
4327
+ "resolved": "\"large\" | \"medium\" | \"small\"",
4483
4328
  "references": {
4484
4329
  "IcSizes": {
4485
4330
  "location": "import",
@@ -4493,14 +4338,14 @@
4493
4338
  "reflectToAttr": false,
4494
4339
  "docs": "The size of the select.",
4495
4340
  "docsTags": [],
4496
- "default": "\"default\"",
4341
+ "default": "\"medium\"",
4497
4342
  "values": [
4498
4343
  {
4499
- "value": "default",
4344
+ "value": "large",
4500
4345
  "type": "string"
4501
4346
  },
4502
4347
  {
4503
- "value": "large",
4348
+ "value": "medium",
4504
4349
  "type": "string"
4505
4350
  },
4506
4351
  {
@@ -4511,28 +4356,6 @@
4511
4356
  "optional": true,
4512
4357
  "required": false
4513
4358
  },
4514
- {
4515
- "name": "small",
4516
- "type": "boolean",
4517
- "complexType": {
4518
- "original": "boolean",
4519
- "resolved": "boolean",
4520
- "references": {}
4521
- },
4522
- "mutable": false,
4523
- "attr": "small",
4524
- "reflectToAttr": false,
4525
- "docs": "**[DEPRECATED]** This prop should not be used anymore. Set prop `size` to \"small\" instead.",
4526
- "docsTags": [],
4527
- "default": "false",
4528
- "values": [
4529
- {
4530
- "type": "boolean"
4531
- }
4532
- ],
4533
- "optional": true,
4534
- "required": false
4535
- },
4536
4359
  {
4537
4360
  "name": "timeout",
4538
4361
  "type": "number",
@@ -5257,10 +5080,10 @@
5257
5080
  },
5258
5081
  {
5259
5082
  "name": "size",
5260
- "type": "\"default\" | \"large\" | \"small\"",
5083
+ "type": "\"large\" | \"medium\" | \"small\"",
5261
5084
  "complexType": {
5262
5085
  "original": "IcSizes",
5263
- "resolved": "\"default\" | \"large\" | \"small\"",
5086
+ "resolved": "\"large\" | \"medium\" | \"small\"",
5264
5087
  "references": {
5265
5088
  "IcSizes": {
5266
5089
  "location": "import",
@@ -5274,14 +5097,14 @@
5274
5097
  "reflectToAttr": false,
5275
5098
  "docs": "The size of the tree view.",
5276
5099
  "docsTags": [],
5277
- "default": "\"default\"",
5100
+ "default": "\"medium\"",
5278
5101
  "values": [
5279
5102
  {
5280
- "value": "default",
5103
+ "value": "large",
5281
5104
  "type": "string"
5282
5105
  },
5283
5106
  {
5284
- "value": "large",
5107
+ "value": "medium",
5285
5108
  "type": "string"
5286
5109
  },
5287
5110
  {
@@ -5423,7 +5246,7 @@
5423
5246
  "path": "src/utils/types.ts"
5424
5247
  },
5425
5248
  "src/utils/types.ts::IcSizes": {
5426
- "declaration": "export type IcSizes = \"default\" | \"large\" | \"small\";",
5249
+ "declaration": "export type IcSizes = \"medium\" | \"large\" | \"small\";",
5427
5250
  "docstring": "",
5428
5251
  "path": "src/utils/types.ts"
5429
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.21",
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": "9c268801ebc8da41901291fe13ff157a6211fbbd"
21
+ "gitHead": "1c5671823f89c50f5e16d4f40e1bc15ae2310518"
22
22
  }