tour.schema.yml

Same filename in other branches
  1. 8.9.x core/modules/tour/config/schema/tour.schema.yml
  2. 10 core/modules/tour/config/schema/tour.schema.yml
  3. 11.x 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. tour.tour.*:
  3. type: config_entity
  4. label: 'Tour settings'
  5. mapping:
  6. id:
  7. type: string
  8. label: 'ID'
  9. label:
  10. type: label
  11. label: 'Label'
  12. module:
  13. type: string
  14. label: 'Providing module'
  15. routes:
  16. type: sequence
  17. label: 'Route settings'
  18. sequence:
  19. type: route
  20. label: 'Route'
  21. tips:
  22. type: sequence
  23. label: 'Tips'
  24. sequence:
  25. type: tour.tip.[plugin]
  26. label: 'Tour tip'
  27. tour.tip:
  28. type: mapping
  29. label: 'Tour tip'
  30. mapping:
  31. id:
  32. type: string
  33. label: 'ID'
  34. plugin:
  35. type: string
  36. label: 'Plugin'
  37. label:
  38. type: label
  39. label: 'Label'
  40. weight:
  41. type: integer
  42. label: 'Weight'
  43. location:
  44. 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"
  45. type: string
  46. label: 'Location'
  47. position:
  48. type: string
  49. label: 'Position'
  50. selector:
  51. type: string
  52. label: 'Selector'
  53. attributes:
  54. 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"
  55. type: sequence
  56. label: 'Attributes'
  57. sequence:
  58. type: string
  59. label: 'Attribute'
  60. tour.tip.text:
  61. type: tour.tip
  62. label: 'Textual tour tip'
  63. mapping:
  64. body:
  65. type: text
  66. label: 'Body'

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