You are here

Home » API reference » Easy Breadcrumb 2.x

easy_breadcrumb.schema.yml in Easy Breadcrumb 2.x

Same filename and directory in other branches
  1. 8 config/schema/easy_breadcrumb.schema.yml
config/schema/easy_breadcrumb.schema.yml

File

config/schema/easy_breadcrumb.schema.yml
View source 
  1. easy_breadcrumb.settings:

  2.   type: config_object

  3.   label: 'Easy Breadcrumb'

  4.   mapping:

  5.     applies_admin_routes:

  6.       type: boolean

  7.       label: 'Applies to administration pages'

  8.     include_invalid_paths:

  9.       type: boolean

  10.       label: 'Include invalid paths alias as plain-text segments'

  11.     excluded_paths:

  12.       type: text

  13.       label: 'Paths to be excluded while generating segments'

  14.     replaced_titles:

  15.       type: text

  16.       label: 'Titles to be replaced with synonyms'

  17.     custom_paths:

  18.       type: text

  19.       label: 'Paths requiring custom breadcrumbs'

  20.     include_home_segment:

  21.       type: boolean

  22.       label: 'Include the front page as a segment in the breadcrumb'

  23.     alternative_title_field:

  24.       type: label

  25.       label: 'Alternative title field for the breadcrumb'

  26.       translatable: true

  27.     home_segment_title:

  28.       type: label

  29.       label: 'Title for the front page segment in the breadcrumb'

  30.       translatable: true

  31.     home_segment_keep:

  32.       type: boolean

  33.       label: 'Display the front page segment on the front page'

  34.     include_title_segment:

  35.       type: boolean

  36.       label: 'Include the current page as a segment in the breadcrumb'

  37.     title_from_page_when_available:

  38.       type: boolean

  39.       label: 'Use the real page title when available'

  40.     title_segment_as_link:

  41.       type: boolean

  42.       label: 'Make the page title segment a link'

  43.     segments_separator:

  44.       type: text

  45.       label: 'Segments Separator'

  46.     use_menu_title_as_fallback:

  47.       type: boolean

  48.       label: 'Use menu title as fallback instead of raw path component'

  49.     use_page_title_as_menu_title_fallback:

  50.       type: boolean

  51.       label: 'Use the page title as a fallback if the menu title is not set'

  52.     remove_repeated_segments:

  53.       type: boolean

  54.       label: 'Remove repeated identical segments'

  55.     language_path_prefix_as_segment:

  56.       type: boolean

  57.       label: 'Use language path prefix as segment'

  58.     absolute_paths:

  59.       type: boolean

  60.       label: 'Use absolute path for Breadcrumb links'

  61.     hide_single_home_item:

  62.       type: boolean

  63.       label: 'Hide the breadcrumb when it only links to the home page and nothing more'

  64.     term_hierarchy:

  65.       type: boolean

  66.       label: 'Use term hierarchy'

  67.     use_site_title:

  68.       type: boolean

  69.       label: 'Use site title for the front page segment in the breadcrumb'

  70.     add_structured_data_json_ld:

  71.       type: boolean

  72.       label: 'Add current breadcrumb as structured data in JSON-LD to the HTML head'

  73.     capitalizator_mode:

  74.       type: string

  75.       label: 'Transformation mode for the segments titles'

  76.     capitalizator_ignored_words:

  77.       type: sequence

  78.       label: 'Words to be ignored by the capitalizator'

  79.       sequence:

  80.         type: text

  81.         label: 'Ignored word'

  82.     capitalizator_forced_words:

  83.       type: sequence

  84.       label: 'Words to be forced to capitalized by the capitalizator'

  85.       sequence:

  86.         type: text

  87.         label: 'Forced word'

  88.     capitalizator_forced_words_case_sensitivity:

  89.       type: boolean

  90.       label: 'Use case sensitivity when matching words to be forced to capitalization.'

  91.     capitalizator_forced_words_first_letter:

  92.       type: boolean

  93.       label: 'Make the first letters of each segment capitalized.'

  94.     follow_redirects:

  95.       type: boolean

  96.       label: 'Follow redirects if the redirect module is enabled.'

  97.     limit_segment_display:

  98.       type: boolean

  99.       label: 'Limit breadcrumb trail segments'

  100.     segment_display_limit:

  101.       type: number

  102.       label: 'Breadcrumb segment count'

  103.     truncator_mode:

  104.       type: boolean

  105.       label: 'Enable truncation for titles.'

  106.     truncator_length:

  107.       type: integer

  108.       label: 'Set the limit for truncation.'

  109.     truncator_dots:

  110.       type: boolean

  111.       label: 'Enable dots at the end of truncation.'