@cloudcannon/configuration-types 0.0.24 → 0.0.25

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.
@@ -91,6 +91,15 @@
91
91
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
92
92
  "type": "boolean"
93
93
  },
94
+ "disabled": {
95
+ "default": false,
96
+ "description": "Toggles if this input can be edited.",
97
+ "markdownDescription": "Toggles if this input can be edited.",
98
+ "type": [
99
+ "boolean",
100
+ "string"
101
+ ]
102
+ },
94
103
  "documentation": {
95
104
  "$ref": "#/definitions/Documentation",
96
105
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -217,6 +226,15 @@
217
226
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
218
227
  "type": "boolean"
219
228
  },
229
+ "disabled": {
230
+ "default": false,
231
+ "description": "Toggles if this input can be edited.",
232
+ "markdownDescription": "Toggles if this input can be edited.",
233
+ "type": [
234
+ "boolean",
235
+ "string"
236
+ ]
237
+ },
220
238
  "documentation": {
221
239
  "$ref": "#/definitions/Documentation",
222
240
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -582,6 +600,15 @@
582
600
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
583
601
  "type": "boolean"
584
602
  },
603
+ "disabled": {
604
+ "default": false,
605
+ "description": "Toggles if this input can be edited.",
606
+ "markdownDescription": "Toggles if this input can be edited.",
607
+ "type": [
608
+ "boolean",
609
+ "string"
610
+ ]
611
+ },
585
612
  "documentation": {
586
613
  "$ref": "#/definitions/Documentation",
587
614
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -730,6 +757,15 @@
730
757
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
731
758
  "type": "boolean"
732
759
  },
760
+ "disabled": {
761
+ "default": false,
762
+ "description": "Toggles if this input can be edited.",
763
+ "markdownDescription": "Toggles if this input can be edited.",
764
+ "type": [
765
+ "boolean",
766
+ "string"
767
+ ]
768
+ },
733
769
  "documentation": {
734
770
  "$ref": "#/definitions/Documentation",
735
771
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -885,6 +921,15 @@
885
921
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
886
922
  "type": "boolean"
887
923
  },
924
+ "disabled": {
925
+ "default": false,
926
+ "description": "Toggles if this input can be edited.",
927
+ "markdownDescription": "Toggles if this input can be edited.",
928
+ "type": [
929
+ "boolean",
930
+ "string"
931
+ ]
932
+ },
888
933
  "documentation": {
889
934
  "$ref": "#/definitions/Documentation",
890
935
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -1046,6 +1091,15 @@
1046
1091
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
1047
1092
  "type": "boolean"
1048
1093
  },
1094
+ "disabled": {
1095
+ "default": false,
1096
+ "description": "Toggles if this input can be edited.",
1097
+ "markdownDescription": "Toggles if this input can be edited.",
1098
+ "type": [
1099
+ "boolean",
1100
+ "string"
1101
+ ]
1102
+ },
1049
1103
  "documentation": {
1050
1104
  "$ref": "#/definitions/Documentation",
1051
1105
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -1250,6 +1304,15 @@
1250
1304
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
1251
1305
  "type": "boolean"
1252
1306
  },
1307
+ "disabled": {
1308
+ "default": false,
1309
+ "description": "Toggles if this input can be edited.",
1310
+ "markdownDescription": "Toggles if this input can be edited.",
1311
+ "type": [
1312
+ "boolean",
1313
+ "string"
1314
+ ]
1315
+ },
1253
1316
  "documentation": {
1254
1317
  "$ref": "#/definitions/Documentation",
1255
1318
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -1503,6 +1566,15 @@
1503
1566
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
1504
1567
  "type": "boolean"
1505
1568
  },
1569
+ "disabled": {
1570
+ "default": false,
1571
+ "description": "Toggles if this input can be edited.",
1572
+ "markdownDescription": "Toggles if this input can be edited.",
1573
+ "type": [
1574
+ "boolean",
1575
+ "string"
1576
+ ]
1577
+ },
1506
1578
  "documentation": {
1507
1579
  "$ref": "#/definitions/Documentation",
1508
1580
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -3918,6 +3990,15 @@
3918
3990
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
3919
3991
  "type": "boolean"
3920
3992
  },
