@cloudcannon/configuration-types 0.0.52 → 0.0.53

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.
@@ -4652,6 +4652,33 @@
4652
4652
  "min_length_message": {
4653
4653
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
4654
4654
  },
4655
+ "max_words": {
4656
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
4657
+ },
4658
+ "max_words_message": {
4659
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
4660
+ },
4661
+ "min_words": {
4662
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
4663
+ },
4664
+ "min_words_message": {
4665
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
4666
+ },
4667
+ "max_graphemes": {
4668
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
4669
+ },
4670
+ "max_graphemes_message": {
4671
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
4672
+ },
4673
+ "min_graphemes": {
4674
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
4675
+ },
4676
+ "min_graphemes_message": {
4677
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
4678
+ },
4679
+ "locale": {
4680
+ "$ref": "#/definitions/type._inputs.*.options.locale"
4681
+ },
4655
4682
  "pattern": {
4656
4683
  "$ref": "#/definitions/type._inputs.*.options.pattern"
4657
4684
  },
@@ -4828,6 +4855,51 @@
4828
4855
  "type": "string",
4829
4856
  "markdownDescription": "This key defines the message that explains which minimum string length an Input will accept. This key requires you to define `options.min_length`."
4830
4857
  },
4858
+ "type._inputs.*.options.max_words": {
4859
+ "description": "This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.",
4860
+ "type": "number",
4861
+ "markdownDescription": "This key defines the maximum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes."
4862
+ },
4863
+ "type._inputs.*.options.max_words_message": {
4864
+ "description": "This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words.",
4865
+ "type": "string",
4866
+ "markdownDescription": "This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_words."
4867
+ },
4868
+ "type._inputs.*.options.min_words": {
4869
+ "description": "This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.",
4870
+ "type": "number",
4871
+ "markdownDescription": "This key defines the minimum string length, in words, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes."
4872
+ },
4873
+ "type._inputs.*.options.min_words_message": {
4874
+ "description": "This key defines the message that explains which minimum string length an Input will accept. This key requires you to define `options.min_words`.",
4875
+ "type": "string",
4876
+ "markdownDescription": "This key defines the message that explains which minimum string length an Input will accept. This key requires you to define `options.min_words`."
4877
+ },
4878
+ "type._inputs.*.options.max_graphemes": {
4879
+ "description": "This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes.",
4880
+ "type": "number",
4881
+ "markdownDescription": "This key defines the maximum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too long. If the Input already contains a longer value, CloudCannon will require you to remove characters until the Input contains a valid string to save your changes, or discard your unsaved changes."
4882
+ },
4883
+ "type._inputs.*.options.max_graphemes_message": {
4884
+ "description": "This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes.",
4885
+ "type": "string",
4886
+ "markdownDescription": "This key defines the message that explains which maximum string length an Input will accept. This key requires you to define `options.max_graphemes."
4887
+ },
4888
+ "type._inputs.*.options.min_graphemes": {
4889
+ "description": "This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes.",
4890
+ "type": "number",
4891
+ "markdownDescription": "This key defines the minimum string length, in graphemes, that CloudCannon will allow in an Input. When configured, CloudCannon will warn you when an Input value is too short. If the Input already contains a shorter value, CloudCannon will require you to add characters until the Input contains a valid string to save your changes, or discard your unsaved changes."
4892
+ },
4893
+ "type._inputs.*.options.min_graphemes_message": {
4894
+ "description": "This key defines the message that explains which minimum string length an Input will accept. This key requires you to define `options.min_graphemes`.",
4895
+ "type": "string",
4896
+ "markdownDescription": "This key defines the message that explains which minimum string length an Input will accept. This key requires you to define `options.min_graphemes`."
4897
+ },
4898
+ "type._inputs.*.options.locale": {
4899
+ "description": "This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have `max_words`, `min_words`, `max_graphemes`, or `min_graphemes` configured.",
4900
+ "type": "string",
4901
+ "markdownDescription": "This key defines the locale that CloudCannon uses to determine the number of words or graphemes in this Input, if you have `max_words`, `min_words`, `max_graphemes`, or `min_graphemes` configured."
4902
+ },
4831
4903
  "type._inputs.*.options.pattern": {
4832
4904
  "description": "This key defines a regular expression that the Input value must match. When configured, CloudCannon will require you to enter a value that matches the REGEX pattern. If the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved changes.",
4833
4905
  "type": "string",
@@ -5059,6 +5131,33 @@
5059
5131
  "min_length_message": {
5060
5132
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
5061
5133
  },
5134
+ "max_words": {
5135
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
5136
+ },
5137
+ "max_words_message": {
5138
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
5139
+ },
5140
+ "min_words": {
5141
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
5142
+ },
5143
+ "min_words_message": {
5144
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
5145
+ },
5146
+ "max_graphemes": {
5147
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
5148
+ },
5149
+ "max_graphemes_message": {
5150
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
5151
+ },
5152
+ "min_graphemes": {
5153
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
5154
+ },
5155
+ "min_graphemes_message": {
5156
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
5157
+ },
5158
+ "locale": {
5159
+ "$ref": "#/definitions/type._inputs.*.options.locale"
5160
+ },
5062
5161
  "pattern": {
5063
5162
  "$ref": "#/definitions/type._inputs.*.options.pattern"
5064
5163
  },
@@ -5188,6 +5287,33 @@
5188
5287
  "min_length_message": {
5189
5288
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
5190
5289
  },
5290
+ "max_words": {
5291
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
5292
+ },
5293
+ "max_words_message": {
5294
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
5295
+ },
5296
+ "min_words": {
5297
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
5298
+ },
5299
+ "min_words_message": {
5300
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
5301
+ },
5302
+ "max_graphemes": {
5303
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
5304
+ },
5305
+ "max_graphemes_message": {
5306
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
5307
+ },
5308
+ "min_graphemes": {
5309
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
5310
+ },
5311
+ "min_graphemes_message": {
5312
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
5313
+ },
5314
+ "locale": {
5315
+ "$ref": "#/definitions/type._inputs.*.options.locale"
5316
+ },
5191
5317
  "pattern": {
5192
5318
  "$ref": "#/definitions/type._inputs.*.options.pattern"
5193
5319
  },
@@ -5411,6 +5537,33 @@
5411
5537
  "min_length_message": {
5412
5538
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
5413
5539
  },
5540
+ "max_words": {
5541
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
5542
+ },
5543
+ "max_words_message": {
5544
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
5545
+ },
5546
+ "min_words": {
5547
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
5548
+ },
5549
+ "min_words_message": {
5550
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
5551
+ },
5552
+ "max_graphemes": {
5553
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
5554
+ },
5555
+ "max_graphemes_message": {
5556
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
5557
+ },
5558
+ "min_graphemes": {
5559
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
5560
+ },
5561
+ "min_graphemes_message": {
5562
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
5563
+ },
5564
+ "locale": {
5565
+ "$ref": "#/definitions/type._inputs.*.options.locale"
5566
+ },
5414
5567
  "pattern": {
5415
5568
  "$ref": "#/definitions/type._inputs.*.options.pattern"
5416
5569
  },
@@ -5964,6 +6117,33 @@
5964
6117
  "min_length_message": {
5965
6118
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
5966
6119
  },
6120
+ "max_words": {
6121
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
6122
+ },
6123
+ "max_words_message": {
6124
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
6125
+ },
6126
+ "min_words": {
6127
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
6128
+ },
6129
+ "min_words_message": {
6130
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
6131
+ },
6132
+ "max_graphemes": {
6133
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
6134
+ },
6135
+ "max_graphemes_message": {
6136
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
6137
+ },
6138
+ "min_graphemes": {
6139
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
6140
+ },
6141
+ "min_graphemes_message": {
6142
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
6143
+ },
6144
+ "locale": {
6145
+ "$ref": "#/definitions/type._inputs.*.options.locale"
6146
+ },
5967
6147
  "pattern": {
5968
6148
  "$ref": "#/definitions/type._inputs.*.options.pattern"
5969
6149
  },
@@ -5987,10 +6167,16 @@
5987
6167
  ]
