core.entity.schema.yml 6.97 KB
Newer Older
1 2
# Schema for Configuration files of the entity module.

3
core.entity_view_mode.*.*:
4
  type: mapping
5
  label: 'Entity view mode settings'
6 7 8
  mapping:
    id:
      type: string
9
      label: 'ID'
10 11 12 13 14
    uuid:
      type: string
      label: 'UUID'
    label:
      type: label
15
      label: 'The human-readable name of the view mode'
16 17
    targetEntityType:
      type: string
18
      label: 'Target entity type'
19 20 21 22 23 24 25 26 27
    status:
      type: boolean
      label: 'Enabled'
    cache:
      type: boolean
      label: 'Cached'
    langcode:
      type: string
      label: 'Default language'
28 29 30
    dependencies:
      type: config_dependencies
      label: 'Dependencies'
31

32
core.entity_form_mode.*.*:
33
  type: config_entity
34 35
  label: 'Entity form mode settings'
  mapping:
36 37 38 39 40 41
    id:
      type: string
      label: 'ID'
    label:
      type: label
      label: 'Label'
42 43 44 45 46 47
    targetEntityType:
      type: string
      label: 'Target entity type'
    cache:
      type: boolean
      label: 'Cache'
48 49

# Overview configuration information for view mode or form mode displays.
50
core.entity_view_display.*.*.*:
51
  type: config_entity
52 53
  label: 'Entity display'
  mapping:
54 55 56
    id:
      type: string
      label: 'ID'
57 58 59 60 61 62 63 64 65 66 67
    targetEntityType:
      type: string
      label: 'Target entity type'
    bundle:
      type: string
      label: 'Bundle'
    mode:
      type: string
      label: 'View or form mode machine name'
    content:
      type: sequence
68
      label: 'Field formatters'
69
      sequence:
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
        - type: mapping
          label: 'Field formatter'
          mapping:
            type:
              type: string
              label: 'Format type machine name'
            weight:
              type: integer
              label: 'Weight'
            label:
               type: string
               label: 'Label setting machine name'
            settings:
              type: field.formatter.settings.[%parent.type]
              label: 'Settings'
85 86 87 88 89
            third_party_settings:
               type: sequence
               label: 'Third party settings'
               sequence:
                 - type: field.formatter.third_party.[%key]
90 91 92 93 94 95
    hidden:
      type: sequence
      label: 'Field display setting'
      sequence:
        - type: boolean
          label: 'Value'
96 97 98 99 100
    third_party_settings:
      type: sequence
      label: 'Third party settings'
      sequence:
        - type: entity_view_display.third_party.[%key]
101 102

# Overview configuration information for form mode displays.
103
core.entity_form_display.*.*.*:
104
  type: config_entity
105 106
  label: 'Entity form display'
  mapping:
107 108 109
    id:
      type: string
      label: 'ID'
110 111 112 113 114 115 116 117 118
    targetEntityType:
      type: string
      label: 'Target entity type'
    bundle:
      type: string
      label: 'Bundle'
    mode:
      type: string
      label: 'View or form mode machine name'
119 120 121
    status:
      type: boolean
      label: 'Enabled'
122 123
    content:
      type: sequence
124
      label: 'Field widgets'
125
      sequence:
126 127 128 129 130 131 132 133 134
        - type: mapping
          label: 'Field widget'
          mapping:
            type:
              type: string
              label: 'Widget type machine name'
            weight:
              type: integer
              label: 'Weight'
135 136 137
            settings:
              type: field.widget.settings.[%parent.type]
              label: 'Settings'
138 139 140 141
            third_party_settings:
              type: sequence
              label: 'Third party settings'
              sequence:
142
                - type: field.widget.third_party.[%key]
143 144 145 146 147 148
    hidden:
      type: sequence
      label: 'Hidden'
      sequence:
        - type: boolean
          label: 'Component'
