Эта статья о Styled Components будет полезна новичкам и старичкам. Для понимания материала нужны базовые навыки работы с React и TypeScript.
43К открытий48К показов
Дисклеймер
Данная статья будет полезна новичкам и, возможно, старичкам. Эта реализация является чисто субъективной и может вам не понравиться (жду вас в комментах). Для понимания материала требуются базовые навыки работы с React и TypeScript.
Ярослав Татаринов
Middle React Developer RentaTeam
Введение
Styled Components — одно из популярных решений написания кода методом CSS in JS. Гибкое, простое и, главное, идеально вписывается в архитектуру React приложения.
CSS in JS — описание стилей в JavaScript файлах.
Преимущества:
Никаких больше className. Возможность передавать классы никуда не пропадает, но их использование опционально и бессмысленно, теперь мы можем прописывать все стили внутри стилизованных компонент, и классы будут генерироваться автоматически.
Простая динамическая стилизация. Не нужно больше писать тернарные операторы и жонглировать className внутри компоненты, теперь все эти проблемы решаются благодаря прокидыванию пропсов внутрь стилизованных компонент.
Теперь это JS. Так как теперь стили пишутся в экосистеме JavaScript, это упрощает навигацию по проекту и даёт различные возможности написания кода.
StylisJS под капотом. Данный препроцессор поддерживает: 4.1. Ссылки на родителя &, который часто используют в SCSS. 4.2. Минификация — уменьшение размера исходного кода. 4.3. Tree Shaking — удаление мёртвого кода. 4.4. Вендорные префиксы—приставка к свойству CSS, обеспечивающая поддержку браузерами, в которых определённая функция ещё не внедрена на постоянной основе.
За последние пол года Styled Components стал моим любимчиком, и теперь я стараюсь использовать его в каждом возможном проекте. В этой статье хочу выделить мои лучшие практики и поделиться приобретенным опытом.
TypeScript будет отличным помощником в написании стилизованных компонент и даст нам больше контроля и понимания в коде. Все дальнейшие примеры будут описываться в связке с TypeScript.
Посмотрим на простую реализацию Styled Components.
// Какая-тоКомпонента.tsx
import styled from 'styled-components'
// Создаем стилизованную компоненту
// Присваиваем ей функцию styled.[название тега]
// Приписываем шаблонную строку и внутри пишем CSS стили
const Container = styled.div`
background-color: #2b2b2b;
border-radius: 5px;
`
const Title = styled.h1`
font-weight: 300;
`
const Text = styled.p`
font-size: 12px
`
// Используем эти компоненты внутри нашего JSX!
export const SimpleComponent = () => (
<Container>
<Title>Styled Component</Title>
<Text>Some text</Text>
</Container>
)
Зависимости (properties/пропсы)
Чтобы сделать нашу стилизованную компоненту зависимой от значений, нужно передать атрибутом необходимые параметры.
В случае с TypeScript для описания дополнительных свойств нужно определить тип.
styled.[название тега]<тип>`стили`
Обобщённый тип (обобщение, дженерик) позволяет резервировать место для типа, который будет заменён на конкретный, переданный пользователем в треугольных скобках <тип>.
// Какая-тоКомпонента.tsx
import styled from "styled-components";
// Компонента <Container/> будет ждать на вход
// атрибут bg с любым строковым значением
const Container = styled.div<{bg: string}>`
// Чтобы получить доступ к зависимостям,
// внутри шаблонных строк воспользуемся строковой интерполяцией `${...}`
// Где вызовем функцию у которой есть параметр props
background-color: ${props => props.bg};
`
// Если тип занимает много места,
// то будет лучше вынести его в отельный интерфейс
interface TitleProps {
weight: 200 | 300 | 400 | 500 | 600 | 700
}
const Title = styled.h1<TitleProps>`
// Для лучшей читаемости - деструктурируем props,
// задаем дефолтное значение если это необходимо
font-weight: ${({ weight = 400 }) => weight};
`
interface TextProps {
primary: boolean
}
const Text = styled.p<TextProps>`
color: ${({ primary }) => primary ? '#424242' : '4b4b4b'};
`
export const SimpleComponentWithProps = () => (
<Container bg='#fcfcfc'>
<Title weight={300}>Styled Component</Title>
<Text primary>Some Text</Text>
</Container>
)
Атрибуты
Мы также имеем доступ к атрибутам, когда создаём стилизованную компоненту. Метод attrs позволяет преобразовывать пропсы стилизованной компоненты перед их использованием.
// Какая-тоКомпонента.tsx
import styled from "styled-components";
interface TextInputProps {
size: number;
}
const TextInput = styled.input.attrs<TextInputProps>((props) => ({
// Статичные свойства
// Мы можем задать им значение
type: "text",
onFocus: () => console.log("Focused"),
// Динамическая зависимость
// Можем изменить её перед отправкой в стили
size: (props.size || 4) + "px",
}))<TextInputProps>`
padding: ${({ size }) => size};
margin: ${({ size }) => size};
`;
export const SimpleComponentWithAttrs = () => <TextInput size={8} />;
Лучше не использовать без необходимости статичные свойства внутри стилизованной компоненты, так как зачастую эти свойства задаются в JSX. Просто знайте об этой фиче.
Наследование стилей
Стилизованные компоненты могут наследовать стили других компонент, что помогает избежать дублирования кода.
// Какая-тоКомпонента.tsx
import styled from 'styled-components'
const Text = styled.div`
font-size: 12px;
`
// TomatoText наследует те же стили и тег, что и Text
const TomatoText = styled(Text)`
color: "#FF6347";
`
export const SimpleComponentWithExtending = () => (
<>
<Text>Simple Text</Text>
<TomatoText>Tomato Text</TomatoText>
</>
)
CSS-фрагмент
Важной особенностью является передача фрагментов стилей внутрь стилизованной компоненты, данный подход упрощает написание кода и предотвращает повторяемые элементы стилей.
Как и подобает любому веб-приложению, добавим нашему проекту главный файл со стилями. Откроем global.ts и с помощью функции createGlobalStyle сформируем компонент с глобальными стилями.
Как насчёт сделать тему приложения одним большим источником истины в котором мы будем хранить палитру, размеры, медиа запросы и прочие свойства, связанные с компонентами?
В файле theme.ts объявим переменную со всеми необходимыми свойствами.
Данный подход избавляет нас от магических чисел, и даёт возможность применять конкретные значения в стилях и компонентах.
Магические числа в коде — одно из олицетворений зла и лени у программиста. Это целочисленная константа, которая встречается в коде, смысл которой сложно понять.
C этого момента мы уже просто можем импортировать эту константу в необходимых местах и использовать её.
Можно передавать тему внутрь стилизованных компонент при помощи ThemeProvider, чтобы постоянно не импортировать наш baseTheme.
// App.tsx
import { ThemeProvider } from 'styled-components'
import { Routing } from 'routing'
import GlobalStyles from 'styles/global'
// Импортируем тему
import { baseTheme } from 'styles/theme'
const App = () => {
return (
<ThemeProvider theme={baseTheme}>
<Routing />
<GlobalStyles />
</ThemeProvider>
)
}
export default App
Теперь в любой стилизованной компоненте, которая находится внутри провайдера, мы имеем доступ к baseTheme.
// Какая-тоКомпонента.tsx
import styled from 'styled-components'
const StyledHeader = styled.header`
// Получаем значение темы внутри стрелочной функции,
// где деструктурируем props
background-color: ${({ theme }) => theme.colors.secondary};
height: ${({ theme }) => theme.sizes.header.height}px;
z-index: ${({ theme }) => theme.order.header};
`
export const Header = () => <StyledHeader>Title</StyledHeader>
У этой реализации есть одна небольшая проблема — редактор кода не даёт подсказок при написании свойств theme. Для её решения нам нужно типизировать тему и расширить интерфейс DefaultTheme.
В корне src создаём директорию interfaces с файлом styled.ts, где опишем каждое свойство темы.
// styled.ts
export interface ITheme {
colors: {
primary: string
secondary: string
success: string
danger: string
bg: string,
font: string,
}
media: {
extraLarge: string
large: string
medium: string
small: string
}
sizes: {
header: { height: number }
container: { width: number }
footer: { height: number }
modal: { width: number }
}
durations: {
ms300: number
}
order: {
header: number
modal: number
},
}
После этого создаём в корне src файл styled.d.ts, где расширяем интерфейс стандартной темы с помощью нашего типа.
Если что, мы можем брать этот интерфейс прямо из styled-components, если это будет необходимо.
import { DefaultTheme } from 'styled-components'
Динамическая тема
Если мы хотим создать динамическую тему, например для переключения светлой темы на тёмную — то нам потребуется уже знакомый ThemeProvider и любой стейт менеджер для инициализации и контроля темы.
Для начала создадим enum для определения типа нашей темы в папке interfaces.
Enum — это конструкция, состоящая из набора именованных констант, называемого списком перечисления и определяемого такими примитивными типами, как number и string.
После этого реализовываем механизм переключения темы, присваиваем динамические цвета в нужных местах и по желанию можно добавить плавность анимации.
Микрокомпоненты
Это простые переиспользуемые стилизованные компоненты, состоящие из одного узла, которые часто встречаются в приложении. Это могут быть заголовки, тексты, контейнеры, иконки и другие.
Перейдём в файл components.ts и создадим несколько подобных компонент.
// Какая-тоКомпонента.tsx
import { Divider, Title1, Title2 } from 'styles/components'
export SimpleComponent = () => (
<div>
<Title1>Some title H1</Title1>
<Divider height={16}/>
<Title2 weight={200}>Some title H2</Title2>
</div>
)
Анимации
Для этого в Styled Components есть специальная функция keyframes внутрь которой мы передаём ключевые кадры. Их написание полностью схоже с аналогичным в CSS. Все анимации можно записывать в отдельный файл, так как теперь мы можем хранить значения в переменной.
Совместное размещение стилизованных компонент с вашими фактическими компонентами упрощает файловую структуру вашего проекта. И для улучшения читаемости кода — перенесём стили после основного кода.
Ещё одна хорошая практика — это компактный импорт стилизованных компонент.
// Какая-тоКомпонента.tsx
import { faSun } from '@fortawesome/free-regular-svg-icons'
// Импортируем всё из файла styles.
import * as S from './styles'
import * as C from 'styles/components'
import { Button } from 'components/Button'
export const Header = () => (
<S.Header>
<S.HeaderTitle>
<C.Title1 weight={200}>Plankton</Title1>
<C.SupText>React + Mobx + SC</SupText>
</S.HeaderTitle>
<Button
variant={Button.variant.ghost}
color={Button.color.secondary}
size={Button.size.lg}
>
<C.FAIcon
color={'#c7a716'}
icon={faSun}
/>
</Button>
</S.Header>
)
Такой подход даёт нам несколько преимуществ:
Не засоряем код лишними импортами.
Логическое разделение. У каждой стилизованной компоненты теперь есть своя приставка, что упрощается ориентирование в коде. В моём случае: Без приставки — обычные компоненты. S — Стили для нашей фактической компоненты. C — Микрокомпоненты.
Коллизия названий. Часто основную обёртку обзываю StyledЧто-тоТам, теперь мы спокойно можем писать S.Что-тоТам. Это связано с повторяющимся названием родительской компоненты и стилизованной обертки.
Вариации
При создании компоненты мы часто пытаемся интерпретировать её в разных видах, сохраняя основной функционал, будь-то кнопки, текстовые поля, карточки и другие.
Разберём эту практику на примере кнопки, которая может быть разных размеров.
// Где-тоВКакой-тоКомпоненте.tsx
import { Button } from 'components/Button'
...
<Button size={Button.size.lg}>
Text
</Button>
...
// Button.tsx
import { PropsWithChildren } from 'react'
import * as S from './styles'
// Размеры кнопок
export enum ButtonSize {
xs = 'xs',
sm = 'sm',
md = 'md',
lg = 'lg',
}
// Интерфейс входящих зависимостей
export interface ButtonProps {
size?: ButtonSize
}
const ButtonComponent = ({
children,
// Так как size опциональный, зададим ему значение по умолчанию
size = ButtonSize.md,
}: PropsWithChildren<ButtonProps>) => {
return (
<S.Button size={size}>
<span>{children}</span>
</S.Button>
)
}
// Присваиваем Enum ButtonSize компоненте
ButtonComponent.size = ButtonSize
export const Button = ButtonComponent
Я не буду сильно заострять внимание на реализации компоненты, так как это другая тема. Здесь стоит понимать, что значение size может задаваться только в рамках enum ButtonSize.
Думаю вы согласитесь, что это не самое красивое решение. Поэтому предлагаю такую альтернативу: избавимся от тернарных операторов и создадим объект sizes из которого просто будем брать необходимое значение по ключу.
Для работы с несколькими параметрами нам потребуется создать конструкцию switch case, которая будет возвращать один из CSS-фрагментов определенной вариации и цвета.
Хорошее дополнение для Styled Components о котором вы должны знать. Этот пакет даёт массу новых возможностей, например затемнять и осветлять цвета, переводить hex в rgb, делать элемент прозрачным с привязкой к определённому цвету и многое другое.
Оставим эту библиотеку с закосом на сиквел.
Цветные скобки
В процессе использования Styled Components, я столкнулся с одной неприятной багой плагина Bracket Pair Colorizer. Так как мы пишем стили внутри шаблонных строк, то зачастую скобки разных уровней неправильно подсвечиваются. Благо решение есть, причем очень свежее (на данный момент), с недавним обновлением VSCode ввёл свои цветные скобки, и как пишут сами разработчики, их реализация в 10 000 раз быстрее плагина.
Нужно просто добавить следующий параметр в настройки вашего редактора:
"editor.bracketPairColorization.enabled": true
getTransitions
Хочу поделиться своим хелпером — эта функция упростит написание транзишенов, особенно в тех местах, где мы хотим реализовать смену темы.
В данном репозитории собраны готовые компоненты, статьи, видео, проекты, созданные на базе Styled Components, и многое-многое другое. Советую посмотреть.
Заключение
Надеюсь я смог донести уникальность и гибкость написания CSS-кода с помощью Styled Components. Как по мне, это идеальный инструмент для React проектов, где мы можем позволить себе инновации, уникальные подходы и массу вариативности!
Если есть желание посмотреть на эти практики в деле, то вот исходники и демо проекта.
В этой статье я расскажу, как с помощью CSS Custom Highlight API можно стилизовать выделенные диапазоны текста, а также разберу теорию на практическом примере.
Узнали у мидл и сеньор-разработчиков, почему WebAssembly, который считается "ускоренным JS", так и не стал популярнее классического JS, TypeScript или CoffeeScript за почти десятилетие.