You are here

Home » API reference » Drupal 10

ckeditor5.schema.yml in Drupal 10

core/modules/ckeditor5/config/schema/ckeditor5.schema.yml

File

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

  2. 

  3. editor.settings.ckeditor5:

  4.   type: mapping

  5.   label: 'CKEditor 5 settings'

  6.   mapping:

  7.     toolbar:

  8.       type: mapping

  9.       label: 'Toolbar configuration'

  10.       mapping:

  11.         items:

  12.           type: sequence

  13.           label: 'Items'

  14.           sequence:

  15.             type: ckeditor5.toolbar_item

  16.             label: 'Button'

  17.             constraints:

  18.               # Each active CKEditor 5 toolbar item whose plugin has conditions must have those conditions met.

  19.               CKEditor5ToolbarItemConditionsMet: []

  20.     plugins:

  21.       type: sequence

  22.       label: 'Plugins'

  23.       sequence:

  24.         type: ckeditor5.plugin.[%key]

  25.   constraints:

  26.     # Each enabled CKEditor 5 plugin that implements \Drupal\ckeditor5\Plugin\CKEditor5PluginConfigurableInterface

  27.     # must exist in here.

  28.     CKEditor5EnabledConfigurablePlugins: []

  29. 

  30. # Plugin \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Language

  31. ckeditor5.plugin.ckeditor5_language:

  32.   type: mapping

  33.   label: 'Language'

  34.   mapping:

  35.     language_list:

  36.       type: string

  37.       label: 'Language list ID'

  38.       constraints:

  39.         # Configuring this does not make sense without the corresponding button.

  40.         CKEditor5ToolbarItemDependencyConstraint:

  41.           toolbarItem: textPartLanguage

  42.         # Only two possible values are accepted.

  43.         Choice:

  44.           - un

  45.           - all

  46. 

  47. # Plugin \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Heading

  48. ckeditor5.plugin.ckeditor5_heading:

  49.   type: mapping

  50.   label: Headings

  51.   mapping:

  52.     enabled_headings:

  53.       type: sequence

  54.       label: 'Enabled Headings'

  55.       constraints:

  56.         NotBlank:

  57.           message: "Enable at least one heading, otherwise disable the Heading plugin."

  58.       sequence:

  59.         type: string

  60.         label: 'Heading type'

  61.         constraints:

  62.           Choice:

  63.             callback: \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Heading::validChoices

  64. 

  65. # Plugin \Drupal\ckeditor5\Plugin\CKEditor5Plugin\ImageResize

  66. ckeditor5.plugin.ckeditor5_imageResize:

  67.   type: mapping

  68.   label: Image Resize

  69.   mapping:

  70.     allow_resize:

  71.       type: boolean

  72.       label: 'Allow resize'

  73.       constraints:

  74.         NotNull: []

  75. 

  76. # Plugin \Drupal\ckeditor5\Plugin\CKEditor5Plugin\SourceEditing

  77. ckeditor5.plugin.ckeditor5_sourceEditing:

  78.   type: mapping

  79.   label: Source Editing

  80.   mapping:

  81.     allowed_tags:

  82.       type: sequence

  83.       label: 'Allowed Tags'

  84.       sequence:

  85.         type: ckeditor5.element

  86.         label: 'Allowed Tag'

  87.         constraints:

  88.           SourceEditingRedundantTags: []

  89.           SourceEditingPreventSelfXssConstraint: []

  90. 

  91. # Plugin \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Alignment

  92. ckeditor5.plugin.ckeditor5_alignment:

  93.   type: mapping

  94.   label: Alignments

  95.   mapping:

  96.     enabled_alignments:

  97.       type: sequence

  98.       label: 'Enabled Alignments'

  99.       constraints:

  100.         NotBlank:

  101.           message: "Enable at least one alignment, otherwise disable the Alignment button."

  102.       sequence:

  103.         type: string

  104.         label: 'Alignment type'

  105.         constraints:

  106.           Choice:

  107.             - left

  108.             - center

  109.             - right

  110.             - justify

  111. 

  112. # Plugin \Drupal\ckeditor5\Plugin\CKEditor5Plugin\ListPlugin

  113. ckeditor5.plugin.ckeditor5_list:

  114.   type: mapping

  115.   label: List

  116.   mapping:

  117.     reversed:

  118.       type: boolean

  119.       label: 'Allow reverse list'

  120.       constraints:

  121.         NotNull: []

  122.     startIndex:

  123.       type: boolean

  124.       label: 'Allow start index'

  125.       constraints:

  126.         NotNull: []

  127. 

  128. # Plugin \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Media

  129. ckeditor5.plugin.media_media:

  130.   type: mapping

  131.   label: Media

  132.   mapping:

  133.     allow_view_mode_override:

  134.       type: boolean

  135.       label: 'Allow view mode override'

  136.       constraints:

  137.         NotNull: []

  138. 

  139. # Plugin \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Style

  140. ckeditor5.plugin.ckeditor5_style:

  141.   type: mapping

  142.   label: Style

  143.   mapping:

  144.     styles:

  145.       type: sequence

  146.       label: 'Styles'

  147.       constraints:

  148.         NotBlank:

  149.           message: "Enable at least one style, otherwise disable the Style plugin."

  150.         UniqueLabelInList:

  151.           labelKey: label

  152.       sequence:

  153.         type: mapping

  154.         label: 'Style'

  155.         mapping:

  156.           label:

  157.             type: label

  158.             label: 'Style label'

  159.           element:

  160.             type: ckeditor5.element

  161.             constraints:

  162.               # Validate that this contains exactly 1 attribute (class) and >=1 class attr value.

  163.               CKEditor5Element:

  164.                 requiredAttributes:

  165.                   -

  166.                     attributeName: class

  167.                     minAttributeValueCount: 1

  168.               StyleSensibleElement: []

  169.             label: 'Style tag + classes'