@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.
- package/dist/cloudcannon-collections.schema.json +324 -10
- package/dist/cloudcannon-config.documentation.schema.json +295 -2
- package/dist/cloudcannon-config.latest.schema.json +324 -10
- package/dist/cloudcannon-config.legacy-eleventy.schema.json +297 -3
- package/dist/cloudcannon-config.legacy-hugo.schema.json +297 -3
- package/dist/cloudcannon-config.legacy-jekyll.schema.json +297 -3
- package/dist/cloudcannon-config.legacy-reader.schema.json +297 -3
- package/dist/cloudcannon-editables.schema.json +2 -2
- package/dist/cloudcannon-inputs.schema.json +324 -10
- package/dist/cloudcannon-schemas.schema.json +324 -10
- package/dist/cloudcannon-snippets.schema.json +324 -10
- package/dist/cloudcannon-structure-value.schema.json +324 -10
- package/dist/cloudcannon-structures.schema.json +324 -10
- package/dist/documentation.json +1297 -12
- package/package.json +1 -1
- package/src/inputs.ts +53 -3
|
@@ -75,13 +75,13 @@
|
|
|
75
75
|
"type": "string",
|
|
76
76
|
"documented": true,
|
|
77
77
|
"title": "values_from_glob[*]",
|
|
78
|
-
"description": "This key represents an individual glob pattern string in the `values_from_glob` array.\n\nThe value is a string that specifies a file path pattern relative to the root of your repository. The path must end in the file extension `.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\n## Examples\n\nIn this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure-value.yml` in the `/.cloudcannon/structures/` folder.\n\n```yaml\n_inputs:\n staff:\n type: array\n options:\n structures:\n
|
|
79
|
-
"markdownDescription": "This key represents an individual glob pattern string in the `values_from_glob` array.\n\nThe value is a string that specifies a file path pattern relative to the root of your repository. The path must end in the file extension `.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\n## Examples\n\nIn this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure-value.yml` in the `/.cloudcannon/structures/` folder.\n\n```yaml\n_inputs:\n staff:\n type: array\n options:\n structures:\n
|
|
78
|
+
"description": "This key represents an individual glob pattern string in the `values_from_glob` array.\n\nThe value is a string that specifies a file path pattern relative to the root of your repository. The path must end in the file extension `.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\n## Examples\n\nIn this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure-value.yml` in the `/.cloudcannon/structures/` folder.\n\n```yaml\n_inputs:\n staff:\n type: array\n options:\n structures:\n values_from_glob:\n - /.cloudcannon/structures/boardMember.cloudcannon.structure-value.yml\n values:\n - label: Employee\n value:\n name:\n title:\n profile_picture:\n - label: Manager\n value:\n name:\n title:\n profile_picture:\n url:\n```",
|
|
79
|
+
"markdownDescription": "This key represents an individual glob pattern string in the `values_from_glob` array.\n\nThe value is a string that specifies a file path pattern relative to the root of your repository. The path must end in the file extension `.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\n## Examples\n\nIn this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure-value.yml` in the `/.cloudcannon/structures/` folder.\n\n```yaml\n_inputs:\n staff:\n type: array\n options:\n structures:\n values_from_glob:\n - /.cloudcannon/structures/boardMember.cloudcannon.structure-value.yml\n values:\n - label: Employee\n value:\n name:\n title:\n profile_picture:\n - label: Manager\n value:\n name:\n title:\n profile_picture:\n url:\n```"
|
|
80
80
|
},
|
|
81
81
|
"documented": true,
|
|
82
82
|
"title": "values_from_glob",
|
|
83
|
-
"description": "This key defines globs that filter which files CloudCannon should use for *Structure* value configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\nYou can use this key anywhere you would use the `_structures.*.values` key.\n\nPlease see our documentation on [structures_from_glob](https://cloudcannon.com/documentation/developer-reference/configuration-file/types/_structures_from_glob/) for defining a\n*Structure* in a split *Configuration File*.\n\nThis key has no default.\n\n## Examples\n\nIn this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure_value.yml` in the `/.cloudcannon/structures/` folder.\n\n```yaml\n_inputs:\n staff:\n type: array\n options:\n structures:\n
|
|
84
|
-
"markdownDescription": "This key defines globs that filter which files CloudCannon should use for *Structure* value configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\nYou can use this key anywhere you would use the `_structures.*.values` key.\n\nPlease see our documentation on [structures_from_glob](https://cloudcannon.com/documentation/developer-reference/configuration-file/types/_structures_from_glob/) for defining a\n*Structure* in a split *Configuration File*.\n\nThis key has no default.\n\n## Examples\n\nIn this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure_value.yml` in the `/.cloudcannon/structures/` folder.\n\n```yaml\n_inputs:\n staff:\n type: array\n options:\n structures:\n
|
|
83
|
+
"description": "This key defines globs that filter which files CloudCannon should use for *Structure* value configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\nYou can use this key anywhere you would use the `_structures.*.values` key.\n\nPlease see our documentation on [structures_from_glob](https://cloudcannon.com/documentation/developer-reference/configuration-file/types/_structures_from_glob/) for defining a\n*Structure* in a split *Configuration File*.\n\nThis key has no default.\n\n## Examples\n\nIn this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure_value.yml` in the `/.cloudcannon/structures/` folder.\n\n```yaml\n_inputs:\n staff:\n type: array\n options:\n structures:\n values_from_glob:\n - /.cloudcannon/structures/boardMember.cloudcannon.structure-value.yml\n values:\n - label: Employee\n value:\n name:\n title:\n profile_picture:\n - label: Manager\n value:\n name:\n title:\n profile_picture:\n url:\n```\n\n```yaml\nlabel: Board\nvalue:\n name:\n title:\n profile_picture:\n url:\n description:\n```",
|
|
84
|
+
"markdownDescription": "This key defines globs that filter which files CloudCannon should use for *Structure* value configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\nYou can use this key anywhere you would use the `_structures.*.values` key.\n\nPlease see our documentation on [structures_from_glob](https://cloudcannon.com/documentation/developer-reference/configuration-file/types/_structures_from_glob/) for defining a\n*Structure* in a split *Configuration File*.\n\nThis key has no default.\n\n## Examples\n\nIn this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure_value.yml` in the `/.cloudcannon/structures/` folder.\n\n```yaml\n_inputs:\n staff:\n type: array\n options:\n structures:\n values_from_glob:\n - /.cloudcannon/structures/boardMember.cloudcannon.structure-value.yml\n values:\n - label: Employee\n value:\n name:\n title:\n profile_picture:\n - label: Manager\n value:\n name:\n title:\n profile_picture:\n url:\n```\n\n```yaml\nlabel: Board\nvalue:\n name:\n title:\n profile_picture:\n url:\n description:\n```"
|
|
85
85
|
},
|
|
86
86
|
"id_key": {
|
|
87
87
|
"description": "This key defines which key within `values[*].value` CloudCannon should use to identify the Structure option.\n\nIf CloudCannon cannot find this key in a Structure value, it will compare all other key names in the Structure value to find the correct one.\n\nBy default, this key is `_type`.\n\n## Examples\n\nIn this example, we have change the `id_key` from the default `_type` to `component` to match our existing configuration in the `content_blocks` Array input.\n\n```yaml\n_inputs:\n content_blocks___1___:\n type: array\n options:\n structures: _structures.page_components\n_structures:\n page_components:\n id_key___2___: component\n values:\n - label: Hero Component\n value:\n component___3___: hero\n title:\n description:\n image_path:\n link:\n text:\n url:\n - label: Feature Component\n value:\n component: feature\n image_path:\n title:\n description:\n button:\n link:\n text:\n reversed_layout: false\n - label: Video Component\n value:\n component: video\n image_path:\n videoUrl:\n```",
|
|
@@ -887,6 +887,33 @@
|
|
|
887
887
|
"min_length_message": {
|
|
888
888
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
889
889
|
},
|
|
890
|
+
"max_words": {
|
|
891
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
892
|
+
},
|
|
893
|
+
"max_words_message": {
|
|
894
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
895
|
+
},
|
|
896
|
+
"min_words": {
|
|
897
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
898
|
+
},
|
|
899
|
+
"min_words_message": {
|
|
900
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
901
|
+
},
|
|
902
|
+
"max_graphemes": {
|
|
903
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
904
|
+
},
|
|
905
|
+
"max_graphemes_message": {
|
|
906
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
907
|
+
},
|
|
908
|
+
"min_graphemes": {
|
|
909
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
910
|
+
},
|
|
911
|
+
"min_graphemes_message": {
|
|
912
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
913
|
+
},
|
|
914
|
+
"locale": {
|
|
915
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
916
|
+
},
|
|
890
917
|
"pattern": {
|
|
891
918
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
892
919
|
},
|
|
@@ -4755,6 +4782,69 @@
|
|
|
4755
4782
|
"title": "min_length_message",
|
|
4756
4783
|
"markdownDescription": "This key defines a custom error message that explains why a value has failed the validation criteria from `options.min_length`.\n\nThis key requires you to define `options.min_length`.\n\nThis key has no default.\n\nThis key is available for Code, Color, File, Select, Text, Rich Text, and URL Inputs.\n\n## Examples\n\nIn this example, we prompt our team to enter a valid number of characters using a custom message.\n\n```yaml\n_inputs:\n seo_description:\n type: markdown\n comment: Enter a brief description of this blog.\n options:\n max_length: 125\n max_length_message: You are only allowed 125 characters.\n min_length: 25\n min_length_message: Please write more than 25 characters.\n```"
|
|
4757
4784
|
},
|
|
4785
|
+
"type._inputs.*.options.max_words": {
|
|
4786
|
+
"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.",
|
|
4787
|
+
"type": "number",
|
|
4788
|
+
"documented": true,
|
|
4789
|
+
"title": "max_words",
|
|
4790
|
+
"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."
|
|
4791
|
+
},
|
|
4792
|
+
"type._inputs.*.options.max_words_message": {
|
|
4793
|
+
"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.",
|
|
4794
|
+
"type": "string",
|
|
4795
|
+
"documented": true,
|
|
4796
|
+
"title": "max_words_message",
|
|
4797
|
+
"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."
|
|
4798
|
+
},
|
|
4799
|
+
"type._inputs.*.options.min_words": {
|
|
4800
|
+
"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.",
|
|
4801
|
+
"type": "number",
|
|
4802
|
+
"documented": true,
|
|
4803
|
+
"title": "min_words",
|
|
4804
|
+
"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."
|
|
4805
|
+
},
|
|
4806
|
+
"type._inputs.*.options.min_words_message": {
|
|
4807
|
+
"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`.",
|
|
4808
|
+
"type": "string",
|
|
4809
|
+
"documented": true,
|
|
4810
|
+
"title": "min_words_message",
|
|
4811
|
+
"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`."
|
|
4812
|
+
},
|
|
4813
|
+
"type._inputs.*.options.max_graphemes": {
|
|
4814
|
+
"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.",
|
|
4815
|
+
"type": "number",
|
|
4816
|
+
"documented": true,
|
|
4817
|
+
"title": "max_graphemes",
|
|
4818
|
+
"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."
|
|
4819
|
+
},
|
|
4820
|
+
"type._inputs.*.options.max_graphemes_message": {
|
|
4821
|
+
"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.",
|
|
4822
|
+
"type": "string",
|
|
4823
|
+
"documented": true,
|
|
4824
|
+
"title": "max_graphemes_message",
|
|
4825
|
+
"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."
|
|
4826
|
+
},
|
|
4827
|
+
"type._inputs.*.options.min_graphemes": {
|
|
4828
|
+
"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.",
|
|
4829
|
+
"type": "number",
|
|
4830
|
+
"documented": true,
|
|
4831
|
+
"title": "min_graphemes",
|
|
4832
|
+
"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."
|
|
4833
|
+
},
|
|
4834
|
+
"type._inputs.*.options.min_graphemes_message": {
|
|
4835
|
+
"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`.",
|
|
4836
|
+
"type": "string",
|
|
4837
|
+
"documented": true,
|
|
4838
|
+
"title": "min_graphemes_message",
|
|
4839
|
+
"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`."
|
|
4840
|
+
},
|
|
4841
|
+
"type._inputs.*.options.locale": {
|
|
4842
|
+
"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.",
|
|
4843
|
+
"type": "string",
|
|
4844
|
+
"documented": true,
|
|
4845
|
+
"title": "locale",
|
|
4846
|
+
"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."
|
|
4847
|
+
},
|
|
4758
4848
|
"type._inputs.*.options.pattern": {
|
|
4759
4849
|
"description": "This key defines a [regular expression](https://re2js.leopard.in.ua/) that the Input value must match.\n\nWhen configured, CloudCannon will require you to enter a value that matches the REGEX pattern.\n\nIf the Input already contains an invalid value, CloudCannon will require you to enter a valid string to save your changes, or discard your unsaved\nchanges.\n\nValue must be a valid REGEX string.\n\nIf your REGEX string includes a `\\` character and CloudCannon Configuration File is a `.yml` file, use single quotes `'` around the string to avoid a\nbuild error.\n\nThis key has no default.\n\nThis key is available for Code, Color, File, Select, Text, Rich Text, and URL Inputs.\n\nTo use this key in a Select Input, `allow_create` must be set to `true`.\n\n## Examples\n\nIn this example, we want our team to add an email address to the `contact_email` Input using the correct email format.\n\n```yaml\n_inputs:\n contact_email:\n type: email\n options:\n pattern: '[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}'\n pattern_message: 'Please use the format ___@___.__'\n```",
|
|
4760
4850
|
"type": "string",
|
|
@@ -4924,6 +5014,33 @@
|
|
|
4924
5014
|
"min_length_message": {
|
|
4925
5015
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
4926
5016
|
},
|
|
5017
|
+
"max_words": {
|
|
5018
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
5019
|
+
},
|
|
5020
|
+
"max_words_message": {
|
|
5021
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
5022
|
+
},
|
|
5023
|
+
"min_words": {
|
|
5024
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
5025
|
+
},
|
|
5026
|
+
"min_words_message": {
|
|
5027
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
5028
|
+
},
|
|
5029
|
+
"max_graphemes": {
|
|
5030
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
5031
|
+
},
|
|
5032
|
+
"max_graphemes_message": {
|
|
5033
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
5034
|
+
},
|
|
5035
|
+
"min_graphemes": {
|
|
5036
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
5037
|
+
},
|
|
5038
|
+
"min_graphemes_message": {
|
|
5039
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
5040
|
+
},
|
|
5041
|
+
"locale": {
|
|
5042
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
5043
|
+
},
|
|
4927
5044
|
"pattern": {
|
|
4928
5045
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
4929
5046
|
},
|
|
@@ -5083,6 +5200,33 @@
|
|
|
5083
5200
|
"min_length_message": {
|
|
5084
5201
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
5085
5202
|
},
|
|
5203
|
+
"max_words": {
|
|
5204
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
5205
|
+
},
|
|
5206
|
+
"max_words_message": {
|
|
5207
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
5208
|
+
},
|
|
5209
|
+
"min_words": {
|
|
5210
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
5211
|
+
},
|
|
5212
|
+
"min_words_message": {
|
|
5213
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
5214
|
+
},
|
|
5215
|
+
"max_graphemes": {
|
|
5216
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
5217
|
+
},
|
|
5218
|
+
"max_graphemes_message": {
|
|
5219
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
5220
|
+
},
|
|
5221
|
+
"min_graphemes": {
|
|
5222
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
5223
|
+
},
|
|
5224
|
+
"min_graphemes_message": {
|
|
5225
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
5226
|
+
},
|
|
5227
|
+
"locale": {
|
|
5228
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
5229
|
+
},
|
|
5086
5230
|
"pattern": {
|
|
5087
5231
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
5088
5232
|
},
|
|
@@ -5325,6 +5469,33 @@
|
|
|
5325
5469
|
"min_length_message": {
|
|
5326
5470
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
5327
5471
|
},
|
|
5472
|
+
"max_words": {
|
|
5473
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
5474
|
+
},
|
|
5475
|
+
"max_words_message": {
|
|
5476
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
5477
|
+
},
|
|
5478
|
+
"min_words": {
|
|
5479
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
5480
|
+
},
|
|
5481
|
+
"min_words_message": {
|
|
5482
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
5483
|
+
},
|
|
5484
|
+
"max_graphemes": {
|
|
5485
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
5486
|
+
},
|
|
5487
|
+
"max_graphemes_message": {
|
|
5488
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
5489
|
+
},
|
|
5490
|
+
"min_graphemes": {
|
|
5491
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
5492
|
+
},
|
|
5493
|
+
"min_graphemes_message": {
|
|
5494
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
5495
|
+
},
|
|
5496
|
+
"locale": {
|
|
5497
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
5498
|
+
},
|
|
5328
5499
|
"pattern": {
|
|
5329
5500
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
5330
5501
|
},
|
|
@@ -5948,6 +6119,33 @@
|
|
|
5948
6119
|
"min_length_message": {
|
|
5949
6120
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
5950
6121
|
},
|
|
6122
|
+
"max_words": {
|
|
6123
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
6124
|
+
},
|
|
6125
|
+
"max_words_message": {
|
|
6126
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
6127
|
+
},
|
|
6128
|
+
"min_words": {
|
|
6129
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
6130
|
+
},
|
|
6131
|
+
"min_words_message": {
|
|
6132
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
6133
|
+
},
|
|
6134
|
+
"max_graphemes": {
|
|
6135
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
6136
|
+
},
|
|
6137
|
+
"max_graphemes_message": {
|
|
6138
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
6139
|
+
},
|
|
6140
|
+
"min_graphemes": {
|
|
6141
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
6142
|
+
},
|
|
6143
|
+
"min_graphemes_message": {
|
|
6144
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
6145
|
+
},
|
|
6146
|
+
"locale": {
|
|
6147
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
6148
|
+
},
|
|
5951
6149
|
"pattern": {
|
|
5952
6150
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
5953
6151
|
},
|
|
@@ -5973,12 +6171,20 @@
|
|
|
5973
6171
|
"title": "empty_type"
|
|
5974
6172
|
},
|
|
5975
6173
|
"allow_resize": {
|
|
5976
|
-
"
|
|
5977
|
-
"
|
|
6174
|
+
"deprecated": true,
|
|
6175
|
+
"description": "**⚠️ DEPRECATED:** This key is deprecated. Use `preview_resize` instead.\nThis key toggles whether CloudCannon will show the resize handler to vertically resize the input.\n\nSetting this key to `false` will hide the resize handler.\n\nBy default, this key is `true` (i.e., the resize handler is shown).",
|
|
5978
6176
|
"type": "boolean",
|
|
5979
6177
|
"documented": true,
|
|
5980
6178
|
"title": "allow_resize",
|
|
5981
|
-
"markdownDescription": "This key toggles whether CloudCannon will show the resize handler to vertically resize the input.\n\nSetting this key to `false` will hide the resize handler.\n\nBy default, this key is `true` (i.e., the resize handler is shown)."
|
|
6179
|
+
"markdownDescription": "**⚠️ DEPRECATED:** This key is deprecated. Use `preview_resize` instead.\nThis key toggles whether CloudCannon will show the resize handler to vertically resize the input.\n\nSetting this key to `false` will hide the resize handler.\n\nBy default, this key is `true` (i.e., the resize handler is shown)."
|
|
6180
|
+
},
|
|
6181
|
+
"prevent_resize": {
|
|
6182
|
+
"description": "Shows or hides the resize handler to vertically resize the input.",
|
|
6183
|
+
"default": false,
|
|
6184
|
+
"type": "boolean",
|
|
6185
|
+
"documented": true,
|
|
6186
|
+
"title": "prevent_resize",
|
|
6187
|
+
"markdownDescription": "Shows or hides the resize handler to vertically resize the input."
|
|
5982
6188
|
},
|
|
5983
6189
|
"initial_height": {
|
|
5984
6190
|
"description": "This key defines the initial height of this input in pixels (px).",
|
|
@@ -6430,11 +6636,11 @@
|
|
|
6430
6636
|
"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."
|
|
6431
6637
|
},
|
|
6432
6638
|
"type._editables.*.styles": {
|
|
6433
|
-
"description": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\
|
|
6639
|
+
"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```",
|
|
6434
6640
|
"type": "string",
|
|
6435
6641
|
"documented": true,
|
|
6436
6642
|
"title": "styles",
|
|
6437
|
-
"markdownDescription": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\
|
|
6643
|
+
"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```"
|
|
6438
6644
|
},
|
|
6439
6645
|
"type._editables.*.table": {
|
|
6440
6646
|
"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.",
|
|
@@ -7413,6 +7619,33 @@
|
|
|
7413
7619
|
"min_length_message": {
|
|
7414
7620
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
7415
7621
|
},
|
|
7622
|
+
"max_words": {
|
|
7623
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
7624
|
+
},
|
|
7625
|
+
"max_words_message": {
|
|
7626
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
7627
|
+
},
|
|
7628
|
+
"min_words": {
|
|
7629
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
7630
|
+
},
|
|
7631
|
+
"min_words_message": {
|
|
7632
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
7633
|
+
},
|
|
7634
|
+
"max_graphemes": {
|
|
7635
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
7636
|
+
},
|
|
7637
|
+
"max_graphemes_message": {
|
|
7638
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
7639
|
+
},
|
|
7640
|
+
"min_graphemes": {
|
|
7641
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
7642
|
+
},
|
|
7643
|
+
"min_graphemes_message": {
|
|
7644
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
7645
|
+
},
|
|
7646
|
+
"locale": {
|
|
7647
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
7648
|
+
},
|
|
7416
7649
|
"pattern": {
|
|
7417
7650
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
7418
7651
|
},
|
|
@@ -8080,6 +8313,33 @@
|
|
|
8080
8313
|
"min_length_message": {
|
|
8081
8314
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
8082
8315
|
},
|
|
8316
|
+
"max_words": {
|
|
8317
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
8318
|
+
},
|
|
8319
|
+
"max_words_message": {
|
|
8320
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
8321
|
+
},
|
|
8322
|
+
"min_words": {
|
|
8323
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
8324
|
+
},
|
|
8325
|
+
"min_words_message": {
|
|
8326
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
8327
|
+
},
|
|
8328
|
+
"max_graphemes": {
|
|
8329
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
8330
|
+
},
|
|
8331
|
+
"max_graphemes_message": {
|
|
8332
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
8333
|
+
},
|
|
8334
|
+
"min_graphemes": {
|
|
8335
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
8336
|
+
},
|
|
8337
|
+
"min_graphemes_message": {
|
|
8338
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
8339
|
+
},
|
|
8340
|
+
"locale": {
|
|
8341
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
8342
|
+
},
|
|
8083
8343
|
"pattern": {
|
|
8084
8344
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
8085
8345
|
},
|
|
@@ -8289,6 +8549,33 @@
|
|
|
8289
8549
|
"min_length_message": {
|
|
8290
8550
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
8291
8551
|
},
|
|
8552
|
+
"max_words": {
|
|
8553
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
8554
|
+
},
|
|
8555
|
+
"max_words_message": {
|
|
8556
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
8557
|
+
},
|
|
8558
|
+
"min_words": {
|
|
8559
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
8560
|
+
},
|
|
8561
|
+
"min_words_message": {
|
|
8562
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
8563
|
+
},
|
|
8564
|
+
"max_graphemes": {
|
|
8565
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
8566
|
+
},
|
|
8567
|
+
"max_graphemes_message": {
|
|
8568
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
8569
|
+
},
|
|
8570
|
+
"min_graphemes": {
|
|
8571
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
8572
|
+
},
|
|
8573
|
+
"min_graphemes_message": {
|
|
8574
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
8575
|
+
},
|
|
8576
|
+
"locale": {
|
|
8577
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
8578
|
+
},
|
|
8292
8579
|
"pattern": {
|
|
8293
8580
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
8294
8581
|
},
|
|
@@ -8330,8 +8617,8 @@
|
|
|
8330
8617
|
"markdownDescription": "This key toggles whether CloudCannon will allow new text values to be created at edit time.\n\nSetting this key to `true` will allow new text values to be created at edit time.\n\n## Examples\n\nIn this example, CloudCannon will allow users to add new values to a *Select Input*.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n allow_create: true\n```"
|
|
8331
8618
|
},
|
|
8332
8619
|
"type._inputs.*.options.allow_empty": {
|
|
8620
|
+
"deprecated": true,
|
|
8333
8621
|
"description": "**⚠️ DEPRECATED:** This key is deprecated. If you want to prevent empty values, we recommend setting `_inputs.*.options.required` to `true` instead.\n\nThis key toggles whether CloudCannon will accept empty values, and pre-select the first option if opened with an empty value.\n\nSetting this key to `true` will allow CloudCannon to accept empty values.\n\n## Examples\n\nIn this example, CloudCannon will accept empty values for a *Select Input*.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n allow_empty: true\n```",
|
|
8334
|
-
"default": true,
|
|
8335
8622
|
"type": "boolean",
|
|
8336
8623
|
"documented": true,
|
|
8337
8624
|
"title": "allow_empty",
|
|
@@ -8743,6 +9030,33 @@
|
|
|
8743
9030
|
"min_length_message": {
|
|
8744
9031
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
8745
9032
|
},
|
|
9033
|
+
"max_words": {
|
|
9034
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
9035
|
+
},
|
|
9036
|
+
"max_words_message": {
|
|
9037
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
9038
|
+
},
|
|
9039
|
+
"min_words": {
|
|
9040
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
9041
|
+
},
|
|
9042
|
+
"min_words_message": {
|
|
9043
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
9044
|
+
},
|
|
9045
|
+
"max_graphemes": {
|
|
9046
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
9047
|
+
},
|
|
9048
|
+
"max_graphemes_message": {
|
|
9049
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
9050
|
+
},
|
|
9051
|
+
"min_graphemes": {
|
|
9052
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
9053
|
+
},
|
|
9054
|
+
"min_graphemes_message": {
|
|
9055
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
9056
|
+
},
|
|
9057
|
+
"locale": {
|
|
9058
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
9059
|
+
},
|
|
8746
9060
|
"pattern": {
|
|
8747
9061
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
8748
9062
|
},
|