You are here

Home » API reference » Background Image 2.0.x

background_image.schema.yml in Background Image 2.0.x

Same filename and directory in other branches
  1. 8 config/schema/background_image.schema.yml
  2. 2.x config/schema/background_image.schema.yml
config/schema/background_image.schema.yml

File

config/schema/background_image.schema.yml
View source 
  1. background_image.settings.*:

  2.   type: background_image_settings

  3.   label: 'Internal use only, does not export.'

  4. 

  5. background_image.settings:

  6.   type: config_object

  7.   mapping:

  8.     defaults:

  9.       type: background_image_settings

  10.       label: 'Default settings for background image entities.'

  11.     entities:

  12.       # Entity type

  13.       type: sequence

  14.       label: 'List of entities.'

  15.       sequence:

  16.         # Entity type bundle.

  17.         type: sequence

  18.         sequence:

  19.           # Properties

  20.           type: mapping

  21.           mapping:

  22.             enable:

  23.               type: boolean

  24.               label: 'Flag indicating whether entity bundle is enabled.'

  25.             embed:

  26.               type: boolean

  27.               label: 'Flag indicating whether entity bundle can be embedded.'

  28.             require:

  29.               type: boolean

  30.               label: 'Flag indicating whether a background image on the entity bundle is required.'

  31.             group:

  32.               type: string

  33.               label: 'The group in which the background image form will be embedded into (if it exists).'

  34.     retina_rules:

  35.       type: sequence

  36.       label: 'The CSS media query rules that are used to determine when to apply the "retina" or @2x version of the image.'

  37.       sequence:

  38.         type: string

  39.     css:

  40.       type: mapping

  41.       mapping:

  42.         base_class:

  43.           type: string

  44.           label: 'Base class'

  45.         retina_rules:

  46.           type: sequence

  47.           label: 'The CSS media query rules that are used to determine when to apply the "retina" or @2x version of the image.'

  48.           sequence:

  49.             type: string

  50.     image_style:

  51.       type: sequence

  52.       label: 'List of image styles'

  53.       sequence:

  54.         type: string