57e55472555e8958abcda3a67c2c5b53e8b6cd55
[yaffs-website] / web / core / config / schema / core.entity.schema.yml
1 # Schema for Configuration files of the entity module.
2
3 core.entity_view_mode.*.*:
4   type: config_entity
5   label: 'Entity view mode settings'
6   mapping:
7     id:
8       type: string
9       label: 'ID'
10     label:
11       type: label
12       label: 'The human-readable name of the view mode'
13     targetEntityType:
14       type: string
15       label: 'Target entity type'
16     cache:
17       type: boolean
18       label: 'Cached'
19
20 core.entity_form_mode.*.*:
21   type: config_entity
22   label: 'Entity form mode settings'
23   mapping:
24     id:
25       type: string
26       label: 'ID'
27     label:
28       type: label
29       label: 'Label'
30     targetEntityType:
31       type: string
32       label: 'Target entity type'
33     cache:
34       type: boolean
35       label: 'Cache'
36
37 # Overview configuration information for view mode or form mode displays.
38 core.entity_view_display.*.*.*:
39   type: config_entity
40   label: 'Entity display'
41   mapping:
42     id:
43       type: string
44       label: 'ID'
45     targetEntityType:
46       type: string
47       label: 'Target entity type'
48     bundle:
49       type: string
50       label: 'Bundle'
51     mode:
52       type: string
53       label: 'View or form mode machine name'
54     content:
55       type: sequence
56       label: 'Field formatters'
57       sequence:
58         type: field_formatter.entity_view_display
59     hidden:
60       type: sequence
61       label: 'Field display setting'
62       sequence:
63         type: boolean
64         label: 'Value'
65
66 field_formatter:
67   type: mapping
68   label: 'Field formatter'
69   mapping:
70     type:
71       type: string
72       label: 'Format type machine name'
73     label:
74        type: string
75        label: 'Label setting machine name'
76     settings:
77       type: field.formatter.settings.[%parent.type]
78       label: 'Settings'
79     third_party_settings:
80        type: sequence
81        label: 'Third party settings'
82        sequence:
83          type: field.formatter.third_party.[%key]
84
85 field_formatter.entity_view_display:
86   type: field_formatter
87   mapping:
88     weight:
89       type: integer
90       label: 'Weight'
91     region:
92       type: string
93       label: 'Region'
94
95 # Overview configuration information for form mode displays.
96 core.entity_form_display.*.*.*:
97   type: config_entity
98   label: 'Entity form display'
99   mapping:
100     id:
101       type: string
102       label: 'ID'
103     targetEntityType:
104       type: string
105       label: 'Target entity type'
106     bundle:
107       type: string
108       label: 'Bundle'
109     mode:
110       type: string
111       label: 'View or form mode machine name'
112     status:
113       type: boolean
114       label: 'Enabled'
115     content:
116       type: sequence
117       label: 'Field widgets'
118       sequence:
119         type: mapping
120         label: 'Field widget'
121         mapping:
122           type:
123             type: string
124             label: 'Widget type machine name'
125           weight:
126             type: integer
127             label: 'Weight'
128           region:
129             type: string
130             label: 'Region'
131           settings:
132             type: field.widget.settings.[%parent.type]
133             label: 'Settings'
134           third_party_settings:
135             type: sequence
136             label: 'Third party settings'
137             sequence:
138               type: field.widget.third_party.[%key]
139     hidden:
140       type: sequence
141       label: 'Hidden'
142       sequence:
143         type: boolean
144         label: 'Component'
145
146 # Default schema for entity display field with undefined type.
147 field.formatter.settings.*:
148   type: mapping
149
150 # Default schema for entity form display field with undefined type.
151 field.widget.settings.*:
152   type: mapping
153
154 field.widget.settings.string_textfield:
155   type: mapping
156   label: 'Text field display format settings'
157   mapping:
158     size:
159       type: integer
160       label: 'Size of textfield'
161     placeholder:
162       type: label
163       label: 'Placeholder'
164
165 field.widget.settings.string_textarea:
166   type: mapping
167   label: 'Textarea display format settings'
168   mapping:
169     rows:
170       type: integer
171       label: 'Rows'
172     placeholder:
173       type: label
174       label: 'Placeholder'
175
176 field.widget.settings.uri:
177   type: mapping
178   label: 'URI field'
179   mapping:
180     size:
181       type: integer
182       label: 'Size of URI field'
183     placeholder:
184       type: label
185       label: 'Placeholder'
186
187 field.widget.settings.email_default:
188   type: mapping
189   label: 'Email field display format settings'
190   mapping:
191     placeholder:
192       type: label
193       label: 'Placeholder'
194     size:
195       type: integer
196       label: 'Size of email field'
197
198 field.widget.settings.datetime_timestamp:
199   type: mapping
200   label: 'Datetime timestamp display format settings'
201
202 field.widget.settings.boolean_checkbox:
203   type: mapping
204   label: 'Boolean checkbox display format settings'
205   mapping:
206     display_label:
207       type: boolean
208       label: 'Display label'
209
210 field.widget.settings.hidden:
211   type: mapping
212   label: '- Hidden - format settings'
213
214 field.widget.settings.number:
215   type: mapping
216   label: 'Number default display format settings'
217   mapping:
218     placeholder:
219       type: label
220       label: 'Placeholder'
221
222 field.widget.settings.checkbox:
223   type: mapping
224   label: 'Single on/off checkbox format settings'
225   mapping:
226     display_label:
227       type: boolean
228       label: 'Use field label instead of the "On value" as label'
229
230 field.widget.settings.entity_reference_autocomplete_tags:
231   type: mapping
232   label: 'Entity reference autocomplete (Tags style) display format settings'
233   mapping:
234     match_operator:
235       type: string
236       label: 'Autocomplete matching'
237     size:
238       type: integer
239       label: 'Size of textfield'
240     placeholder:
241       type: label
242       label: 'Placeholder'
243
244 field.widget.settings.entity_reference_autocomplete:
245   type: mapping
246   label: 'Entity reference autocomplete display format settings'
247   mapping:
248     match_operator:
249       type: string
250       label: 'Autocomplete matching'
251     size:
252       type: integer
253       label: 'Size of textfield'
254     placeholder:
255       type: label
256       label: 'Placeholder'
257
258 field.formatter.settings.boolean:
259   type: mapping
260   mapping:
261     format:
262       type: string
263       label: 'Output format'
264     format_custom_false:
265       type: label
266       label: 'Custom output for FALSE'
267     format_custom_true:
268       type: label
269       label: 'Custom output for TRUE'
270
271 field.formatter.settings.string:
272   type: mapping
273   mapping:
274     link_to_entity:
275       type: boolean
276       label: 'Link to the entity'
277
278 field.formatter.settings.language:
279   type: field.formatter.settings.string
280   mapping:
281     native_language:
282       type: boolean
283       label: 'Display in native language'
284
285 field.formatter.settings.number_decimal:
286   type: mapping
287   label: 'Number decimal display format settings'
288   mapping:
289     thousand_separator:
290       type: string
291       label: 'Thousand marker'
292     decimal_separator:
293       type: string
294       label: 'Decimal marker'
295     scale:
296       type: integer
297       label: 'Scale'
298     prefix_suffix:
299       type: boolean
300       label: 'Display prefix and suffix.'
301
302 field.formatter.settings.number_integer:
303   type: mapping
304   label: 'Number integer display format settings'
305   mapping:
306     thousand_separator:
307       type: string
308       label: 'Thousand marker'
309     prefix_suffix:
310       type: boolean
311       label: 'Display prefix and suffix.'
312
313 field.formatter.settings.number_unformatted:
314   type: mapping
315   label: 'Number unformatted display format settings'
316
317 field.formatter.settings.uri_link:
318   type: mapping
319   label: 'URI as link display format settings'
320
321 field.formatter.settings.timestamp:
322   type: mapping
323   label: 'Timestamp display format settings'
324   mapping:
325     date_format:
326       type: string
327       label: 'Date format'
328     custom_date_format:
329       type: string
330       label: 'Custom date format'
331     timezone:
332       type: string
333       label: 'Time zone'
334
335 field.formatter.settings.timestamp_ago:
336   type: mapping
337   label: 'Timestamp ago display format settings'
338   mapping:
339     future_format:
340       type: string
341       label: 'Future format'
342     past_format:
343       type: string
344       label: 'Past format'
345     granularity:
346       type: integer
347       label: 'Granularity'
348
349 field.formatter.settings.entity_reference_entity_view:
350   type: mapping
351   label: 'Entity reference rendered entity display format settings'
352   mapping:
353     view_mode:
354       type: string
355       label: 'View mode'
356     link:
357       type: boolean
358       label: 'Show links'
359
360 field.formatter.settings.entity_reference_entity_id:
361   type: mapping
362   label: 'Entity reference entity ID display format settings'
363
364 field.formatter.settings.entity_reference_label:
365   type: mapping
366   label: 'Entity reference label display format settings'
367   mapping:
368     link:
369       type: boolean
370       label: 'Link label to the referenced entity'
371
372 block.settings.field_block:*:*:*:
373   type: block_settings
374   mapping:
375     formatter:
376       type: field_formatter
377
378 # Schema for entity actions.
379 action.configuration.entity:*:*:
380   type: action_configuration_default
381   label: 'Entity action'