You are here

Home » API reference » EU Cookie Compliance (GDPR Compliance) 8

eu_cookie_compliance.schema.yml in EU Cookie Compliance (GDPR Compliance) 8

Same filename and directory in other branches
  1. 2.0.x config/schema/eu_cookie_compliance.schema.yml
config/schema/eu_cookie_compliance.schema.yml

File

config/schema/eu_cookie_compliance.schema.yml
View source 
  1. # Schema for the configuration files of the EU Cookie Compliance.

  2. 

  3. eu_cookie_compliance.settings:

  4.   type: config_object

  5.   label: 'EU Cookie Compliance Settings'

  6.   mapping:

  7.     uuid:

  8.       type: uuid

  9.       label: 'UUID'

  10.     popup_enabled:

  11.       type: boolean

  12.       label: 'Enable banner'

  13.     popup_clicking_confirmation:

  14.       type: boolean

  15.       label: 'Consent by clicking'

  16.     popup_scrolling_confirmation:

  17.       type: boolean

  18.       label: 'Consent by scrolling'

  19.     eu_only:

  20.       type: boolean

  21.       label: 'Only display banner in EU countries.'

  22.     eu_only_js:

  23.       type: boolean

  24.       label: 'Only display banner in EU countries (Javascript based).'

  25.     popup_position:

  26.       type: boolean

  27.       label: 'Place the banner at the top of the website'

  28.     fixed_top_position:

  29.       type: boolean

  30.       label: "If the banner is at the top, don't scroll the banner with the page."

  31.     popup_info:

  32.       type: mapping

  33.       label: 'Cookie information banner message'

  34.       mapping:

  35.         value:

  36.           type: text

  37.           label: 'Cookie information banner message - Value'

  38.         format:

  39.           type: string

  40.           label: 'Cookie information banner message - Format'

  41.     mobile_popup_info:

  42.       type: mapping

  43.       label: 'Cookie information banner message - mobile'

  44.       mapping:

  45.         value:

  46.           type: text

  47.           label: 'Cookie information banner message - mobile - Value'

  48.         format:

  49.           type: string

  50.           label: 'Cookie information banner message - mobile - Format'

  51.     popup_info_template:

  52.       type: string

  53.       label: 'Template to use for "consent by default" method'

  54.     popup_agree_button_message:

  55.       type: label

  56.       label: 'Agree button message'

  57.     popup_more_info_button_message:

  58.       type: label

  59.       label: 'Cookie Policy button message'

  60.     mobile_breakpoint:

  61.       type: integer

  62.       label: 'Mobile breakpoint'

  63.     popup_agreed_enabled:

  64.       type: boolean

  65.       label: 'Enable "Thank you" banner.'

  66.     popup_hide_agreed:

  67.       type: boolean

  68.       label: 'Clicking hides "Thank you" banner.'

  69.     disagree_button_label:

  70.       type: label

  71.       label: 'Disagree button label'

  72.     popup_agreed:

  73.       type: mapping

  74.       label: 'Thank you banner message'

  75.       mapping:

  76.         value:

  77.           type: text

  78.           label: 'Thank you banner message - Value'

  79.         format:

  80.           type: string

  81.           label: 'Thank you banner message - Format'

  82.     popup_find_more_button_message:

  83.       type: label

  84.       label: 'More info button label'

  85.     popup_hide_button_message:

  86.       type: label

  87.       label: 'Hide button label'

  88.     popup_link:

  89.       type: label

  90.       label: 'Privacy policy link'

  91.     popup_link_new_window:

  92.       type: boolean

  93.       label: 'Open privacy policy link in a new window.'

  94.     popup_height:

  95.       type: integer

  96.       label: 'Banner height in pixels'

  97.     popup_width:

  98.       type: string

  99.       label: 'Banner width in pixels or a percentage value'

  100.     popup_delay:

  101.       type: integer

  102.       label: 'Banner sliding animation time in milliseconds'

  103.     show_more_info:

  104.       type: boolean

  105.       label: 'Show "Cookie Policy" and "More info" buttons'

  106.     popup_bg_hex:

  107.       type: string

  108.       label: 'Background color'

  109.     popup_text_hex:

  110.       type: string

  111.       label: 'Text color'

  112.     domain:

  113.       type: string

  114.       label: 'Domain'

  115.     domains_option:

  116.       type: integer

  117.       label: 'Add/Remove banner on specified domains'

  118.     domains_list:

  119.       type: string

  120.       label: 'Domains list'

  121.     exclude_paths:

  122.       type: string

  123.       label: 'Exclude paths'

  124.     exclude_admin_theme:

  125.       type: boolean

  126.       label: 'Exclude admin pages.'

  127.     cookie_session:

  128.       type: integer

  129.       label: 'Cookie session'

  130.     set_cookie_session_zero_on_disagree:

  131.       type: integer

  132.       label: 'Disagree set cookie session'

  133.     cookie_lifetime:

  134.       type: integer

  135.       label: 'Cookie lifetime'

  136.     use_mobile_message:

  137.       type: boolean

  138.       label: 'Use a different message for mobile phones'

  139.     use_bare_css:

  140.       type: boolean

  141.       label: 'Include minimal CSS, I want to style the overlay in the theme CSS'

  142.     disagree_do_not_show_popup:

  143.       type: boolean

  144.       label: 'Do not show cookie policy when the user clicks the "Cookie Policy" button.'

  145.     reload_page:

  146.       type: boolean

  147.       label: 'Reload page after user clicks the "Agree" button.'

  148.     reload_options:

  149.       type: integer

  150.       label: 'Include/exclude specified routes for reloading'

  151.     reload_routes_list:

  152.       type: string

  153.       label: 'Routes list'

  154.     cookie_name:

  155.       type: string

  156.       label: 'Cookie name'

  157.     exclude_uid_1:

  158.       type: boolean

  159.       label: "Don't show the banner for UID 1."

  160.     better_support_for_screen_readers:

  161.       type: boolean

  162.       label: 'Let screen readers see the banner before other links on the page'

  163.     method:

  164.       type: string

  165.       label: 'Consent method'

  166.     disabled_javascripts:

  167.       type: string

  168.       label: 'Disable JavaScripts'

  169.     automatic_cookies_removal:

  170.       type: boolean

  171.       label: 'Enable cookie(s) automatic-removal when consent is not explicitly given'

  172.     allowed_cookies:

  173.       type: string

  174.       label: 'Allowed cookies'

  175.     consent_storage_method:

  176.       type: string

  177.       label: 'Consent storage method'

  178.     withdraw_message:

  179.       type: mapping

  180.       label: 'Withdraw consent banner message'

  181.       mapping:

  182.         value:

  183.           type: text

  184.           label: 'Withdraw consent banner message - Value'

  185.         format:

  186.           type: string

  187.           label: 'Withdraw consent banner message - Format'

  188.     withdraw_tab_button_label:

  189.       type: label

  190.       label: 'Privacy settings tab label'

  191.     withdraw_action_button_label:

  192.       type: label

  193.       label: 'Withdraw consent action button label'

  194.     withdraw_enabled:

  195.       type: boolean

  196.       label: 'Enable floating privacy settings tab and withdraw consent banner'

  197.     withdraw_button_on_info_popup:

  198.       type: boolean

  199.       label: 'Put the withdraw consent action button on the cookie information banner'

  200.     save_preferences_button_label:

  201.       type: label

  202.       label: 'Save preferences action button label'

  203.     accept_all_categories_button_label:

  204.       type: label

  205.       label: 'Accept all categories action button label'

  206.     enable_save_preferences_button:

  207.       type: boolean

  208.       label: 'Replace the Agree button by a Save preferences and an Accept all categories button'

  209.     domain_all_sites:

  210.       type: boolean

  211.       label: 'Allow the cookie to be set for all sites on the same domain'

  212.     settings_tab_enabled:

  213.       type: boolean

  214.       label: 'Enable floating privacy settings permanently'

  215.     containing_element:

  216.       type: string

  217.       label: 'Containing element'

  218.     cookie_policy_version:

  219.       type: string

  220.       label: 'Cookie Policy Version'

  221.     cookie_value_disagreed:

  222.       type: string

  223.       label: 'Cookie value (disagreed)'

  224.     cookie_value_agreed_show_thank_you:

  225.       type: string

  226.       label: 'Cookie value (agreed, show thank you banner)'

  227.     cookie_value_agreed:

  228.       type: string

  229.       label: 'Cookie value (agreed)'

  230.     accessibility_focus:

  231.       type: boolean

  232.       label: 'Buttons have red focus outline (for accessibility)'