Yii2基于yii2-bootstrap4如何通过SASS实现明暗模式切换开关
Yii2 基于Bootstrap4实现明暗模式切换的落地步骤
前置调整:替换原有预编译Bootstrap样式为SASS定制产物
当前默认配置是直接加载yii2-bootstrap4扩展自带的预编译CSS文件,无法直接注入明暗模式的动态样式规则,因此需要先搭建自定义SASS编译流程:
- 现有composer.json中已经安装的yii2-bootstrap4版本自带完整的Bootstrap4 SASS源文件,无需额外引入第三方资源包
- 在项目web目录下新建SASS工作目录,例如
web/sass/ - 创建SASS入口文件
web/sass/bootstrap-custom.scss,文件内首先引入yii2-bootstrap4扩展内置的Bootstrap4核心SASS源,路径对应vendor目录下的扩展资源路径 - 在入口文件中定义全局明暗模式的CSS自定义属性:
// 亮模式默认全局变量 :root { --bs-body-bg: #ffffff; --bs-body-color: #212529; --bs-card-bg: #ffffff; --bs-border-color: #dee2e6; --bs-nav-bg: #f8f9fa; --bs-btn-outline-color: #6c757d; } // 暗模式全局变量覆盖 [data-theme="dark"] { --bs-body-bg: #121212; --bs-body-color: #f8f9fa; --bs-card-bg: #1e1e1e; --bs-border-color: #343a40; --bs-nav-bg: #212529; --bs-btn-outline-color: #adb5bd; } - 编写组件样式覆盖规则,将所有原本硬编码的颜色值替换为对上述自定义属性的引用,避免使用SASS编译期固定的变量值:
body { background-color: var(--bs-body-bg); color: var(--bs-body-color); transition: background-color 0.3s ease, color 0.3s ease; } .card { background-color: var(--bs-card-bg); border-color: var(--bs-border-color); } .navbar { background-color: var(--bs-nav-bg); } .btn-outline-secondary { color: var(--bs-btn-outline-color); border-color: var(--bs-btn-outline-color); } - 执行SASS编译命令,将入口文件编译为生产可用的CSS文件,输出路径对应到
web/css/目录下
调整Asset Bundle配置
打开config/web.php中已配置的assetManager bundles段,将yii\bootstrap4\BootstrapAsset的css加载路径替换为自己编译的自定义CSS文件,原有的jQuery、Bootstrap JS插件配置无需改动:
'yii\bootstrap4\BootstrapAsset' => [ 'css' => [ YII_ENV_DEV ? 'css/bootstrap-custom.css' : 'css/bootstrap-custom.min.css', ], ],
注意:原有配置的appendTimestamp逻辑保留即可,生产环境下可避免静态资源缓存导致的样式更新失效问题
实现切换交互与持久化逻辑
- 在布局文件的导航栏区域添加模式切换按钮:
<button id="themeSwitch" class="btn btn-outline-secondary"> <i class="fa fa-moon"></i> 切换明暗模式 </button> - 在布局文件的
<head>标签最靠前位置注册初始化脚本,避免页面加载时出现明暗闪烁的问题,脚本逻辑包含两个核心部分:读取本地存储的主题配置、绑定切换按钮的点击事件:$this->registerJs(<<<JS // 页面加载初期立即设置主题,避免闪烁 const savedTheme = localStorage.getItem('app-theme') || (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'); document.documentElement.setAttribute('data-theme', savedTheme); document.addEventListener('DOMContentLoaded', () => { const switchBtn = document.getElementById('themeSwitch'); // 初始化按钮图标 switchBtn.innerHTML = savedTheme === 'dark' ? '<i class="fa fa-sun"></i> 切换明暗模式' : '<i class="fa fa-moon"></i> 切换明暗模式'; // 绑定切换逻辑 switchBtn.addEventListener('click', () => { const currentTheme = document.documentElement.getAttribute('data-theme'); const newTheme = currentTheme === 'dark' ? 'light' : 'dark'; document.documentElement.setAttribute('data-theme', newTheme); localStorage.setItem('app-theme', newTheme); switchBtn.innerHTML = newTheme === 'dark' ? '<i class="fa fa-sun"></i> 切换明暗模式' : '<i class="fa fa-moon"></i> 切换明暗模式'; }); }); JS, \yii\web\View::POS_HEAD);
开发阶段注意事项
- SASS编译时不要通过插件把CSS自定义属性转成固定颜色值,否则会丢失运行时切换的能力
- 开发环境可开启SASS文件实时监听编译,修改样式后无需手动重复执行编译命令
- 所有自定义组件的颜色规则都要通过全局CSS变量映射,不要在单个组件的样式里硬编码颜色值,保证明暗模式下的样式统一
内容的提问来源于stack exchange,提问作者Fadly Dzil
相关产品推荐
相关产品推荐