3993
+ "disabled": {
3994
+ "default": false,
3995
+ "description": "Toggles if this input can be edited.",
3996
+ "markdownDescription": "Toggles if this input can be edited.",
3997
+ "type": [
3998
+ "boolean",
3999
+ "string"
4000
+ ]
4001
+ },
3921
4002
  "documentation": {
3922
4003
  "$ref": "#/definitions/Documentation",
3923
4004
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -5086,6 +5167,15 @@
5086
5167
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
5087
5168
  "type": "boolean"
5088
5169
  },
5170
+ "disabled": {
5171
+ "default": false,
5172
+ "description": "Toggles if this input can be edited.",
5173
+ "markdownDescription": "Toggles if this input can be edited.",
5174
+ "type": [
5175
+ "boolean",
5176
+ "string"
5177
+ ]
5178
+ },
5089
5179
  "documentation": {
5090
5180
  "$ref": "#/definitions/Documentation",
5091
5181
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -5241,6 +5331,15 @@
5241
5331
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
5242
5332
  "type": "boolean"
5243
5333
  },
5334
+ "disabled": {
5335
+ "default": false,
5336
+ "description": "Toggles if this input can be edited.",
5337
+ "markdownDescription": "Toggles if this input can be edited.",
5338
+ "type": [
5339
+ "boolean",
5340
+ "string"
5341
+ ]
5342
+ },
5244
5343
  "documentation": {
5245
5344
  "$ref": "#/definitions/Documentation",
5246
5345
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -5402,6 +5501,15 @@
5402
5501
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
5403
5502
  "type": "boolean"
5404
5503
  },
5504
+ "disabled": {
5505
+ "default": false,
5506
+ "description": "Toggles if this input can be edited.",
5507
+ "markdownDescription": "Toggles if this input can be edited.",
5508
+ "type": [
5509
+ "boolean",
5510
+ "string"
5511
+ ]
5512
+ },
5405
5513
  "documentation": {
5406
5514
  "$ref": "#/definitions/Documentation",
5407
5515
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -5520,6 +5628,15 @@
5520
5628
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
5521
5629
  "type": "boolean"
5522
5630
  },
5631
+ "disabled": {
5632
+ "default": false,
5633
+ "description": "Toggles if this input can be edited.",
5634
+ "markdownDescription": "Toggles if this input can be edited.",
5635
+ "type": [
5636
+ "boolean",
5637
+ "string"
5638
+ ]
5639
+ },
5523
5640
  "documentation": {
5524
5641
  "$ref": "#/definitions/Documentation",
5525
5642
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -5763,10 +5880,15 @@
5763
5880
  "description": "Controls the icon shown per item. Must result in a Material Icon name.",
5764
5881
  "markdownDescription": "Controls the icon shown per item. Must result in a Material Icon name."
5765
5882
  },
5883
+ "icon_background_color": {
5884
+ "$ref": "#/definitions/PreviewEntry",
5885
+ "description": "Controls the background color of the icon.",
5886
+ "markdownDescription": "Controls the background color of the icon."
5887
+ },
5766
5888
  "icon_color": {
5889
+ "$ref": "#/definitions/PreviewEntry",
5767
5890
  "description": "Controls the color of the icon.",
5768
- "markdownDescription": "Controls the color of the icon.",
5769
- "type": "string"
5891
+ "markdownDescription": "Controls the color of the icon."
5770
5892
  },
