@m.polyakova/vkui-tokens

v4.17.1-rc-1

Published

2 years ago

Репозиторий, который содержит в себе дизайн-токены и другие инструменты объединенной дизайн-системы VKUI и Paradigm

Downloads

0High
0Medium
0Low

m.polyakova

Этот репозиторий содержит токены единой дизайн-системы VKUI и их значения для тем оформления различных проектов.

Темы собираются в следующие форматы: css, scss, less, pcss, styl, js, json.

Для описания интерфейсов тем и значений переменных используется TypeScript.

Содержание

Актуальный changelog находится на странице релизов в GitHub!

Использование

Устанавливаем npm-пакет @vkontakte/vkui-tokens:

npm i --save @vkontakte/vkui-tokens@latest

Использование CSS-переменных темы напрямую из пакета

Подключение темы на страницу

В любом CSS-файле подключаем файл темы со значениями переменных:

@import "@vkontakte/vkui-tokens/themes/vkBase/cssVars/declarations/index.css";

Использование переменных в вёрстке

Использование в CSS

.myAwesomeClass:hover {
	background-color: var(--vkui--color_background--hover);
}

Использование CSS-переменных через объект в JavaScript (TypeScript)

import baseTheme from '@vkontakte/vkui-tokens/themes/vkBase/cssVars/theme';

// Собствено имя CSS-переменной (название токена)
console.log(baseTheme.colorBackground.hover.name) // --vkui--color_background--hover;
// Сниппет для использования CSS-переменной
console.log(baseTheme.colorBackground.hover.value) // var(--vkui--color_background--hover, #F5F5F7)

// Динамически (с учётом возможных переопределений)
// узнаём, чему равно значение переменной внутри myElement:
getComputedStyle(myElement).getPropertyValue(baseTheme.colorBackground.hover.name)

Принудительное использование токенов определённого размера

Чтобы принудительно включить тот или иной вид темы у конкретного поддерева элементов, нужно воспользоваться классами .vkui--force-${auto | regular | compact | large | largeX ...}. Смотри демо работы адаптивных переменных и спец. классов.

Также можно просто использовать переменную конкретного брейкпоинта (ex. --vkui--size_field_height--compact), они все тоже попадают в :root)

Использование базовой темы напрямую из пакета

js/ts/json

Импортируем необходимую тему в файле и используем:

import baseTheme from '@vkontakte/vkui-tokens/themes/vkBase';

// do whatever you want with baseTheme

Используем в scss/styl/less root темы из пакета

Импортируем файл с необходимой темой и используем переменные от туда (снизу синтаксис SCSS)

@import "~@vkontakte/vkui-tokens/themes/vkBase/index";

.myAwesomeClass {
	background-color: $color-bg;
}

.myAwesomeClass:hover {
	background-color: $color-bg--hover;
}

Используем pcss формат темы из пакета

Заходим в файл, где хотим использовать тему, и импортируем её:
```
 @import "@vkontakte/vkui-tokens/themes/vkBase";
```
Заходим в файл темы, смотрим какие там есть переменные и юзаем их, например:
```
 width: var(--size-content-block-width);
```
Просто так ничего не заработает, нужно поставить postcss:
```
 npm i --save-dev postcss
```
Для запуска у postcss есть командная строка, которую тоже надо установить:
```
 npm i --save-dev postcss-cli
```
Создаем конфиг postcss. Для этого создаем файл postcss.config.js (можно в любом месте проекта, но лучше в корне) и пишем в него необходимые плагины:
```
   const postcssPresetEnv = require('postcss-preset-env');

    module.exports = {
        plugins: [
            require('postcss-import'),
            require('precss'),
            require('postcss-css-variables'),
            require('postcss-custom-media'),
            require('postcss-media-minmax'),
            require('postcss-extend-rule'),
            postcssPresetEnv({
                stage: 0,
            }),
            require('postcss-color-mix'),
            require('cssnano')
        ],
    };
```
Возможно, вам не понадобятся все эти плагины, поэтому лучше почитать, что делает каждый из них (https://www.postcss.parts/). Нужно посмотреть файл вашей темы и ваш css (scss и др.), чтобы понять, что вам необходимо.
Устанавливаем все необходимые плагины, которые написали в конфиге, например:
```
 npm i --save-dev postcss-import
```
Настраиваем сборку postcss.
Сборка производится командой postcss через командную строку с необходимым параметрами. Про них подробнее тут https://github.com/postcss/postcss-cli
Пример команды:
```
 postcss src/main.css -c ./ --dir public
```
Такая команда прогонит файл src/main.css с помощью конфига из текущей папки и положит результат в папку public.

Инструменты

Локальная сборка своих тем инструментами библиотеки

Библиотека предоставляет интерфейсы и темы, от которых можно наследоваться.

Помимо этого, библиотека предоставляет набор функций, которые позволяют собрать собственную тему в нужном формате.

Сборка темы подразумевает раскрытие наследования, генерацию цветов состояний (hover, active), округление и "пикселизация" значений и т.д.

Наследование от существующей темы

Пример:

import type {ThemeDescription} from '@vkontakte/vkui-tokens/interfaces/general';
import type {Adaptive} from '@vkontakte/vkui-tokens/interfaces/general/tools';
import {lightTheme as baseTheme} from '@vkontakte/vkui-tokens/themeDescriptions/base/vk';
import {expandAll} from '@vkontakte/vkui-tokens/build/expandTheme';
import {compileStyles} from '@vkontakte/vkui-tokens/build/compilers/styles/compileStyles';

interface MyNewAwesomeThemeDescription extends ThemeDescription {
	myNewAwesomeToken: Adaptive<number>;
}

const myNewAwesomeTheme: MyNewAwesomeThemeDescription = {
	...baseTheme,
	myNewAwesomeToken: {
		regular: 20,
		compact: 12,
	},
};

// получаем разные типы тем на основе описания
const {theme, pixelifyTheme, cssVarsTheme} = expandAll(myNewAwesomeTheme);

// получаем CSS-строку со всеми переменными темы,
// которую можно вставить в DOM или сохранить в файл
const cssString = compileStyles('css', pixelifyTheme);

Создание собственной темы "с нуля"

В некоторых случаях нет необходимости наследоваться от одной из базовых тем. Библиотека позволяет сгенерировать свою тему из произвольного количества уникальных переменных.