5988
6168
  },
5989
6169
  "allow_resize": {
5990
- "description": "Shows or hides the resize handler to vertically resize the input.",
6170
+ "deprecated": true,
6171
+ "description": "**⚠️ DEPRECATED:** This key is deprecated. Use `preview_resize` instead.",
6172
+ "type": "boolean",
6173
+ "markdownDescription": "**⚠️ DEPRECATED:** This key is deprecated. Use `preview_resize` instead."
6174
+ },
6175
+ "prevent_resize": {
6176
+ "description": "Hides the resize handler to vertically resize the input.",
5991
6177
  "default": false,
5992
6178
  "type": "boolean",
5993
- "markdownDescription": "Shows or hides the resize handler to vertically resize the input."
6179
+ "markdownDescription": "Hides the resize handler to vertically resize the input."
5994
6180
  },
5995
6181
  "initial_height": {
5996
6182
  "description": "Defines the initial height of this input in pixels (px).",
@@ -7227,6 +7413,33 @@
7227
7413
  "min_length_message": {
7228
7414
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
7229
7415
  },
7416
+ "max_words": {
7417
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
7418
+ },
7419
+ "max_words_message": {
7420
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
7421
+ },
7422
+ "min_words": {
7423
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
7424
+ },
7425
+ "min_words_message": {
7426
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
7427
+ },
7428
+ "max_graphemes": {
7429
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
7430
+ },
7431
+ "max_graphemes_message": {
7432
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
7433
+ },
7434
+ "min_graphemes": {
7435
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
7436
+ },
7437
+ "min_graphemes_message": {
7438
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
7439
+ },
7440
+ "locale": {
7441
+ "$ref": "#/definitions/type._inputs.*.options.locale"
7442
+ },
7230
7443
  "pattern": {
7231
7444
  "$ref": "#/definitions/type._inputs.*.options.pattern"
7232
7445
  },
@@ -7863,6 +8076,33 @@
7863
8076
  "min_length_message": {
7864
8077
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
7865
8078
  },
8079
+ "max_words": {
8080
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
8081
+ },
8082
+ "max_words_message": {
8083
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
8084
+ },
8085
+ "min_words": {
8086
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
8087
+ },
8088
+ "min_words_message": {
8089
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
8090
+ },
8091
+ "max_graphemes": {
8092
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
8093
+ },
8094
+ "max_graphemes_message": {
8095
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
8096
+ },
8097
+ "min_graphemes": {
8098
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
8099
+ },
8100
+ "min_graphemes_message": {
8101
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
8102
+ },
8103
+ "locale": {
8104
+ "$ref": "#/definitions/type._inputs.*.options.locale"
8105
+ },
7866
8106
  "pattern": {
7867
8107
  "$ref": "#/definitions/type._inputs.*.options.pattern"
7868
8108
  },
@@ -8048,6 +8288,33 @@
8048
8288
  "min_length_message": {
8049
8289
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
8050
8290
  },
8291
+ "max_words": {
8292
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
8293
+ },
8294
+ "max_words_message": {
8295
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
8296
+ },
8297
+ "min_words": {
8298
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
8299
+ },
8300
+ "min_words_message": {
8301
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
8302
+ },
8303
+ "max_graphemes": {
8304
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
8305
+ },
8306
+ "max_graphemes_message": {
8307
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
8308
+ },
8309
+ "min_graphemes": {
8310
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
8311
+ },
8312
+ "min_graphemes_message": {
8313
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
8314
+ },
8315
+ "locale": {
8316
+ "$ref": "#/definitions/type._inputs.*.options.locale"
8317
+ },
8051
8318
  "pattern": {
8052
8319
  "$ref": "#/definitions/type._inputs.*.options.pattern"
8053
8320
  },
@@ -8244,8 +8511,8 @@
8244
8511
  "markdownDescription": "Allows new text values to be created at edit time."
8245
8512
  },
