You are here

Home » API reference » FAQ Field 2.0.x

faqfield.schema.yml in FAQ Field 2.0.x

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

File

config/schema/faqfield.schema.yml
View source 
  1. # Schema for the configuration files of the FAQ Field module.

  2. 

  3. # FieldFormatter: jQuery Accordion

  4. field.formatter.settings.faqfield_accordion:

  5.   type: mapping

  6.   label: 'FAQ Field jQuery Accordion format settings'

  7.   mapping:

  8.     active:

  9.       type: integer

  10.       label: 'Index of active element starting from 0. Leave empty to display none at start.'

  11.     heightStyle:

  12.       type: string

  13.       label: 'Controls the height of the accordion and each panel.'

  14.     collapsible:

  15.       type: boolean

  16.       label: 'Whether an opened question can be collapsed (by the triggering event).'

  17.     event:

  18.       type: string

  19.       label: 'Event on which to trigger the accordion.'

  20.     animate:

  21.       type: mapping

  22.       label: 'Animation options for the accordion formatter.'

  23.       mapping:

  24.         easing:

  25.           type: string

  26.           label: 'Name of easing to use when the event is triggered.'

  27.         duration:

  28.           type: integer

  29.           label: 'Animation duration in milliseconds with the selected easing.'

  30. 

  31. # FieldFormatter: HTML anchor list

  32. field.formatter.settings.faqfield_anchor_list:

  33.   type: mapping

  34.   label: 'FAQ Field HTML anchor list format settings'

  35.   mapping:

  36.     anchor_list_type:

  37.       type: string

  38.       label: 'The type of HTML list used for the anchor link list.'

  39. 

  40. # FieldWidget: Default widget.

  41. field.widget.settings.faqfield_default:

  42.   type: mapping

  43.   label: 'FAQ Field default widget settings'

  44.   mapping:

  45.     answer_widget:

  46.       type: string

  47.       label: 'What form widget to use for answer input.'

  48.     question_title:

  49.       type: string

  50.       label: 'Custom title of question input.'

  51.       translatable: true

  52.       translation context: 'Custom title of FAQ Field question widget.'

  53.     answer_title:

  54.       type: string

  55.       label: 'Custom title of answer input.'

  56.       translatable: true

  57.       translation context: 'Custom title of FAQ Field answer widget.'

  58.     question_field_required:

  59.       type: boolean

  60.       label: 'Question field is required.'

  61.     answer_field_required:

  62.       type: boolean

  63.       label: 'Answer field is required.'

  64.     advanced:

  65.       type: mapping

  66.       label: 'Advanced options of the FAQ Field default widget.'

  67.       mapping:

  68.         question_length:

  69.           type: integer

  70.           label: 'Maximum length of questions.'

  71.         question_size:

  72.           type: integer

  73.           label: 'Size the question widget.'

  74.         question_rows:

  75.           type: integer

  76.           label: 'Number of rows used for the question widget.'

  77.         answer_rows:

  78.           type: integer

  79.           label: 'Number of rows used for the answer widget.'

  80. 

  81. # FieldType: FAQ Field.

  82. field.field_settings.faqfield:

  83.   type: mapping

  84.   label: 'FAQ Field field settings'

  85.   mapping:

  86.     default_format:

  87.       type: string

  88.       label: 'Default text format'