You are here

Home » API reference » Search API Autocomplete 8

search_api_autocomplete.schema.yml in Search API Autocomplete 8

config/schema/search_api_autocomplete.schema.yml

File

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

  2.   type: config_object

  3.   label: 'Search API Autocomplete settings'

  4.   mapping:

  5.     enable_custom_scripts:

  6.       type: boolean

  7.       label: 'Enable the use of custom scripts as autocomplete callbacks'

  8. 

  9. search_api_autocomplete.search.*:

  10.   type: config_entity

  11.   label: 'Autocomplete search'

  12.   mapping:

  13.     id:

  14.       type: string

  15.       label: 'ID'

  16.     label:

  17.       type: string

  18.       label: 'Label'

  19.     index_id:

  20.       type: string

  21.       label: 'Index ID'

  22.     suggester_settings:

  23.       type: sequence

  24.       label: 'Suggester settings'

  25.       sequence:

  26.         type: plugin.plugin_configuration.search_api_autocomplete_suggester.[%key]

  27.         label: 'The configuration for a single suggester'

  28.     suggester_weights:

  29.       type: sequence

  30.       label: 'Suggester weights'

  31.       sequence:

  32.         type: integer

  33.         label: 'The weight for a single suggester'

  34.     suggester_limits:

  35.       type: sequence

  36.       label: 'Suggester limits'

  37.       sequence:

  38.         type: integer

  39.         label: 'The limit for a single suggester'

  40.     search_settings:

  41.       type: sequence

  42.       label: 'Search plugin settings'

  43.       sequence:

  44.         type: plugin.plugin_configuration.search_api_autocomplete_search.[%key]

  45.         label: 'The configuration for the search entity''s search plugin'

  46.     options:

  47.       type: mapping

  48.       label: 'Options'

  49.       mapping:

  50.         limit:

  51.           type: integer

  52.           label: 'Maximum number of suggestions'

  53.         min_length:

  54.           type: integer

  55.           label: 'The minimum length of user input to trigger autocomplete'

  56.         show_count:

  57.           type: boolean

  58.           label: 'Whether to show a predicted result count for suggestions'

  59.         delay:

  60.           type: integer

  61.           label: 'The delay for triggering autocomplete after the user stopped typing'

  62.         submit_button_selector:

  63.           type: string

  64.           label: 'A jQuery selector for finding the submit button in the search form'

  65.         autosubmit:

  66.           type: boolean

  67.           label: 'Whether to automatically submit the search form when a suggestion is selected'

  68. 

  69. plugin.plugin_configuration.search_api_autocomplete_suggester.*:

  70.   type: mapping

  71. 

  72. plugin.plugin_configuration.search_api_autocomplete_suggester.custom_script:

  73.   type: mapping

  74.   mapping:

  75.     path:

  76.       type: string

  77.       label: 'The path or URI of the custom autocomplete script'

  78. 

  79. plugin.plugin_configuration.search_api_autocomplete_suggester.server:

  80.   type: mapping

  81.   mapping:

  82.     fields:

  83.       type: sequence

  84.       label: 'The fields to use for autocompletion'

  85.       sequence:

  86.         type: string

  87. 

  88. plugin.plugin_configuration.search_api_autocomplete_suggester.live_results:

  89.   type: mapping

  90.   mapping:

  91.     fields:

  92.       type: sequence

  93.       label: 'The fields to use for searching'

  94.       sequence:

  95.         type: string

  96.     highlight:

  97.       type: mapping

  98.       mapping:

  99.         enabled:

  100.           type: boolean

  101.           label: 'Whether to replace live results with a highlighted field'

  102.         field:

  103.           type: string

  104.           label: 'The field to replace the live result'

  105.     view_modes:

  106.       type: sequence

  107.       label: 'The view modes to use for displaying results'

  108.       sequence:

  109.         type: sequence

  110.         label: 'The view modes to use for displaying results of a certain type'

  111.         sequence:

  112.           type: string

  113.           label: 'The view mode to use for displaying results of a certain bundle'

  114. 

  115. plugin.plugin_configuration.search_api_autocomplete_search.*:

  116.   type: mapping

  117. 

  118. plugin.plugin_configuration.search_api_autocomplete_search.views:*:

  119.   type: mapping

  120.   mapping:

  121.     displays:

  122.       type: mapping

  123.       label: 'Displays'

  124.       mapping:

  125.         default:

  126.           type: boolean

  127.           label: 'Whether to exclude (TRUE) or include (FALSE) the selected Views displays.'

  128.         selected:

  129.           type: sequence

  130.           label: 'The selected Views displays'

  131.           sequence:

  132.             type: string

  133.             label: 'A Views display machine name'