8246
8513
  "type._inputs.*.options.allow_empty": {
8514
+ "deprecated": true,
8247
8515
  "description": "Provides an empty option alongside the options provided by values.",
8248
- "default": true,
8249
8516
  "type": "boolean",
8250
8517
  "markdownDescription": "Provides an empty option alongside the options provided by values."
8251
8518
  },
@@ -8597,6 +8864,33 @@
8597
8864
  "min_length_message": {
8598
8865
  "$ref": "#/definitions/type._inputs.*.options.min_length_message"
8599
8866
  },
8867
+ "max_words": {
8868
+ "$ref": "#/definitions/type._inputs.*.options.max_words"
8869
+ },
8870
+ "max_words_message": {
8871
+ "$ref": "#/definitions/type._inputs.*.options.max_words_message"
8872
+ },
8873
+ "min_words": {
8874
+ "$ref": "#/definitions/type._inputs.*.options.min_words"
8875
+ },
8876
+ "min_words_message": {
8877
+ "$ref": "#/definitions/type._inputs.*.options.min_words_message"
8878
+ },
8879
+ "max_graphemes": {
8880
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes"
8881
+ },
8882
+ "max_graphemes_message": {
8883
+ "$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
8884
+ },
8885
+ "min_graphemes": {
8886
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes"
8887
+ },
8888
+ "min_graphemes_message": {
8889
+ "$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
8890
+ },
8891
+ "locale": {
8892
+ "$ref": "#/definitions/type._inputs.*.options.locale"
8893
+ },
8600
8894
  "pattern": {
8601
8895
  "$ref": "#/definitions/type._inputs.*.options.pattern"
8602
8896
  },