5771
5893
  "image": {
5772
5894
  "$ref": "#/definitions/PreviewEntry",
@@ -5826,6 +5948,11 @@
5826
5948
  "PreviewGallery": {
5827
5949
  "additionalProperties": false,
5828
5950
  "properties": {
5951
+ "background_color": {
5952
+ "$ref": "#/definitions/PreviewEntry",
5953
+ "description": "Controls the background color gallery area.",
5954
+ "markdownDescription": "Controls the background color gallery area."
5955
+ },
5829
5956
  "fit": {
5830
5957
  "default": "padded",
5831
5958
  "description": "Controls how the gallery image is positioned within the gallery.",
@@ -5843,10 +5970,15 @@
5843
5970
  "description": "Controls the icon shown per item. Must result in a Material Icon name.",
5844
5971
  "markdownDescription": "Controls the icon shown per item. Must result in a Material Icon name."
5845
5972
  },
5973
+ "icon_background_color": {
5974
+ "$ref": "#/definitions/PreviewEntry",
5975
+ "description": "Controls the background color of the icon.",
5976
+ "markdownDescription": "Controls the background color of the icon."
5977
+ },
5846
5978
  "icon_color": {
5979
+ "$ref": "#/definitions/PreviewEntry",
5847
5980
  "description": "Controls the color of the icon.",
5848
- "markdownDescription": "Controls the color of the icon.",
5849
- "type": "string"
5981
+ "markdownDescription": "Controls the color of the icon."
5850
5982
  },
5851
5983
  "image": {
5852
5984
  "$ref": "#/definitions/PreviewEntry",
@@ -5883,10 +6015,15 @@
5883
6015
  "description": "Controls the icon shown per item. Must result in a Material Icon name.",
5884
6016
  "markdownDescription": "Controls the icon shown per item. Must result in a Material Icon name."
5885
6017
  },
6018
+ "icon_background_color": {
6019
+ "$ref": "#/definitions/PreviewEntry",
6020
+ "description": "Controls the background color of the icon.",
6021
+ "markdownDescription": "Controls the background color of the icon."
6022
+ },
5886
6023
  "icon_color": {
6024
+ "$ref": "#/definitions/PreviewEntry",
5887
6025
  "description": "Controls the color of the icon.",
5888
- "markdownDescription": "Controls the color of the icon.",
5889
- "type": "string"
6026
+ "markdownDescription": "Controls the color of the icon."
5890
6027
  },
5891
6028
  "image": {
5892
6029
  "$ref": "#/definitions/PreviewEntry",
@@ -5962,6 +6099,15 @@
5962
6099
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
5963
6100
  "type": "boolean"
5964
6101
  },
6102
+ "disabled": {
6103
+ "default": false,
6104
+ "description": "Toggles if this input can be edited.",
6105
+ "markdownDescription": "Toggles if this input can be edited.",
6106
+ "type": [
6107
+ "boolean",
6108
+ "string"
6109
+ ]
6110
+ },
5965
6111
  "documentation": {
5966
6112
  "$ref": "#/definitions/Documentation",
5967
6113
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -6301,6 +6447,15 @@
6301
6447
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
6302
6448
  "type": "boolean"
6303
6449
  },
6450
+ "disabled": {
6451
+ "default": false,
6452
+ "description": "Toggles if this input can be edited.",
6453
+ "markdownDescription": "Toggles if this input can be edited.",
6454
+ "type": [
6455
+ "boolean",
6456
+ "string"
6457
+ ]
6458
+ },
6304
6459
  "documentation": {
6305
6460
  "$ref": "#/definitions/Documentation",
6306
6461
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -6789,6 +6944,15 @@
6789
6944
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
6790
6945
  "type": "boolean"
6791
6946
  },
6947
+ "disabled": {
6948
+ "default": false,
6949
+ "description": "Toggles if this input can be edited.",
6950
+ "markdownDescription": "Toggles if this input can be edited.",
6951
+ "type": [
6952
+ "boolean",
6953
+ "string"
6954
+ ]
6955
+ },
6792
6956
  "documentation": {
6793
6957
  "$ref": "#/definitions/Documentation",
6794
6958
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -8154,6 +8318,15 @@
8154
8318
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
8155
8319
  "type": "boolean"
8156
8320
  },
8321
+ "disabled": {
8322
+ "default": false,
8323
+ "description": "Toggles if this input can be edited.",
8324
+ "markdownDescription": "Toggles if this input can be edited.",
8325
+ "type": [
8326
+ "boolean",
8327
+ "string"
8328
+ ]
8329
+ },
8157
8330
  "documentation": {
8158
8331
  "$ref": "#/definitions/Documentation",
8159
8332
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -8276,6 +8449,15 @@
8276
8449
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
8277
8450
  "type": "boolean"
8278
8451
  },
8452
+ "disabled": {
8453
+ "default": false,
8454
+ "description": "Toggles if this input can be edited.",
8455
+ "markdownDescription": "Toggles if this input can be edited.",
8456
+ "type": [
8457
+ "boolean",
8458
+ "string"
8459
+ ]
8460
+ },
8279
8461
  "documentation": {
8280
8462
  "$ref": "#/definitions/Documentation",
8281
8463
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -8438,6 +8620,15 @@
8438
8620
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
8439
8621
  "type": "boolean"
8440
8622
  },
8623
+ "disabled": {
8624
+ "default": false,
8625
+ "description": "Toggles if this input can be edited.",
8626
+ "markdownDescription": "Toggles if this input can be edited.",
8627
+ "type": [
8628
+ "boolean",
8629
+ "string"
8630
+ ]
8631
+ },
8441
8632
  "documentation": {
8442
8633
  "$ref": "#/definitions/Documentation",
8443
8634
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -9126,6 +9317,15 @@
9126
9317
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
9127
9318
  "type": "boolean"
9128
9319
  },
9320
+ "disabled": {
9321
+ "default": false,
9322
+ "description": "Toggles if this input can be edited.",
9323
+ "markdownDescription": "Toggles if this input can be edited.",
9324
+ "type": [
9325
+ "boolean",
9326
+ "string"
9327
+ ]
9328
+ },
9129
9329
  "documentation": {
9130
9330
  "$ref": "#/definitions/Documentation",
9131
9331
  "description": "Provides a custom link for documentation for editors shown above input.",
@@ -9204,6 +9404,15 @@
9204
9404
  "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
9205
9405
  "type": "boolean"
9206
9406
  },
9407
+ "disabled": {
9408
+ "default": false,
9409
+ "description": "Toggles if this input can be edited.",
9410
+ "markdownDescription": "Toggles if this input can be edited.",
9411
+ "type": [
9412
+ "boolean",
9413
+ "string"
9414
+ ]
9415
+ },
9207
9416
  "documentation": {
9208
9417
  "$ref": "#/definitions/Documentation",
9209
9418
  "description": "Provides a custom link for documentation for editors shown above input.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cloudcannon/configuration-types",
3
- "version": "0.0.24",
3
+ "version": "0.0.25",
4
4
  "type": "module",
5
5
  "description": "Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.",
6
6
  "author": "CloudCannon <support@cloudcannon.com>",
package/src/inputs.d.ts CHANGED
@@ -113,6 +113,12 @@ export interface BaseInput {
113
113
  * @default false
114
114
  */
115
115
  hidden?: boolean | string;
116
+ /**
117
+ * Toggles if this input can be edited.
118
+ *
119
+ * @default false
120
+ */
121
+ disabled?: boolean | string;
116
122
  /**
117
123
  * Controls if and how the value of this input is instantiated when created. This occurs when
118
124
  * creating files, or adding array items containing the configured input.
package/src/preview.d.ts CHANGED
@@ -49,7 +49,11 @@ export interface WithIconColorPreview {
49
49
  /**
50
50
  * Controls the color of the icon.
51
51
  */
52
- icon_color?: string;
52
+ icon_color?: PreviewEntry;
53
+ /**
54
+ * Controls the background color of the icon.
55
+ */
56
+ icon_background_color?: PreviewEntry;
53
57
  }
54
58
 
55
59
  export interface WithPreview {
@@ -77,6 +81,10 @@ export interface PreviewGallery
77
81
  * @default padded
78
82
  */
79
83
  fit?: 'padded' | 'cover' | 'contain' | 'cover-top';
84
+ /**
85
+ * Controls the background color gallery area.
86
+ */
87
+ background_color?: PreviewEntry;
80
88
  }
81
89
 
82
90
  export interface PreviewMetadata