statikbe / craft-cookie-banner
cookie横幅和模态窗口包
5.0.0
2024-05-28 17:37 UTC
Requires
- craftcms/cms: ^5.0.0
- jaybizzle/crawler-detect: ^1.2
Requires (Dev)
- craftcms/ecs: dev-main
- craftcms/phpstan: dev-main
This package is auto-updated.
Last update: 2024-09-10 08:58:36 UTC
README
这是一个Statik.be的内部插件,用于与我们的标签管理器同意管理解决方案一起使用。
⚠️该插件仅会根据模板渲染,如果未进行适当配置,则不会做任何防止跟踪的操作。
要求
此插件需要Craft CMS 3.0.0或更高版本。
安装
要安装插件,请按照以下说明操作
cd /path/to/project composer require statikbe/craft-cookie-banner ./craft plugin/install cookie-banner
使用方法
插件使用Twig函数来渲染初始弹出窗口和cookie设置模态窗口。
{{ craft.cookieBanner.render() }}
您还可以传递一个选项数组
- modal:模态窗口模板的路径
- banner:横幅模板的路径
- overlay:将用作横幅背后覆盖层的带有样式的HTML字符串
- supportIE:是否应编译用于ES6或ES5的JavaScript(默认为false,因此使用ES6)
- cookiePage:定义cookie政策内容的条目。这用于模态窗口模板以显示可能的设置。
例如
{{ craft.cookieBanner.render({ modal: '_site/_snippet/_cookie/_modal', banner: '_site/_snippet/_cookie/_banner', overlay: '<div class="fixed inset-0 hidden bg-black opacity-80 z-99" id="cookiebanner-overlay"></div>', supportIE: true, cookiePage: craft.entries.section('cookiePolicy').one(), showCookieBanner: (entry.type is defined and entry.type.handle != 'cookiePolicy') }) }}
建议不要仅为了样式而覆盖模板,仅用于更基本的结构性更改。
模态窗口、横幅 和 覆盖层 模板具有通用的类,可用于样式设计。
要在关闭cookie横幅后触发设置模态窗口,您可以使用以下代码
<a href="#" class="js-cookie-settings" role="button">{{ 'Cookie settings'|t }}</a>
监听器
您可以监听以下事件
cookie-banner-opened
cookie-closed
cookie-modal-opened
cookie-prop-performance-disabled
cookie-prop-performance-enabled
cookie-prop-marketing-disabled
cookie-prop-marketing-enabled
示例
window.addEventListener('cookie-closed', () => { console.log('cookie-closed'); });