149 150 151 152 153
    third_party_settings:
      type: sequence
      label: 'Third party settings'
      sequence:
        - type: entity_form_display.third_party.[%key]
154 155

# Default schema for entity display field with undefined type.
156 157
field.formatter.settings.*:
  type: mapping
158 159

# Default schema for entity form display field with undefined type.
160 161
field.widget.settings.*:
  type: mapping
162

163 164
field.widget.settings.string_textfield:
  type: mapping
165
  label: 'Text field display format settings'
166
  mapping:
167 168 169 170 171 172
    size:
      type: integer
      label: 'Size of textfield'
    placeholder:
      type: label
      label: 'Placeholder'
173

174 175
field.widget.settings.string_textarea:
  type: mapping
176
  label: 'Textarea display format settings'
177
  mapping:
178 179 180 181 182 183
    rows:
      type: integer
      label: 'Rows'
    placeholder:
      type: label
      label: 'Placeholder'
184

185 186
field.widget.settings.email_default:
  type: mapping
187 188
  label: 'Email field display format settings'
  mapping:
189 190 191
    placeholder:
      type: label
      label: 'Placeholder'
192

193 194
field.widget.settings.datetime_timestamp:
  type: mapping
195
  label: 'Datetime timestamp display format settings'
196

197 198
field.widget.settings.boolean_checkbox:
  type: mapping
199 200
  label: 'Boolean checkbox display format settings'
  mapping:
201 202 203
    display_label:
      type: boolean
      label: 'Display label'
204

205 206
field.widget.settings.hidden:
  type: mapping
207 208
  label: '- Hidden - format settings'

209 210
field.widget.settings.number:
  type: mapping
211 212
  label: 'Number default display format settings'
  mapping:
213 214 215
    placeholder:
      type: label
      label: 'Placeholder'
216

217 218
field.widget.settings.checkbox:
  type: mapping
219 220
  label: 'Single on/off checkbox format settings'
  mapping:
221 222 223
    display_label:
      type: boolean
      label: 'Use field label instead of the "On value" as label'
224

225 226 227 228 229 230 231
field.formatter.settings.string:
  type: mapping
  mapping:
    link_to_entity:
      type: boolean
      label: 'Link to the entity'

232 233
field.formatter.settings.number_decimal:
  type: mapping
234 235
  label: 'Number decimal display format settings'
  mapping:
236 237 238 239 240 241 242 243 244 245 246 247
    thousand_separator:
      type: string
      label: 'Thousand marker'
    decimal_separator:
      type: string
      label: 'Decimal marker'
    scale:
      type: integer
      label: 'Scale'
    prefix_suffix:
      type: boolean
      label: 'Display prefix and suffix.'
248

249 250
field.formatter.settings.number_integer:
  type: mapping
251
  label: 'Number integer display format settings'
252
  mapping:
253 254 255 256 257 258
    thousand_separator:
      type: string
      label: 'Thousand marker'
    prefix_suffix:
      type: boolean
      label: 'Display prefix and suffix.'
259

260 261
field.formatter.settings.number_unformatted:
  type: mapping
262
  label: 'Number unformatted display format settings'
263

264 265
field.formatter.settings.uri_link:
  type: mapping
266 267
  label: 'URI as link display format settings'

268 269
field.formatter.settings.timestamp_ago:
  type: mapping
270
  label: 'Timestamp ago display format settings'
271

272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
field.formatter.settings.entity_reference_entity_view:
  type: mapping
  label: 'Entity reference rendered entity display format settings'
  mapping:
    view_mode:
      type: string
      label: 'View mode'
    link:
      type: boolean
      label: 'Show links'

field.formatter.settings.entity_reference_entity_id:
  type: mapping
  label: 'Entity reference entity ID display format settings'

field.formatter.settings.entity_reference_label:
  type: mapping
  label: 'Entity reference label display format settings'
  mapping:
    link:
      type: boolean
      label: 'Link label to the referenced entity'