www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/eu_cookie_compliance/config/schema/eu_cookie_compliance.schema.yml

   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     popup_enabled:
   8       type: boolean
   9       label: 'Enable banner'
  10     popup_clicking_confirmation:
  11       type: boolean
  12       label: 'Consent by clicking'
  13     popup_scrolling_confirmation:
  14       type: boolean
  15       label: 'Consent by scrolling'
  16     eu_only:
  17       type: boolean
  18       label: 'Only display banner in EU countries.'
  19     eu_only_js:
  20       type: boolean
  21       label: 'Only display banner in EU countries (Javascript based).'
  22     popup_position:
  23       type: boolean
  24       label: 'Place the banner at the top of the website'
  25     fixed_top_position:
  26       type: boolean
  27       label: "If the banner is at the top, don't scroll the banner with the page."
  28     popup_info:
  29       type: mapping
  30       label: 'Cookie information banner message'
  31       mapping:
  32         value:
  33           type: text
  34           label: 'Cookie information banner message - Value'
  35         format:
  36           type: string
  37           label: 'Cookie information banner message - Format'
  38     mobile_popup_info:
  39       type: mapping
  40       label: 'Cookie information banner message - mobile'
  41       mapping:
  42         value:
  43           type: text
  44           label: 'Cookie information banner message - mobile - Value'
  45         format:
  46           type: string
  47           label: 'Cookie information banner message - mobile - Format'
  48     popup_agree_button_message:
  49       type: label
  50       label: 'Agree button message'
  51     popup_disagree_button_message:
  52       type: label
  53       label: 'Cookie Policy button message'
  54     mobile_breakpoint:
  55       type: integer
  56       label: 'Mobile breakpoint'
  57     popup_agreed_enabled:
  58       type: boolean
  59       label: 'Enable "Thank you" banner.'
  60     popup_hide_agreed:
  61       type: boolean
  62       label: 'Clicking hides "Thank you" banner.'
  63     disagree_button_label:
  64       type: label
  65       label: 'Disagree button label'
  66     popup_agreed:
  67       type: mapping
  68       label: 'Thank you banner message'
  69       mapping:
  70         value:
  71           type: text
  72           label: 'Thank you banner message - Value'
  73         format:
  74           type: string
  75           label: 'Thank you banner message - Format'
  76     popup_find_more_button_message:
  77       type: label
  78       label: 'More info button label'
  79     popup_hide_button_message:
  80       type: label
  81       label: 'Hide button label'
  82     popup_link:
  83       type: label
  84       label: 'Privacy policy link'
  85     popup_link_new_window:
  86       type: boolean
  87       label: 'Open privacy policy link in a new window.'
  88     popup_height:
  89       type: integer
  90       label: 'Banner height in pixels'
  91     popup_width:
  92       type: string
  93       label: 'Banner width in pixels or a percentage value'
  94     popup_delay:
  95       type: integer
  96       label: 'Banner sliding animation time in milliseconds'
  97     show_disagree_button:
  98       type: boolean
  99       label: 'Show "Cookie Policy" and "More info" buttons'
 100     popup_bg_hex:
 101       type: string
 102       label: 'Background color'
 103     popup_text_hex:
 104       type: string
 105       label: 'Text color'
 106     domain:
 107       type: string
 108       label: 'Domain'
 109     domains_option:
 110       type: integer
 111       label: 'Add/Remove banner on specified domains'
 112     domains_list:
 113       type: string
 114       label: 'Domains list'
 115     exclude_paths:
 116       type: string
 117       label: 'Exclude paths'
 118     exclude_admin_theme:
 119       type: boolean
 120       label: 'Exclude admin pages.'
 121     cookie_session:
 122       type: integer
 123       label: 'Cookie session'
 124     cookie_lifetime:
 125       type: integer
 126       label: 'Cookie lifetime'
 127     use_mobile_message:
 128       type: boolean
 129       label: 'Use a different message for mobile phones'
 130     use_bare_css:
 131       type: boolean
 132       label: 'Include minimal CSS, I want to style the overlay in the theme CSS'
 133     disagree_do_not_show_popup:
 134       type: boolean
 135       label: 'Do not show cookie policy when the user clicks the "Cookie Policy" button.'
 136     reload_page:
 137       type: boolean
 138       label: 'Reload page after user clicks the "Agree" button.'
 139     cookie_name:
 140       type: string
 141       label: 'Cookie name'
 142     exclude_uid_1:
 143       type: boolean
 144       label: "Don't show the banner for UID 1."
 145     better_support_for_screen_readers:
 146       type: boolean
 147       label: 'Let screen readers see the banner before other links on the page'
 148     method:
 149       type: string
 150       label: 'Consent method'
 151     disabled_javascripts:
 152       type: string
 153       label: 'Disable JavaScripts'
 154     whitelisted_cookies:
 155       type: string
 156       label: 'Whitelisted cookies'
 157     consent_storage_method:
 158       type: string
 159       label: 'Consent storage method'
 160     withdraw_message:
 161       type: mapping
 162       label: 'Withdraw consent banner message'
 163       mapping:
 164         value:
 165           type: text
 166           label: 'Withdraw consent banner message - Value'
 167         format:
 168           type: string
 169           label: 'Withdraw consent banner message - Format'
 170     withdraw_tab_button_label:
 171       type: label
 172       label: 'Privacy settings tab label'
 173     withdraw_action_button_label:
 174       type: label
 175       label: 'Withdraw consent action button label'
 176     withdraw_enabled:
 177       type: boolean
 178       label: 'Enable floating privacy settings tab and withdraw consent banner'