blueprints.yaml

name: Cookie Consent
version: 0.5.1
description: This grav plugin is to alert users about the use of cookies on your website. The plugin integrates the popular js lib cookie consent by insites.
icon: gavel
author:
  name: naucon
homepage: https://github.com/naucon/grav-plugin-cookieconsent
keywords: grav, plugin, cookie, consent, eu, law, policy, insites
bugs: https://github.com/naucon/grav-plugin-cookieconsent/issues
docs: https://github.com/naucon/grav-plugin-cookieconsent/blob/master/README.md
license: MIT

form:
  validation: strict
  fields:
    basics:
      type: section
      title: Basics
      underline: true

    enabled:
      type: toggle
      label: Plugin status
      highlight: 1
      default: 0
      options:
        1: Enabled
        0: Disabled
      validate:
        type: bool

    cdn:
      type: toggle
      label: CDN
      help: "Include JavaScript and CSS files from official CDN or local."
      highlight: 1
      default: 1
      options:
        1: Enabled
        0: Disabled
      validate:
        type: bool

    content:
      type: section
      title: Content
      underline: true

    content_message:
      type: text
      label: Message
      help: Message on the banner
      placeholder: "This website uses cookies to ensure you get the best experience on our website."
      validate:
        type: text

    content_dismiss:
      type: text
      label: Dismiss button text
      placeholder: "Got it!"
      validate:
        type: text

    content_link:
      type: text
      label: Policy link text
      placeholder: "Learn more"
      validate:
        type: text

    content_href:
      type: text
      label: Link to policy
      placeholder: "https://cookiesandyou.com"
      validate:
        type: text


    colors:
      type: section
      title: Colors
      underline: true

    popup_background_color:
      type: colorpicker
      label: Banner background
      help: Color of banner background
      default: #000000
      validate:
        type: text

    popup_text_color:
      type: colorpicker
      label: Banner Text
      help: Color of banner text
      default: #ffffff
      validate:
        type: text

    button_background_color:
      type: colorpicker
      label: Button background
      help: Color of button background
      default: #f1d600
      validate:
        type: text

    button_text_color:
      type: colorpicker
      label: Button text
      help: Color of button text
      default: #000000
      validate:
        type: text

    button_border_color:
      type: colorpicker
      label: Button border
      help: Color of button border
      default: #f1d600
      validate:
        type: text


    style:
      type: section
      title: Position & Style
      underline: true

    position:
      type: select
      size: medium
      label: Position
      default: bottom
      help: Position on the website, where the banner will be displayed.
      options:
        top: Top
        top-pushdown: Top (Pushdown)
        bottom: Bottom
        bottom-left: Bottom Left
        bottom-right: Bottom Right

    theme:
      type: select
      size: medium
      label: Layout
      default: block
      help: Button layout
      options:
        block: Block (angled corners)
        classic: Classic (round corners)
        edgeless: Edgeless


    optin:
      type: section
      title: Disabling cookies
      underline: true

    compliance_type:
      type: select
      size: medium
      label: Compliance Type
      default: info
      help: Just inform users about cookies or Let them deny or allow cookies
      options:
        info: 'Info: text with dismiss button'
        opt-in: 'Opt-in: text with deny/allow buttons'

    content_allow:
      type: text
      label: Allow button text
      placeholder: "Allow Cookies"
      validate:
        type: text

    content_deny:
      type: text
      label: Deny button text
      placeholder: "Deny Cookies"
      validate:
        type: text

    content_revoke:
      type: text
      label: Change consent button text
      placeholder: "Change Cookie Consent"
      validate:
        type: text

    show_revoke:
      type: toggle
      label: Show consent button
      highlight: 1
      default: 1
      options:
        1: Show
        0: Hide
      validate:
        type: bool

    callback_onStatusChange:
      type: textarea
      label: 'function to disable or enable cookies on your site<br>(used for opt-in)'
      rows: 6
      placeholder: "function(status, chosenBefore) {\n...\n}"
      validate:
        type: textarea

    callback_hint1:
      type: display
      size: large
      label: Callback-Example, logs to console only
      markdown: true
      content: "function(status) {<br>&nbsp; console.log( this.hasConsented() ? 'enable cookies': 'disable cookies' );<br>}"

    callback_hint2:
      type: display
      size: large
      label: Callback-Example, reloads the page on consent
      markdown: true
      content: "function(status) {<br>&nbsp; if(this.hasConsented()) location.replace(location);<br>}"