You are here

Home » API reference » Drupal 9

tour.schema.yml in Drupal 9

Same filename and directory in other branches
  1. 8 core/modules/tour/config/schema/tour.schema.yml
core/modules/tour/config/schema/tour.schema.yml

File

core/modules/tour/config/schema/tour.schema.yml
View source 
  1. # Schema for the configuration files of the Tour module.

  2. 

  3. tour.tour.*:

  4.   type: config_entity

  5.   label: 'Tour settings'

  6.   mapping:

  7.     id:

  8.       type: string

  9.       label: 'ID'

  10.     label:

  11.       type: label

  12.       label: 'Label'

  13.     module:

  14.       type: string

  15.       label: 'Providing module'

  16.     routes:

  17.       type: sequence

  18.       label: 'Route settings'

  19.       sequence:

  20.         type: route

  21.         label: 'Route'

  22.     tips:

  23.       type: sequence

  24.       label: 'Tips'

  25.       sequence:

  26.         type: tour.tip.[plugin]

  27.         label: 'Tour tip'

  28. 

  29. tour.tip:

  30.   type: mapping

  31.   label: 'Tour tip'

  32.   mapping:

  33.     id:

  34.       type: string

  35.       label: 'ID'

  36.     plugin:

  37.       type: string

  38.       label: 'Plugin'

  39.     label:

  40.       type: label

  41.       label: 'Label'

  42.     weight:

  43.       type: integer

  44.       label: 'Weight'

  45.     location:

  46.       deprecated: "The tour.tip 'location' config schema property is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Instead use 'position'. The value must be a valid placement accepted by PopperJS. See https://www.drupal.org/node/3204093"

  47.       type: string

  48.       label: 'Location'

  49.     position:

  50.       type: string

  51.       label: 'Position'

  52.     selector:

  53.       type: string

  54.       label: 'Selector'

  55.     attributes:

  56.       deprecated: "The tour.tip 'attributes' config schema property is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Instead of 'data-class' and 'data-id' attributes, use 'selector' to specify the element a tip attaches to. See https://www.drupal.org/node/3204093"

  57.       type: sequence

  58.       label: 'Attributes'

  59.       sequence:

  60.         type: string

  61.         label: 'Attribute'

  62. 

  63. tour.tip.text:

  64.   type: tour.tip

  65.   label: 'Textual tour tip'

  66.   mapping:

  67.     body:

  68.       type: text

  69.       label: 'Body'