@cloudcannon/configuration-types 0.0.51 → 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 +336 -22
- package/dist/cloudcannon-config.documentation.schema.json +295 -2
- package/dist/cloudcannon-config.latest.schema.json +336 -22
- 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 +326 -12
- package/dist/cloudcannon-schemas.schema.json +326 -12
- package/dist/cloudcannon-snippets.schema.json +326 -12
- package/dist/cloudcannon-structure-value.schema.json +326 -12
- package/dist/cloudcannon-structures.schema.json +326 -12
- package/dist/documentation.json +1311 -26
- package/package.json +1 -1
- package/src/inputs.ts +53 -3
|
@@ -785,6 +785,33 @@
|
|
|
785
785
|
"min_length_message": {
|
|
786
786
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
787
787
|
},
|
|
788
|
+
"max_words": {
|
|
789
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
790
|
+
},
|
|
791
|
+
"max_words_message": {
|
|
792
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
793
|
+
},
|
|
794
|
+
"min_words": {
|
|
795
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
796
|
+
},
|
|
797
|
+
"min_words_message": {
|
|
798
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
799
|
+
},
|
|
800
|
+
"max_graphemes": {
|
|
801
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
802
|
+
},
|
|
803
|
+
"max_graphemes_message": {
|
|
804
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
805
|
+
},
|
|
806
|
+
"min_graphemes": {
|
|
807
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
808
|
+
},
|
|
809
|
+
"min_graphemes_message": {
|
|
810
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
811
|
+
},
|
|
812
|
+
"locale": {
|
|
813
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
814
|
+
},
|
|
788
815
|
"pattern": {
|
|
789
816
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
790
817
|
},
|
|
@@ -4653,6 +4680,69 @@
|
|
|
4653
4680
|
"title": "min_length_message",
|
|
4654
4681
|
"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```"
|
|
4655
4682
|
},
|
|
4683
|
+
"type._inputs.*.options.max_words": {
|
|
4684
|
+
"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.",
|
|
4685
|
+
"type": "number",
|
|
4686
|
+
"documented": true,
|
|
4687
|
+
"title": "max_words",
|
|
4688
|
+
"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."
|
|
4689
|
+
},
|
|
4690
|
+
"type._inputs.*.options.max_words_message": {
|
|
4691
|
+
"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.",
|
|
4692
|
+
"type": "string",
|
|
4693
|
+
"documented": true,
|
|
4694
|
+
"title": "max_words_message",
|
|
4695
|
+
"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."
|
|
4696
|
+
},
|
|
4697
|
+
"type._inputs.*.options.min_words": {
|
|
4698
|
+
"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.",
|
|
4699
|
+
"type": "number",
|
|
4700
|
+
"documented": true,
|
|
4701
|
+
"title": "min_words",
|
|
4702
|
+
"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."
|
|
4703
|
+
},
|
|
4704
|
+
"type._inputs.*.options.min_words_message": {
|
|
4705
|
+
"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`.",
|
|
4706
|
+
"type": "string",
|
|
4707
|
+
"documented": true,
|
|
4708
|
+
"title": "min_words_message",
|
|
4709
|
+
"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`."
|
|
4710
|
+
},
|
|
4711
|
+
"type._inputs.*.options.max_graphemes": {
|
|
4712
|
+
"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.",
|
|
4713
|
+
"type": "number",
|
|
4714
|
+
"documented": true,
|
|
4715
|
+
"title": "max_graphemes",
|
|
4716
|
+
"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."
|
|
4717
|
+
},
|
|
4718
|
+
"type._inputs.*.options.max_graphemes_message": {
|
|
4719
|
+
"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.",
|
|
4720
|
+
"type": "string",
|
|
4721
|
+
"documented": true,
|
|
4722
|
+
"title": "max_graphemes_message",
|
|
4723
|
+
"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."
|
|
4724
|
+
},
|
|
4725
|
+
"type._inputs.*.options.min_graphemes": {
|
|
4726
|
+
"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.",
|
|
4727
|
+
"type": "number",
|
|
4728
|
+
"documented": true,
|
|
4729
|
+
"title": "min_graphemes",
|
|
4730
|
+
"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."
|
|
4731
|
+
},
|
|
4732
|
+
"type._inputs.*.options.min_graphemes_message": {
|
|
4733
|
+
"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`.",
|
|
4734
|
+
"type": "string",
|
|
4735
|
+
"documented": true,
|
|
4736
|
+
"title": "min_graphemes_message",
|
|
4737
|
+
"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`."
|
|
4738
|
+
},
|
|
4739
|
+
"type._inputs.*.options.locale": {
|
|
4740
|
+
"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.",
|
|
4741
|
+
"type": "string",
|
|
4742
|
+
"documented": true,
|
|
4743
|
+
"title": "locale",
|
|
4744
|
+
"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."
|
|
4745
|
+
},
|
|
4656
4746
|
"type._inputs.*.options.pattern": {
|
|
4657
4747
|
"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```",
|
|
4658
4748
|
"type": "string",
|
|
@@ -4822,6 +4912,33 @@
|
|
|
4822
4912
|
"min_length_message": {
|
|
4823
4913
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
4824
4914
|
},
|
|
4915
|
+
"max_words": {
|
|
4916
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
4917
|
+
},
|
|
4918
|
+
"max_words_message": {
|
|
4919
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
4920
|
+
},
|
|
4921
|
+
"min_words": {
|
|
4922
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
4923
|
+
},
|
|
4924
|
+
"min_words_message": {
|
|
4925
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
4926
|
+
},
|
|
4927
|
+
"max_graphemes": {
|
|
4928
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
4929
|
+
},
|
|
4930
|
+
"max_graphemes_message": {
|
|
4931
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
4932
|
+
},
|
|
4933
|
+
"min_graphemes": {
|
|
4934
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
4935
|
+
},
|
|
4936
|
+
"min_graphemes_message": {
|
|
4937
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
4938
|
+
},
|
|
4939
|
+
"locale": {
|
|
4940
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
4941
|
+
},
|
|
4825
4942
|
"pattern": {
|
|
4826
4943
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
4827
4944
|
},
|
|
@@ -4981,6 +5098,33 @@
|
|
|
4981
5098
|
"min_length_message": {
|
|
4982
5099
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
4983
5100
|
},
|
|
5101
|
+
"max_words": {
|
|
5102
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
5103
|
+
},
|
|
5104
|
+
"max_words_message": {
|
|
5105
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
5106
|
+
},
|
|
5107
|
+
"min_words": {
|
|
5108
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
5109
|
+
},
|
|
5110
|
+
"min_words_message": {
|
|
5111
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
5112
|
+
},
|
|
5113
|
+
"max_graphemes": {
|
|
5114
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
5115
|
+
},
|
|
5116
|
+
"max_graphemes_message": {
|
|
5117
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
5118
|
+
},
|
|
5119
|
+
"min_graphemes": {
|
|
5120
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
5121
|
+
},
|
|
5122
|
+
"min_graphemes_message": {
|
|
5123
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
5124
|
+
},
|
|
5125
|
+
"locale": {
|
|
5126
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
5127
|
+
},
|
|
4984
5128
|
"pattern": {
|
|
4985
5129
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
4986
5130
|
},
|
|
@@ -5223,6 +5367,33 @@
|
|
|
5223
5367
|
"min_length_message": {
|
|
5224
5368
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
5225
5369
|
},
|
|
5370
|
+
"max_words": {
|
|
5371
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
5372
|
+
},
|
|
5373
|
+
"max_words_message": {
|
|
5374
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
5375
|
+
},
|
|
5376
|
+
"min_words": {
|
|
5377
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
5378
|
+
},
|
|
5379
|
+
"min_words_message": {
|
|
5380
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
5381
|
+
},
|
|
5382
|
+
"max_graphemes": {
|
|
5383
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
5384
|
+
},
|
|
5385
|
+
"max_graphemes_message": {
|
|
5386
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
5387
|
+
},
|
|
5388
|
+
"min_graphemes": {
|
|
5389
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
5390
|
+
},
|
|
5391
|
+
"min_graphemes_message": {
|
|
5392
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
5393
|
+
},
|
|
5394
|
+
"locale": {
|
|
5395
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
5396
|
+
},
|
|
5226
5397
|
"pattern": {
|
|
5227
5398
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
5228
5399
|
},
|
|
@@ -5846,6 +6017,33 @@
|
|
|
5846
6017
|
"min_length_message": {
|
|
5847
6018
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
5848
6019
|
},
|
|
6020
|
+
"max_words": {
|
|
6021
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
6022
|
+
},
|
|
6023
|
+
"max_words_message": {
|
|
6024
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
6025
|
+
},
|
|
6026
|
+
"min_words": {
|
|
6027
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
6028
|
+
},
|
|
6029
|
+
"min_words_message": {
|
|
6030
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
6031
|
+
},
|
|
6032
|
+
"max_graphemes": {
|
|
6033
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
6034
|
+
},
|
|
6035
|
+
"max_graphemes_message": {
|
|
6036
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
6037
|
+
},
|
|
6038
|
+
"min_graphemes": {
|
|
6039
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
6040
|
+
},
|
|
6041
|
+
"min_graphemes_message": {
|
|
6042
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
6043
|
+
},
|
|
6044
|
+
"locale": {
|
|
6045
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
6046
|
+
},
|
|
5849
6047
|
"pattern": {
|
|
5850
6048
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
5851
6049
|
},
|
|
@@ -5871,12 +6069,20 @@
|
|
|
5871
6069
|
"title": "empty_type"
|
|
5872
6070
|
},
|
|
5873
6071
|
"allow_resize": {
|
|
5874
|
-
"
|
|
5875
|
-
"
|
|
6072
|
+
"deprecated": true,
|
|
6073
|
+
"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).",
|
|
5876
6074
|
"type": "boolean",
|
|
5877
6075
|
"documented": true,
|
|
5878
6076
|
"title": "allow_resize",
|
|
5879
|
-
"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)."
|
|
6077
|
+
"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)."
|
|
6078
|
+
},
|
|
6079
|
+
"prevent_resize": {
|
|
6080
|
+
"description": "Shows or hides the resize handler to vertically resize the input.",
|
|
6081
|
+
"default": false,
|
|
6082
|
+
"type": "boolean",
|
|
6083
|
+
"documented": true,
|
|
6084
|
+
"title": "prevent_resize",
|
|
6085
|
+
"markdownDescription": "Shows or hides the resize handler to vertically resize the input."
|
|
5880
6086
|
},
|
|
5881
6087
|
"initial_height": {
|
|
5882
6088
|
"description": "This key defines the initial height of this input in pixels (px).",
|
|
@@ -6328,11 +6534,11 @@
|
|
|
6328
6534
|
"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."
|
|
6329
6535
|
},
|
|
6330
6536
|
"type._editables.*.styles": {
|
|
6331
|
-
"description": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\
|
|
6537
|
+
"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```",
|
|
6332
6538
|
"type": "string",
|
|
6333
6539
|
"documented": true,
|
|
6334
6540
|
"title": "styles",
|
|
6335
|
-
"markdownDescription": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\
|
|
6541
|
+
"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```"
|
|
6336
6542
|
},
|
|
6337
6543
|
"type._editables.*.table": {
|
|
6338
6544
|
"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.",
|
|
@@ -7311,6 +7517,33 @@
|
|
|
7311
7517
|
"min_length_message": {
|
|
7312
7518
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
7313
7519
|
},
|
|
7520
|
+
"max_words": {
|
|
7521
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
7522
|
+
},
|
|
7523
|
+
"max_words_message": {
|
|
7524
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
7525
|
+
},
|
|
7526
|
+
"min_words": {
|
|
7527
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
7528
|
+
},
|
|
7529
|
+
"min_words_message": {
|
|
7530
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
7531
|
+
},
|
|
7532
|
+
"max_graphemes": {
|
|
7533
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
7534
|
+
},
|
|
7535
|
+
"max_graphemes_message": {
|
|
7536
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
7537
|
+
},
|
|
7538
|
+
"min_graphemes": {
|
|
7539
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
7540
|
+
},
|
|
7541
|
+
"min_graphemes_message": {
|
|
7542
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
7543
|
+
},
|
|
7544
|
+
"locale": {
|
|
7545
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
7546
|
+
},
|
|
7314
7547
|
"pattern": {
|
|
7315
7548
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
7316
7549
|
},
|
|
@@ -7978,6 +8211,33 @@
|
|
|
7978
8211
|
"min_length_message": {
|
|
7979
8212
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
7980
8213
|
},
|
|
8214
|
+
"max_words": {
|
|
8215
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
8216
|
+
},
|
|
8217
|
+
"max_words_message": {
|
|
8218
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
8219
|
+
},
|
|
8220
|
+
"min_words": {
|
|
8221
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
8222
|
+
},
|
|
8223
|
+
"min_words_message": {
|
|
8224
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
8225
|
+
},
|
|
8226
|
+
"max_graphemes": {
|
|
8227
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
8228
|
+
},
|
|
8229
|
+
"max_graphemes_message": {
|
|
8230
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
8231
|
+
},
|
|
8232
|
+
"min_graphemes": {
|
|
8233
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
8234
|
+
},
|
|
8235
|
+
"min_graphemes_message": {
|
|
8236
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
8237
|
+
},
|
|
8238
|
+
"locale": {
|
|
8239
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
8240
|
+
},
|
|
7981
8241
|
"pattern": {
|
|
7982
8242
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
7983
8243
|
},
|
|
@@ -8187,6 +8447,33 @@
|
|
|
8187
8447
|
"min_length_message": {
|
|
8188
8448
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
8189
8449
|
},
|
|
8450
|
+
"max_words": {
|
|
8451
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
8452
|
+
},
|
|
8453
|
+
"max_words_message": {
|
|
8454
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
8455
|
+
},
|
|
8456
|
+
"min_words": {
|
|
8457
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
8458
|
+
},
|
|
8459
|
+
"min_words_message": {
|
|
8460
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
8461
|
+
},
|
|
8462
|
+
"max_graphemes": {
|
|
8463
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
8464
|
+
},
|
|
8465
|
+
"max_graphemes_message": {
|
|
8466
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
8467
|
+
},
|
|
8468
|
+
"min_graphemes": {
|
|
8469
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
8470
|
+
},
|
|
8471
|
+
"min_graphemes_message": {
|
|
8472
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
8473
|
+
},
|
|
8474
|
+
"locale": {
|
|
8475
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
8476
|
+
},
|
|
8190
8477
|
"pattern": {
|
|
8191
8478
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
8192
8479
|
},
|
|
@@ -8228,8 +8515,8 @@
|
|
|
8228
8515
|
"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```"
|
|
8229
8516
|
},
|
|
8230
8517
|
"type._inputs.*.options.allow_empty": {
|
|
8518
|
+
"deprecated": true,
|
|
8231
8519
|
"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```",
|
|
8232
|
-
"default": true,
|
|
8233
8520
|
"type": "boolean",
|
|
8234
8521
|
"documented": true,
|
|
8235
8522
|
"title": "allow_empty",
|
|
@@ -8641,6 +8928,33 @@
|
|
|
8641
8928
|
"min_length_message": {
|
|
8642
8929
|
"$ref": "#/definitions/type._inputs.*.options.min_length_message"
|
|
8643
8930
|
},
|
|
8931
|
+
"max_words": {
|
|
8932
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words"
|
|
8933
|
+
},
|
|
8934
|
+
"max_words_message": {
|
|
8935
|
+
"$ref": "#/definitions/type._inputs.*.options.max_words_message"
|
|
8936
|
+
},
|
|
8937
|
+
"min_words": {
|
|
8938
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words"
|
|
8939
|
+
},
|
|
8940
|
+
"min_words_message": {
|
|
8941
|
+
"$ref": "#/definitions/type._inputs.*.options.min_words_message"
|
|
8942
|
+
},
|
|
8943
|
+
"max_graphemes": {
|
|
8944
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes"
|
|
8945
|
+
},
|
|
8946
|
+
"max_graphemes_message": {
|
|
8947
|
+
"$ref": "#/definitions/type._inputs.*.options.max_graphemes_message"
|
|
8948
|
+
},
|
|
8949
|
+
"min_graphemes": {
|
|
8950
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes"
|
|
8951
|
+
},
|
|
8952
|
+
"min_graphemes_message": {
|
|
8953
|
+
"$ref": "#/definitions/type._inputs.*.options.min_graphemes_message"
|
|
8954
|
+
},
|
|
8955
|
+
"locale": {
|
|
8956
|
+
"$ref": "#/definitions/type._inputs.*.options.locale"
|
|
8957
|
+
},
|
|
8644
8958
|
"pattern": {
|
|
8645
8959
|
"$ref": "#/definitions/type._inputs.*.options.pattern"
|
|
8646
8960
|
},
|
|
@@ -9173,13 +9487,13 @@
|
|
|
9173
9487
|
"type": "string",
|
|
9174
9488
|
"documented": true,
|
|
9175
9489
|
"title": "values_from_glob[*]",
|
|
9176
|
-
"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
|
|
9177
|
-
"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
|
|
9490
|
+
"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```",
|
|
9491
|
+
"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```"
|
|
9178
9492
|
},
|
|
9179
9493
|
"documented": true,
|
|
9180
9494
|
"title": "values_from_glob",
|
|
9181
|
-
"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/
|
|
9182
|
-
"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/
|
|
9495
|
+
"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```",
|
|
9496
|
+
"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```"
|
|
9183
9497
|
},
|
|
9184
9498
|
"id_key": {
|
|
9185
9499
|
"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```",
|
|
@@ -9597,8 +9911,8 @@
|
|
|
9597
9911
|
},
|
|
9598
9912
|
"documented": true,
|
|
9599
9913
|
"title": "_structures_from_glob",
|
|
9600
|
-
"description": "This key defines globs that filter which files CloudCannon should use for *Structure* 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.structures.yml`.\n\nYou can use this key anywhere you would use the `_structures` key in the configuration cascade.\n\nPlease see our documentation on [values_from_glob](https://cloudcannon.com/documentation/
|
|
9601
|
-
"markdownDescription": "This key defines globs that filter which files CloudCannon should use for *Structure* 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.structures.yml`.\n\nYou can use this key anywhere you would use the `_structures` key in the configuration cascade.\n\nPlease see our documentation on [values_from_glob](https://cloudcannon.com/documentation/
|
|
9914
|
+
"description": "This key defines globs that filter which files CloudCannon should use for *Structure* 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.structures.yml`.\n\nYou can use this key anywhere you would use the `_structures` key in the configuration cascade.\n\nPlease see our documentation on [values_from_glob](https://cloudcannon.com/documentation/developer-reference/configuration-file/types/structure/values_from_glob/) for defining individual\n*Structure* values in a split *Configuration File*.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we have several *Structure Configuration Files* in the `.cloudcannon/structures/` folder. The value of the `_structures_from_glob` key tells CloudCannon to use the `staffMembers.cloudcannon.structures.yml` file in that folder.\n\n```yaml\n_structures_from_glob:\n - '/.cloudcannon/structures/staffMembers.cloudcannon.structures.yml'\n```\n\n```yaml\nstaff:\n style: modal\n values:\n - label: Employee\n value:\n name:\n job_description:\n profile_picture:\n - label: Manager\n value:\n name:\n job_description:\n profile_picture:\n url:\n```",
|
|
9915
|
+
"markdownDescription": "This key defines globs that filter which files CloudCannon should use for *Structure* 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.structures.yml`.\n\nYou can use this key anywhere you would use the `_structures` key in the configuration cascade.\n\nPlease see our documentation on [values_from_glob](https://cloudcannon.com/documentation/developer-reference/configuration-file/types/structure/values_from_glob/) for defining individual\n*Structure* values in a split *Configuration File*.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we have several *Structure Configuration Files* in the `.cloudcannon/structures/` folder. The value of the `_structures_from_glob` key tells CloudCannon to use the `staffMembers.cloudcannon.structures.yml` file in that folder.\n\n```yaml\n_structures_from_glob:\n - '/.cloudcannon/structures/staffMembers.cloudcannon.structures.yml'\n```\n\n```yaml\nstaff:\n style: modal\n values:\n - label: Employee\n value:\n name:\n job_description:\n profile_picture:\n - label: Manager\n value:\n name:\n job_description:\n profile_picture:\n url:\n```"
|
|
9602
9916
|
}
|
|
9603
9917
|
},
|
|
9604
9918
|
"documented": false,
|