Кастомный React хук для изменения темы веб-приложения
2 года назад·2 мин. на чтение
Пишем кастомный React хук useTheme, который динамически меняет тему веб-приложения с помощью CSS переменных.
В этой статье напишем кастомный хук на ReactJS, который будет менять тему веб-приложения.
Особенности хука useTheme, который мы реализуем:
Код хука
Сам хук выглядит довольно просто.
Использование хука
Здесь добавлены две кнопки, каждая из которых отвечает за переключение на светлую или темную тему. Они обернуты в
- использует CSS переменные
- быстро кастомизируется
- плавный переход между темами
- умеет сохранять выбранную тему в local storage
Код хука useTheme
Сам хук выглядит довольно просто.
// hooks/use-theme.js import { useLayoutEffect, useState } from 'react' const isDarkTheme = window?.matchMedia('(prefers-color-scheme: dark)').matches const defaultTheme = isDarkTheme ? 'dark' : 'light' export const useTheme = () => { const [theme, setTheme] = useState( localStorage.getItem('app-theme') || defaultTheme ) useLayoutEffect(() => { document.documentElement.setAttribute('data-theme', theme) localStorage.setItem('app-theme', theme) }, [theme]) return { theme, setTheme } }
prefers-color-scheme
используется для определения выбранной пользователем темы (светлая или темная). Пользователь указывает свои предпочтения через настройку операционной системы или через настройку user agent.
document.documentElement.setAttribute('data-theme', theme)
- этой строчкой мы добавляем кастомный data-атрибут в тег html
. Таким образом, например, при выборе светлой темы в теге html
появится data-атрибут data-theme="light"
.
Добавление CSS переменных
Далее мы должны указать CSS переменные, которые будут иметь различные значение для разных тем. Например,--button-text-color
имеет значение #ffffff
при темной теме и #252525
- при светлой.
/* index.css */ html[data-theme='dark'] { --button-text-color: #ffffff; --button-background-color: #4e005c; --button-border-color: #ba8fc2; --background-color: #292929; --icon-color: #ba8fc2; } html[data-theme='light'] { --button-text-color: #252525; --button-background-color: #f9d4ff; --button-border-color: #4e005c; --background-color: #dfdfdf; --icon-color: #4e005c; }
Применение CSS переменных
Далее нам нужно применить эти CSS переменные к соответствующим элементам. Добавлениеtransition
дает плавность при переключении тем.
/* App.css */ .app__container { background-color: var(--background-color); transition: background-color 200ms linear; } .app__logo { color: var(--icon-color); transition: color 500ms linear; } .app__button, .app__button:hover, .app__button:focus, .app__button:active, .app__button:not(:disabled):not(.disabled):active { color: var(--button-text-color); background-color: var(--button-background-color); border-color: var(--button-border-color); transition: color 500ms linear, background-color 500ms linear, border-color 500ms linear; }
Использование хука useTheme
Здесь добавлены две кнопки, каждая из которых отвечает за переключение на светлую или темную тему. Они обернуты в ButtonGroup
.
Элементы логотип, контейнер и кнопка имеют соответствующие CSS классы, которые мы описали выше - app__logo
, app__container
и app__button
. В этих классах были использованы CSS переменные.
Исходный кодimport React from 'react' import Button from 'react-bootstrap/Button' import ButtonGroup from 'react-bootstrap/ButtonGroup' import { FaCoffee } from 'react-icons/fa' import { useTheme } from './hooks/use-theme' import './App.css' export default function App() { const { theme, setTheme } = useTheme() const handleLightThemeClick = () => { setTheme('light') } const handleDarkThemeClick = () => { setTheme('dark') } return ( <div className="app__container w-100 h-100 d-flex flex-column"> <div className="p-3 d-flex justify-content-end"> <ButtonGroup aria-label="Theme toggle"> <Button variant="secondary" onClick={handleLightThemeClick}> Light </Button> <Button variant="secondary" onClick={handleDarkThemeClick}> Dark </Button> </ButtonGroup> </div> <div className="flex-grow-1 d-flex flex-column justify-content-center align-items-center"> <FaCoffee size={100} className="app__logo mb-5" /> <div className="d-flex"> <Button className="app__button" type="button"> Subscribe </Button> </div> </div> </div> ) }
Как использовать переменные среды в React
год назад·5 мин. на чтение
О различных способах доступа к переменным среды в React приложении
Если у вас нет опыта server side программирования, переменные среды могут показаться чем-то магическим. Этот недостаток знаний может поставить вас в тупик, когда вы закончите создавать приложения todo на localhost и попытаетесь создать продакшн сборку в первый раз.
Если вы хотите узнать, как использовать переменные среды в ваших собственных инструментах, или глубоко погрузиться в то, как переменные среды работают в React, вы можете продолжить чтение этой статьи. Но если вы ищете быстрое решение и используете Create React App, ознакомьтесь с документацией здесь. Пользователи NextJS, ознакомьтесь с документацией здесь.
Сломается он потому, что когда мы используем переменные окружения в клиентском коде, они на самом деле просто служат заполнителями, которые будут заменены при компиляции нашего кода. Проблема в том, что мы не сказали webpack скомпилировать эти переменные в реальные значения. Давайте сделаем это в нашем конфигурационном файле webpack с плагином
Способ 2: Использование файла
Вся идея здесь состоит в том, чтобы создать файл (называемый просто Создадим файл
Этот файл должен находиться в корневом каталоге проекта и называться
Обработка файла
Теперь нам нужен какой-то способ обработки файлов и их содержимого. Для этого мы собираемся использовать популярный npm пакет под названием dotenv. Dotenv широко используется (create-react-app использует его). Он будет получать переменные из нашего файла
Настройка активной среды с помощью
Мы собираемся использовать
Так как мы определили нашу среду в нашем
Проблема, которую мы решаем
Как объявить различные URL-адресов API для локальной разработки и для продакшн сборки.Как решить эту проблему
Использовать переменные среды. При работе с React переменные среды — это переменные, доступные через глобальный объектprocess.env
. Этот глобальный объект предоставляется вашей средой через NodeJS. И поскольку у нас нет NodeJS в браузере, нам понадобится webpack.
В этой статье рассмотрим два способа установки и использования переменных среды для ваших React проектов с помощью webpack: с помощью скриптов npm и с помощью файла .env
.
Способ 1: Использование скриптов npm для установки переменных среды
Во-первых, установите webpack и webpack-cli из npm:Перейдите в файлnpm install --save-dev webpack webpack-cli
package.json
, проверьте поле scripts
и найдите команды, которые запускают webpack. Вероятно, это будет выглядеть примерно так:
Давайте добавим некоторые переменные окружения с флагом{ // ... scripts: { "dev": "webpack --config webpack.config.dev.js", "build": "webpack --config webpack.config.build.js" } }
--env
в scripts
:
Мы добавили{ // ... scripts: { "dev": "webpack --env.API_URL=http://localhost:8000 --config webpack.config.dev.js", "build": "webpack --env.API_URL=https://www.myapi.com --config webpack.config.build.js" } }
--env.API_URL=
часть в обоих скриптах. Теперь запустите команду npm run dev
, перейдите к React компоненту и используйте process.env.API_URL
:
И тут проект должен сломаться.const App = () => <h1>{process.env.API_URL}</h1>;
DefinePlugin
:
const webpack = require('webpack'); // DefinePlugin это часть webpack, поэтому это require обязателен // возвращаем функцию из config файла // переменная `env` будет просто объектом { API_URL: 'http://localhost:8000' } // в ней будут содержаться все переменные среды, которые мы указали в package.json module.exports = (env) => { // этот объект это сама конфигурация webpack return { plugins: [ // добавим плагин в список плагинов new webpack.DefinePlugin({ `process.env.API_URL`: JSON.stringify(${env.API_URL}) }) ] }; };
DefinePlugin
требует, чтобы вы буквально определили свои «переменные среды».
Вы также можете применить .reduce
к переменным среды, чтобы получить объект:
Если вы запустите команду сейчас, все скомпилируется, и вашmodule.exports = (env) => { // создаем объект из переменных среды const envKeys = Object.keys(env).reduce((prev, next) => { prev[`process.env.${next}`] = JSON.stringify(env[next]); return prev; }, {}); return { plugins: [ new webpack.DefinePlugin(envKeys) ] }; };
process.env.API_URL
будет скомпилирован в правильный URL-адрес на основе переменной среды.
Способ 2: Использование файла .env
для установки переменных среды
Вся идея здесь состоит в том, чтобы создать файл (называемый просто .env
), заполненный переменными среды.
Чтобы защитить пароли и другие значения переменных среды, добавьте файл .env
в .gitignore
.
Фронтенд код будет ссылаться на одну и ту же переменную среды (process.env.API_URL
) в обеих средах (при локальной разработке и на продакшене), но поскольку вы определили разные значения в своих .env
, скомпилированные значения будут отличаться.
Создадим файл .env
Этот файл должен находиться в корневом каталоге проекта и называться .env
. Добавим переменную:
API_URL=http://localhost:8000
Обработка файла .env
Теперь нам нужен какой-то способ обработки файлов и их содержимого. Для этого мы собираемся использовать популярный npm пакет под названием dotenv. Dotenv широко используется (create-react-app использует его). Он будет получать переменные из нашего файла .env
и добавлять их в глобальный process.env
.
$ npm install --save-dev dotenv
Добавление переменных в проект React
Есть одна проблема. Dotenv работает только на стороне сервера. А мы хотим использовать переменные среды на стороне клиента, на фронтенде. В данном случае мы разрабатываем клиентскую часть. И dotenv нужна какая-то среда для фактического хранения переменных. Здесь поможет Webpack. Воспользуемся плагиномDefinePlugin
в нашей webpack конфигурации:
При необходимости проверьте параметры конфигурации dotenv в документации на github. Вызовconst webpack = require('webpack'); const dotenv = require('dotenv'); module.exports = () => { // dotenv вернет объект с полем parsed const env = dotenv.config().parsed; // сделаем reduce, чтобы сделать объект const envKeys = Object.keys(env).reduce((prev, next) => { prev[`process.env.${next}`] = JSON.stringify(env[next]); return prev; }, {}); return { plugins: [ new webpack.DefinePlugin(envKeys) ] }; };
.config()
в dotenv вернет объект со всеми переменными среды, установленными в вашем файле .env
через поле parsed
. Теперь давайте проверим наш React код:
И это работает! Он показывает значение переменной средыconst App = () => <h1>{process.env.API_URL}</h1>;
API_URL
, определенной в .env
.
Осталась только одна проблема: нам все еще нужно определить различные API_URL
для локальной разработки и продакшена.
Различные переменные среды для разных сред
Вся идея состоит в том, чтобы создать разные файлы.env
для разных сред и позволить webpack выбрать правильный файл .env
в зависимости от активной среды. Поэтому создайте два файла в корневом каталоге проекта:
.env
(содержит все переменные среды для продакшн).env.development
(содержит все переменные среды для локальной разработки)
.env
сопоставление имени среды. Общепринятой практикой является использование исходного файла .env
для продакшн сборки, поэтому мы не будем добавлять постфикс для продакшн .env
.
Настройка активной среды с помощью scripts
в package.json
Мы собираемся использовать scripts
(как мы это делали в методе 1), чтобы установить текущую среду в нашем package.json
:
{ "scripts": { "dev": "webpack --env.ENVIRONMENT=development --config webpack.config.dev.js", "build": "webpack --env.ENVIRONMENT=production --config webpack.config.build.js" } }
package.json
, теперь она доступна в нашей конфигурации webpack.
Следующим шагом будет переход к webpack конфигурации и дать ему использовать файл .env
, принадлежащий активной среде. Как и раньше, мы используем dotenv, но теперь мы указываем пользовательский path
в параметрах.
Эта вся необходимая настройка, но вы можете создать большеconst webpack = require('webpack'); const dotenv = require('dotenv'); const fs = require('fs'); // для проверки существования файла const path = require('path'); // для получения текущего пути module.exports = (env) => { // получаем корневой путь (предполагаем, что webpack config лежит в корне проекта) const currentPath = path.join(__dirname); // путь по умолчанию (будет использован для продакшена - `.env`) const basePath = currentPath + '/.env'; // склеиваем имя среды с именем файла для получения имени env файла const envPath = basePath + '.' + env.ENVIRONMENT; // проверяем существует ли env файл, если нет используем имя по умолчанию const finalPath = fs.existsSync(envPath) ? envPath : basePath; // устанавливаем параметр path в dotenv const fileEnv = dotenv.config({ path: finalPath }).parsed; // сделаем reduce, чтобы получить объект const envKeys = Object.keys(fileEnv).reduce((prev, next) => { prev[`process.env.${next}`] = JSON.stringify(fileEnv[next]); return prev; }, {}); return { plugins: [ new webpack.DefinePlugin(envKeys) ] };
.env
файлов для большего количества сред (например, .env.staging
) по аналогии.