core.entity.schema.yml

Same filename in other branches
  1. 9 core/config/schema/core.entity.schema.yml
  2. 10 core/config/schema/core.entity.schema.yml
  3. 11.x core/config/schema/core.entity.schema.yml
core/config/schema/core.entity.schema.yml

File

core/config/schema/core.entity.schema.yml

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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.