text.schema.yml

Same filename in other branches
  1. 9 core/modules/text/config/schema/text.schema.yml
  2. 8.9.x core/modules/text/config/schema/text.schema.yml
  3. 11.x core/modules/text/config/schema/text.schema.yml
core/modules/text/config/schema/text.schema.yml

File

core/modules/text/config/schema/text.schema.yml

View source 
  1. # Schema for the configuration files of the text module.

  2. 

  3. text.settings:

  4.   type: config_object

  5.   label: 'Text settings'

  6.   constraints:

  7.     FullyValidatable: ~

  8.   mapping:

  9.     default_summary_length:

  10.       type: integer

  11.       label: 'Default summary length'

  12.       constraints:

  13.         NotNull: [ ]

  14.         Range:

  15.           min: 1

  16. 

  17. field.storage_settings.text:

  18.   type: mapping

  19.   label: 'Text (formatted) settings'

  20.   mapping:

  21.     max_length:

  22.       type: integer

  23.       label: 'Maximum length'

  24. 

  25. field.field_settings.text:

  26.   type: mapping

  27.   label: 'Text (formatted) settings'

  28.   mapping:

  29.     allowed_formats:

  30.       type: sequence

  31.       label: 'Allowed text formats'

  32.       sequence:

  33.         type: string

  34. 

  35. field.value.text:

  36.   type: mapping

  37.   label: 'Default value'

  38.   mapping:

  39.     value:

  40.       type: label

  41.       label: 'Value'

  42.     format:

  43.       type: string

  44.       label: 'Text format'

  45. 

  46. field.storage_settings.text_long:

  47.   label: 'Text (formatted, long) settings'

  48.   type: field.field_settings.text

  49. 

  50. field.field_settings.text_long:

  51.   label: 'Text (formatted, long) settings'

  52.   type: mapping

  53.   mapping:

  54.     allowed_formats:

  55.       type: sequence

  56.       label: 'Allowed text formats'

  57.       sequence:

  58.         type: string

  59. 

  60. field.value.text_long:

  61.   type: mapping

  62.   label: 'Default value'

  63.   mapping:

  64.     value:

  65.       type: text

  66.       label: 'Value'

  67.     format:

  68.       type: string

  69.       label: 'Text format'

  70. 

  71. # This field type has no field storage settings, so no specific config schema type.

  72. # @see `type: field.storage_settings.*`

  73. field.field_settings.text_with_summary:

  74.   type: mapping

  75.   label: 'Text (formatted, long, with summary) settings'

  76.   mapping:

  77.     display_summary:

  78.       type: boolean

  79.       label: 'Summary input'

  80.     required_summary:

  81.       type: boolean

  82.       label: 'Require summary'

  83.     allowed_formats:

  84.       type: sequence

  85.       label: 'Allowed text formats'

  86.       sequence:

  87.         type: string

  88. 

  89. field.value.text_with_summary:

  90.   type: mapping

  91.   label: 'Default value'

  92.   mapping:

  93.     value:

  94.       type: text

  95.       label: 'Body'

  96.     summary:

  97.       type: string

  98.       label: 'Summary'

  99.     format:

  100.       type: string

  101.       label: 'Text format'

  102. 

  103. field.formatter.settings.text_default:

  104.   type: mapping

  105.   label: 'Formatted text default display format settings'

  106. 

  107. field.formatter.settings.text_summary_or_trimmed:

  108.   type: mapping

  109.   label: 'Summary or trimmed formatted text display format settings'

  110.   mapping:

  111.     trim_length:

  112.       type: integer

  113.       label: 'Trim length'

  114. 

  115. field.formatter.settings.text_trimmed:

  116.   type: mapping

  117.   label: 'Trimmed text display format settings'

  118.   mapping:

  119.     trim_length:

  120.       type: integer

  121.       label: 'Trim length'

  122. 

  123. field.widget.settings.text_textarea:

  124.   type: mapping

  125.   label: 'Text area (multiple rows) display format settings'

  126.   mapping:

  127.     rows:

  128.       type: integer

  129.       label: 'Rows'

  130.     placeholder:

  131.       type: label

  132.       label: 'Placeholder'

  133. 

  134. field.widget.settings.text_textarea_with_summary:

  135.   type: mapping

  136.   label: 'Text area with a summary display format settings'

  137.   mapping:

  138.     rows:

  139.       type: integer

  140.       label: 'Rows'

  141.     summary_rows:

  142.       type: integer

  143.       label: 'Number of summary rows'

  144.     placeholder:

  145.       type: text

  146.       label: 'Placeholder'

  147.     show_summary:

  148.       type: boolean

  149.       label: 'Always show summary'

  150. 

  151. field.widget.settings.text_textfield:

  152.   type: mapping

  153.   label: 'Text field display format settings'

  154.   mapping:

  155.     size:

  156.       type: integer

  157.       label: 'Size of textfield'

  158.     placeholder:

  159.       type: label

  160.       label: 'Placeholder'

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