@@ -611,11 +611,11 @@
611
611
  "markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a [Snippet](https://cloudcannon.com/documentation/articles/what-is-a-snippet/), if any are available.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a Snippet."
612
612
  },
613
613
  "type._editables.*.styles": {
614
- "description": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\nSetting this key to `true` will enable a dropdown menu in your WYSIWYG toolbar to apply a style to selected text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) for the CSS file containing styles.",
614
+ "description": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\n## Examples\n\nIn this example, we have enabled a dropdown menu in our WYSIWYG toolbar to apply a style to selected text. The styles are defined in the `/css/styles.css` file.\n\n```yaml\n_editables:\n content:\n styles: /css/styles.css\n```\n\nThis example file defines the styles that CloudCannon can add to your WYSIWYG toolbar.\n\n```css\n/* Can be applied to blocks of content */\np.callout {\n margin: 10px;\n border: 1px solid #f5f5f5;\n background-color: #eee;\n}\n\n/* Can be applied to inline content */\nspan.big-blue-text {\n font-size: 2rem;\n color: blue;\n}\n\n/* Applied to content, excluded from style dropdown */\nh2 {\n font-family: cursive;\n}\n\n/* Applied to content, excluded from style dropdown */\n.align-left { text-align: left; }\n.align-center { text-align: center; }\n.align-right { text-align: right; }\n.align-justify { text-align: justify; }\n```",
615
615
  "type": "string",
616
616
  "documented": true,
617
617
  "title": "styles",
618
- "markdownDescription": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\nSetting this key to `true` will enable a dropdown menu in your WYSIWYG toolbar to apply a style to selected text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) for the CSS file containing styles."
618
+ "markdownDescription": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\n## Examples\n\nIn this example, we have enabled a dropdown menu in our WYSIWYG toolbar to apply a style to selected text. The styles are defined in the `/css/styles.css` file.\n\n```yaml\n_editables:\n content:\n styles: /css/styles.css\n```\n\nThis example file defines the styles that CloudCannon can add to your WYSIWYG toolbar.\n\n```css\n/* Can be applied to blocks of content */\np.callout {\n margin: 10px;\n border: 1px solid #f5f5f5;\n background-color: #eee;\n}\n\n/* Can be applied to inline content */\nspan.big-blue-text {\n font-size: 2rem;\n color: blue;\n}\n\n/* Applied to content, excluded from style dropdown */\nh2 {\n font-family: cursive;\n}\n\n/* Applied to content, excluded from style dropdown */\n.align-left { text-align: left; }\n.align-center { text-align: center; }\n.align-right { text-align: right; }\n.align-justify { text-align: justify; }\n```"
619
619
  },
620
620
  "type._editables.*.table": {
621
621
  "description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a table.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a table. Further table options are available from the table context menu in the rich text editor.",