Полезные инструменты. Переключатель цветовой темы в Bootstrap5
В этом посте, я расскажу как реализовать переключение цветовой темы в Bootstrap5.
Дополнительные материалы
Для скачивания материалов необходимо войти или зарегистрироваться
Файлы также можно получить в Telegram-боте по коду: 166197
Telegram-канал
VK
RuTube
YouTube
Поддержать проект
Хостинг от TimeWeb
RSS-лента последних постов
Реклама
После запуска сайта, я получил несколько вопросов касательно переключателя цветовой темы на сайте, а именно как он реализован.
Ответ прост - читайте документацию: https://getbootstrap.com/docs/5.3/customize/color-modes/
Но, если бы всё было так просто, не было бы вопросов и поста.
Пост будет без привязки к Django или к чему-либо ещё.
В качестве IDE для HTML я рекомендую использовать Visual Studio Code.
Скачать его можно по ссылке: https://code.visualstudio.com/
Благодаря плагинам, в нём удобно работать с HTML и CSS файлами. Именно на примере работы в нём и будет пост.
Подготовка.
Создайте директорию в которой будете работать и откройте её в VS Code.
Создайте в ней две директории: css и js. В этих директориях будут находиться файлы Bootstrap.
Переходим по ссылке и скачиваем последнюю актуальную версию нажав по синей кнопке Download в первом же блоке Compiled CSS and JS.
В скачанном архиве будет также две директории, как те, которые создали ранее, но не спешите всё распаковывать!.
В директории css нас интересуют два файла - bootstrap.css и bootstrap.min.css, а в директории js - bootstrap.bundle.js и bootstrap.bundle.min.js.
В чём разница?
Обычный css/js файл (например, style.css или script.js) и min.css/js файл (например, style.min.css или script.min..js) представляют собой два разных способа организации и оптимизации кода CSS/JS.
- Обычный CSS/JS файл:
- Содержит человеко читаемый код с комментариями и форматированием.
- Используется во время разработки и обслуживания сайта.
- Размер файла может быть больше из-за комментариев и дополнительного форматирования.
- Min CSS/JS файл:
- Является минифицированной (сжатой) версией файла.
- Отсутствуют комментарии и лишние пробелы.
- Используется для оптимизации загрузки и ускорения работы веб-страницы.
- Размер файла обычно меньше, чем размер обычного файла, благодаря удалению ненужных символов.
Выбирайте тот вариант, который вам удобнее и помещайте в соответствующую директорию. Я выбрал min версии, поскольку не планирую вносить правки в файлы Bootstrap.
Для тех, кто знакомится с Bootstrap лучше подойдёт полная версия. Можно будет посмотреть как реализованы те или иные классы, код JavaScript.
Собственный файл скрипта.
Помимо файла скриптов от Bootstrap, нам нужен и собственный.
Создадим в директории js новый файл с именем script.js.
В этом файле будет находиться код, отвечающий за смену цветовой темы.
Нужно ли скачивать Bootstrap?
Один из самых частых вопросов - нужно ли скачивать файлы локально, если их можно подключить по ссылке?
Ответ - не обязательно.
Подключение по ссылке может ускорить работу сайта за счёт CDN.
CDN выбирает ближайший сервер к пользователю и отдаёт оттуда файл. Но может и замедлить, если сервер сайта находится ближе, а CDN далеко.
И ещё одна актуальная проблема - блокировки интернет ресурсов. Если CDN будет заблокирован для пользователя или пользователь заблокирован на CDN - файл не будет загружен и это вызовет проблемы с отображением сайта.
Проще говоря, скачивание файла локально, это в первую очередь безопасность владельца сайта от возможных проблем со стороны получения пользователем содержимого.
Подключаем Bootstrap.
Начнём с самого начала - создания html файла и подключения Bootstrap5.
Создадим файл index.html.
В файле пишем символ восклицательного знака ! и нажимаем клавишу tab. Это создаст базовую структуру.
Для подключения CSS, в блоке тега head добавляем строку:
<link href="css/bootstrap.min.css" rel="stylesheet">
Тут мы указываем путь к файлу bootstrap.min.css и сообщаем, что это таблица стилей.
Для подключения JavaScript от Bootstrap и наш собственный, в конце блока тега body добавляем строки:
<script src="js/bootstrap.bundle.min.js"></script>
<script src="js/script.js"></script>
Тут указываем путь к файлу bootstrap.bundle.min.js и нашему script.js.
Вот и всё. Bootstrap подключен к странице (сайту).
JavaScript смены цветовой темы.
Для того чтобы цветовая тема изменялась и, что немаловажно, запоминалась, необходим JavaScript код.
Откроем файл script.js и пропишем код предоставленный разработчиками Bootstrap:
/*!
* Color mode toggler for Bootstrap's docs (https://getbootstrap.com/)
* Copyright 2011-2023 The Bootstrap Authors
* Licensed under the Creative Commons Attribution 3.0 Unported License.
*/
(() => {
'use strict'
const getStoredTheme = () => localStorage.getItem('theme')
const setStoredTheme = theme => localStorage.setItem('theme', theme)
const getPreferredTheme = () => {
const storedTheme = getStoredTheme()
if (storedTheme) {
return storedTheme
}
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'
}
const setTheme = theme => {
if (theme === 'auto' && window.matchMedia('(prefers-color-scheme: dark)').matches) {
document.documentElement.setAttribute('data-bs-theme', 'dark')
} else {
document.documentElement.setAttribute('data-bs-theme', theme)
}
}
setTheme(getPreferredTheme())
const showActiveTheme = (theme, focus = false) => {
const themeSwitcher = document.querySelector('#bd-theme')
if (!themeSwitcher) {
return
}
const themeSwitcherText = document.querySelector('#bd-theme-text')
const activeThemeIcon = document.querySelector('.theme-icon-active use')
const btnToActive = document.querySelector(`[data-bs-theme-value="${theme}"]`)
const svgOfActiveBtn = btnToActive.querySelector('svg use').getAttribute('href')
document.querySelectorAll('[data-bs-theme-value]').forEach(element => {
element.classList.remove('active')
element.setAttribute('aria-pressed', 'false')
})
btnToActive.classList.add('active')
btnToActive.setAttribute('aria-pressed', 'true')
activeThemeIcon.setAttribute('href', svgOfActiveBtn)
const themeSwitcherLabel = `${themeSwitcherText.textContent} (${btnToActive.dataset.bsThemeValue})`
themeSwitcher.setAttribute('aria-label', themeSwitcherLabel)
if (focus) {
themeSwitcher.focus()
}
}
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
const storedTheme = getStoredTheme()
if (storedTheme !== 'light' && storedTheme !== 'dark') {
setTheme(getPreferredTheme())
}
})
window.addEventListener('DOMContentLoaded', () => {
showActiveTheme(getPreferredTheme())
document.querySelectorAll('[data-bs-theme-value]')
.forEach(toggle => {
toggle.addEventListener('click', () => {
const theme = toggle.getAttribute('data-bs-theme-value')
setStoredTheme(theme)
setTheme(theme)
showActiveTheme(theme, true)
})
})
})
})()
Описание функций:
getStoredThemeиsetStoredTheme- это функции для чтения и записи темы в локальное хранилище браузера.getPreferredTheme- эта функция сначала проверяет, есть ли тема в локальном хранилище. Если нет, она проверяет предпочтения пользователя на темную тему в настройках системы.setTheme- эта функция устанавливает тему в качестве атрибутаdata-bs-themeв элементеdocument.documentElement(обычно это<html>). Если тема 'auto' и пользователь предпочитает темную тему, устанавливается темная тема, иначе устанавливается выбранная тема.showActiveTheme- эта функция обновляет пользовательский интерфейс для отображения активной темы. Она делает кнопку выбранной темы активной и устанавливает соответствующую иконку темы.- Последний блок кода добавляет обработчик событий к
window.matchMedia('(prefers-color-scheme: dark)'). Если пользователь изменяет предпочтение на темную тему в системных настройках, код проверяет, не установлена ли уже темная или светлая тема. Если нет, он устанавливает предпочитаемую тему.
Добавляем переключение цветовой темы.
Теперь нужно добавить в шаблон метку текущей цветовой темы и переключатель.
Для того чтобы Bootstrap понял, какая цветовая тема в данный момент используется, в самом начале файла, внутри тега html, сразу после lang="en" добавим метку текущей темы - data-bs-theme="dark".
Должно быть вот так:
<html lang="en" data-bs-theme="dark">
Затем нужно добавить переключатель.
Вариант из документации.
Разработчики подготовили пример шапки с переключателем цветовой темы в виде выпадающего списка.
Подробнее можно ознакомиться в документации на GitHub: https://github.com/twbs/examples/tree/main/color-modes
Добавляем следующий код в блок body до подключения JS файлов:
<!DOCTYPE html>
<html lang="en" data-bs-theme="dark">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Document</title>
<link href="css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none">
<symbol id="bootstrap" viewBox="0 0 512 408" fill="currentcolor">
<path
d="M106.342 0c-29.214 0-50.827 25.58-49.86 53.32.927 26.647-.278 61.165-8.966 89.31C38.802 170.862 24.07 188.707 0 191v26c24.069 2.293 38.802 20.138 47.516 48.37 8.688 28.145 9.893 62.663 8.965 89.311C55.515 382.42 77.128 408 106.342 408h299.353c29.214 0 50.827-25.58 49.861-53.319-.928-26.648.277-61.166 8.964-89.311 8.715-28.232 23.411-46.077 47.48-48.37v-26c-24.069-2.293-38.765-20.138-47.48-48.37-8.687-28.145-9.892-62.663-8.964-89.31C456.522 25.58 434.909 0 405.695 0H106.342zm236.559 251.102c0 38.197-28.501 61.355-75.798 61.355h-87.202a2 2 0 01-2-2v-213a2 2 0 012-2h86.74c39.439 0 65.322 21.354 65.322 54.138 0 23.008-17.409 43.61-39.594 47.219v1.203c30.196 3.309 50.532 24.212 50.532 53.085zm-84.58-128.125h-45.91v64.814h38.669c29.888 0 46.373-12.03 46.373-33.535 0-20.151-14.174-31.279-39.132-31.279zm-45.91 90.53v71.431h47.605c31.12 0 47.605-12.482 47.605-35.941 0-23.46-16.947-35.49-49.608-35.49h-45.602z" />
</symbol>
<symbol id="check2" viewBox="0 0 16 16">
<path
d="M13.854 3.646a.5.5 0 0 1 0 .708l-7 7a.5.5 0 0 1-.708 0l-3.5-3.5a.5.5 0 1 1 .708-.708L6.5 10.293l6.646-6.647a.5.5 0 0 1 .708 0z" />
</symbol>
<symbol id="circle-half" viewBox="0 0 16 16">
<path d="M8 15A7 7 0 1 0 8 1v14zm0 1A8 8 0 1 1 8 0a8 8 0 0 1 0 16z" />
</symbol>
<symbol id="moon-stars-fill" viewBox="0 0 16 16">
<path
d="M6 .278a.768.768 0 0 1 .08.858 7.208 7.208 0 0 0-.878 3.46c0 4.021 3.278 7.277 7.318 7.277.527 0 1.04-.055 1.533-.16a.787.787 0 0 1 .81.316.733.733 0 0 1-.031.893A8.349 8.349 0 0 1 8.344 16C3.734 16 0 12.286 0 7.71 0 4.266 2.114 1.312 5.124.06A.752.752 0 0 1 6 .278z" />
<path
d="M10.794 3.148a.217.217 0 0 1 .412 0l.387 1.162c.173.518.579.924 1.097 1.097l1.162.387a.217.217 0 0 1 0 .412l-1.162.387a1.734 1.734 0 0 0-1.097 1.097l-.387 1.162a.217.217 0 0 1-.412 0l-.387-1.162A1.734 1.734 0 0 0 9.31 6.593l-1.162-.387a.217.217 0 0 1 0-.412l1.162-.387a1.734 1.734 0 0 0 1.097-1.097l.387-1.162zM13.863.099a.145.145 0 0 1 .274 0l.258.774c.115.346.386.617.732.732l.774.258a.145.145 0 0 1 0 .274l-.774.258a1.156 1.156 0 0 0-.732.732l-.258.774a.145.145 0 0 1-.274 0l-.258-.774a1.156 1.156 0 0 0-.732-.732l-.774-.258a.145.145 0 0 1 0-.274l.774-.258c.346-.115.617-.386.732-.732L13.863.1z" />
</symbol>
<symbol id="sun-fill" viewBox="0 0 16 16">
<path
d="M8 12a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM8 0a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 0zm0 13a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 13zm8-5a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2a.5.5 0 0 1 .5.5zM3 8a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2A.5.5 0 0 1 3 8zm10.657-5.657a.5.5 0 0 1 0 .707l-1.414 1.415a.5.5 0 1 1-.707-.708l1.414-1.414a.5.5 0 0 1 .707 0zm-9.193 9.193a.5.5 0 0 1 0 .707L3.05 13.657a.5.5 0 0 1-.707-.707l1.414-1.414a.5.5 0 0 1 .707 0zm9.193 2.121a.5.5 0 0 1-.707 0l-1.414-1.414a.5.5 0 0 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .707zM4.464 4.465a.5.5 0 0 1-.707 0L2.343 3.05a.5.5 0 1 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .708z" />
</symbol>
</svg>
<div class="container py-4 px-3 mx-auto">
<header class="d-md-flex align-items-md-center pb-3 mb-5 border-bottom">
<h1 class="h4 me-auto">
<a href="/" class="d-flex align-items-center text-body text-decoration-none">
<svg class="d-inline-block me-2" width="40" height="32">
<use href="#bootstrap"></use>
</svg>
<span>Color Modes</span>
</a>
</h1>
<div class="d-flex align-items-center gap-3">
<div class="d-flex align-items-center dropdown color-modes">
<button class="
btn btn-link
px-0
text-decoration-none
dropdown-toggle
d-flex
align-items-center
" id="bd-theme" type="button" aria-expanded="false" data-bs-toggle="dropdown" data-bs-display="static">
<svg class="bi my-1 me-2 theme-icon-active">
<use href="#circle-half"></use>
</svg>
<span class="ms-2" id="bd-theme-text">Toggle theme</span>
</button>
<ul class="dropdown-menu dropdown-menu-end" aria-labelledby="bd-theme"
style="--bs-dropdown-min-width: 8rem">
<li>
<button type="button" class="dropdown-item d-flex align-items-center"
data-bs-theme-value="light">
<svg class="bi me-2 opacity-50 theme-icon">
<use href="#sun-fill"></use>
</svg>
Light
<svg class="bi ms-auto d-none">
<use href="#check2"></use>
</svg>
</button>
</li>
<li>
<button type="button" class="dropdown-item d-flex align-items-center"
data-bs-theme-value="dark">
<svg class="bi me-2 opacity-50 theme-icon">
<use href="#moon-stars-fill"></use>
</svg>
Dark
<svg class="bi ms-auto d-none">
<use href="#check2"></use>
</svg>
</button>
</li>
<li>
<button type="button" class="dropdown-item d-flex align-items-center active"
data-bs-theme-value="auto">
<svg class="bi me-2 opacity-50 theme-icon">
<use href="#circle-half"></use>
</svg>
Auto
<svg class="bi ms-auto d-none">
<use href="#check2"></use>
</svg>
</button>
</li>
</ul>
</div>
<a href="https://github.com/twbs/examples/tree/main/color-modes/" target="_blank" rel="noopener"
class="text-decoration-none">View on GitHub</a>
</div>
</header>
</div>
<script src="js/bootstrap.bundle.min.js"></script>
<script src="js/script-dev.js"></script>
</body>
</html>
Открываем файл index.html в браузере, для этого можно нажать кнопку Go Live в нижней правой части окна VS Code.
На открывшейся странице увидим пример шапки и переключатель темы. Он должен корректно отрабатывать переключение темы.
Мой вариант.
У себя на сайте, я сделал кнопку вида switch. Как по мне, такой вариант органичнее выглядит.
В теге body до подключения JS файлов добавим следующий код:
<!DOCTYPE html>
<html lang="en" data-bs-theme="dark" >
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Document</title>
<link href="css/bootstrap.min.css" rel="stylesheet">
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<header>
<div class="container">
<nav class="navbar navbar-expand-lg bg-primary ps-3">
<a class="navbar-brand" href="#">Код на салфетке</a>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-navbar-nav me-auto">
</ul>
<ul class="navbar-nav">
<li class="nav-item mt-2 mx-2 text-white">
<div class="form-check form-switch switch-icons">
<input class="form-check-input" type="checkbox" role="switch" id="bd-theme"
data-bs-theme-value="dark">
<label class="form-check-label" for="flexSwitchCheckDefault"></label>
</div>
</li>
</ul>
</div>
</nav>
</div>
</header>
<script src="js/bootstrap.bundle.min.js"></script>
<script src="js/script-my.js"></script>
</body>
</html>
В директории css создадим файл style.css и подключим его в теге head:
<link href="css/style.css" rel="stylesheet">
В файле напишем стили для переключателя, добавляющие иконки по краям:
.switch-icons {
display: flex;
align-items: center;
flex-wrap: nowrap;
padding: 0;
margin: 0;
}
.switch-icons::before {
content: url(../svg/sun-fill.svg);
width: 24px;
height: 24px;
margin-right: 3px;
filter: invert(1);
}
.form-check-label {
content: url(../svg/moon-stars-fill.svg);
width: 12px;
height: 12px;
margin-left: 8px;
filter: invert(1);
}
.form-switch .form-check-input {
margin: 0;
}
Иконки приложены к материалам поста
Изменению также подвергся и JS код:
/*!
* Color mode toggler for Bootstrap's docs (https://getbootstrap.com/)
* Copyright 2011-2023 The Bootstrap Authors
* Licensed under the Creative Commons Attribution 3.0 Unported License.
*/
(() => {
'use strict'
const getStoredTheme = () => localStorage.getItem('theme')
const setStoredTheme = theme => localStorage.setItem('theme', theme)
const getPreferredTheme = () => {
const storedTheme = getStoredTheme()
if (storedTheme) {
return storedTheme
}
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'
}
const setTheme = theme => {
if (theme === 'auto' && window.matchMedia('(prefers-color-scheme: dark)').matches) {
document.documentElement.setAttribute('data-bs-theme', 'dark')
} else {
document.documentElement.setAttribute('data-bs-theme', theme)
}
}
setTheme(getPreferredTheme())
const showActiveTheme = (theme, focus = false) => {
const themeSwitcher = document.querySelector('#bd-theme')
if (!themeSwitcher) {
return
}
const themeSwitcherText = document.querySelector('#bd-theme-text')
const activeThemeIcon = document.querySelector('.theme-icon-active use')
const btnToActive = document.querySelector(`[data-bs-theme-value="${theme}"]`)
const svgOfActiveBtn = btnToActive.querySelector('svg use').getAttribute('href')
document.querySelectorAll('[data-bs-theme-value]').forEach(element => {
element.classList.remove('active')
element.setAttribute('aria-pressed', 'false')
})
btnToActive.classList.add('active')
btnToActive.setAttribute('aria-pressed', 'true')
activeThemeIcon.setAttribute('href', svgOfActiveBtn)
const themeSwitcherLabel = `${themeSwitcherText.textContent} (${btnToActive.dataset.bsThemeValue})`
themeSwitcher.setAttribute('aria-label', themeSwitcherLabel)
if (focus) {
themeSwitcher.focus()
}
}
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
const storedTheme = getStoredTheme()
if (storedTheme !== 'light' && storedTheme !== 'dark') {
setTheme(getPreferredTheme())
}
})
window.addEventListener('DOMContentLoaded', () => {
const themeSwitch = document.querySelector('#bd-theme')
themeSwitch.checked = getPreferredTheme() === 'dark'
themeSwitch.addEventListener('change', () => {
const theme = themeSwitch.checked ? 'dark' : 'light';
setStoredTheme(theme);
setTheme(theme);
showActiveTheme(theme, true);
})
})
})
()
Откройте страницу в браузере и проверьте, как отрабатывает переключатель.
Вот и всё. Кастомизация под конкретный шаблон и вид переключателя не должна оказаться сложной.
Разработчики предоставили обширные материалы по реализации, а дальше, как говориться - всё в ваших руках.
Все статьи