You are here

Home » API reference » Better Exposed Filters 8.3

better_exposed_filters.exposed_form.schema.yml in Better Exposed Filters 8.3

Same filename and directory in other branches
  1. 8.5 config/schema/better_exposed_filters.exposed_form.schema.yml
  2. 8.4 config/schema/better_exposed_filters.exposed_form.schema.yml
config/schema/better_exposed_filters.exposed_form.schema.yml

File

config/schema/better_exposed_filters.exposed_form.schema.yml
View source 
  1. # BEF general settings

  2. better_exposed_filters.general:

  3.   label: 'General BEF settings'

  4.   type: mapping

  5.   mapping:

  6.     allow_secondary:

  7.       type: boolean

  8.       label: 'Enable secondary exposed form options'

  9.     secondary_label:

  10.       type: label

  11.       label: 'Secondary options label'

  12.     autosubmit:

  13.       type: boolean

  14.       label: 'Autosubmit'

  15.     autosubmit_exclude_textfield:

  16.       type: boolean

  17.       label: 'Exclude Textfield'

  18.     autosubmit_textfield_delay:

  19.       type: integer

  20.       label: 'Delay for textfield autosubmit'

  21.     autosubmit_hide:

  22.       type: boolean

  23.       label: 'Hide submit button'

  24. 

  25. # BEF exposed sort settings

  26. better_exposed_filters.sort:

  27.   type: mapping

  28.   label: 'Exposed sort BEF settings'

  29.   mapping:

  30.     bef_format:

  31.       type: string

  32.       label: 'Display exposed sort options as'

  33.     advanced:

  34.       type: mapping

  35.       mapping:

  36.         collapsible:

  37.           type: boolean

  38.           label: 'Make sort options collapsible'

  39.         collapsible_label:

  40.           type: label

  41.           label: 'Collapsible details element title'

  42.         combine:

  43.           type: boolean

  44.           label: 'Combine sort order with sort by'

  45.         combine_rewrite:

  46.           type: text

  47.           label: 'Rewrite combined sort options'

  48.         reset:

  49.           type: boolean

  50.           label: 'Include reset sort option'

  51.         reset_label:

  52.           type: label

  53.           label: 'Reset sort label'

  54.         is_secondary:

  55.           type: boolean

  56.           label: 'Sort is a secondary option'

  57. 

  58. # BEF exposed filter settings

  59. better_exposed_filters.*:

  60.   label: 'BEF filter settings'

  61.   type: mapping

  62.   mapping:

  63.     bef_format:

  64.       type: string

  65.       label: 'Display exposed filter as'

  66.     more_options:

  67.       label: 'More options'

  68.       type: mapping

  69.       mapping:

  70.         placeholder_text:

  71.           type: text

  72.           label: 'Placeholder text for text fields'

  73.         bef_select_all_none:

  74.           type: boolean

  75.           label: 'Add select all/none links'

  76.         bef_select_all_none_nested:

  77.           type: boolean

  78.           label: 'Add select all/none links for heirarchical filters'

  79.         bef_collapsible:

  80.           type: boolean

  81.           label: 'Place filter in a collapsible HTML element'

  82.         is_secondary:

  83.           type: boolean

  84.           label: 'This filter is a secondary option'

  85.         rewrite:

  86.           type: mapping

  87.           label: 'Rewrite filter options'

  88.           mapping:

  89.             filter_rewrite_values:

  90.               type: text

  91.               label: 'Rewrite filter option'

  92.     slider_options:

  93.       label: 'Slider options'

  94.       type: mapping

  95.       mapping:

  96.         bef_slider_min:

  97.           type: float

  98.           label: 'Silder min option'

  99.           translatable: true

  100.         bef_slider_max:

  101.           type: float

  102.           label: 'Silder max option'

  103.           translatable: true

  104.         bef_slider_step:

  105.           type: float

  106.           label: 'Silder step option'

  107.           translatable: true

  108.         bef_slider_animate:

  109.           type: string

  110.           label: 'Silder animate option'

  111.           translatable: true

  112.         bef_slider_orientation:

  113.           type: string

  114.           label: 'Silder orientation'

  115.           translatable: true

  116. 

  117. # Schema for the Better Exposed Filters configuration files.

  118. views.exposed_form.bef:

  119.   type: views_exposed_form

  120.   label: 'Better Exposed Filters'

  121.   mapping:

  122.     input_required:

  123.       type: boolean

  124.       label: 'Input required before showing results'

  125.     text_input_required:

  126.       type: text

  127.       label: 'Text shown if a filter option has not been selected'

  128.     text_input_required_format:

  129.       type: text

  130.       label: 'Text format for the text_input_required field'

  131.     bef:

  132.       type: sequence

  133.       label: 'BEF Settings'

  134.       sequence:

  135.         type: better_exposed_filters.[%key]