Пакет предоставляет набор дизайн-токенов реализующих дизайн «Plasma» для разных устройств.
NB — Все примеры будут приведены с использованием styled-components. Но использовать plasma-tokens
можно и без этого инструмента.
npm i --save @salutejs/plasma-tokens
import React from 'react';
import styled from 'styled-components';
import { text, background, gradient } from '@salutejs/plasma-tokens';
const AppStyled = styled.div`
padding: 30px;
color: ${text};
background-color: ${background};
background-image: ${gradient};
`;
const App = () => {
return (
<AppStyled>
<h2>Hello Plasma</h2>
</AppStyled>
);
};
export default App;
Все css
переменные завернуты в js
переменные для более удобного доступа.
Каждая переменная имеет описание ввиде комментария. Современные IDE
будут выводить этот комментарий ввиде подсказки.
Пример:
/** Цвет предупреждения */
export const warning = 'var(--plasma-colors-warning)';
В пакете реализованы несколько сущностей:
Разберём каждую сущность подробнее:
Текст – это основа любого интерфейса. Для того чтобы текст выглядел единообразно во всей экосистеме Salute
, разработана данная типографическая система.
import { typography } from '@salutejs/plasma-tokens';
typography
включает в себя следующие готовые стилевые объекты:
-
Hero Unit:
- display1
- display2
- display3
-
Заголовки:
- headline1
- headline2
- headline3
- headline4
-
Основной текст:
-
body1
-
body2
-
body3
-
paragraph1
-
paragraph2
-
-
Вспомогательный текст:
- footnote1
- footnote2
-
Контролы:
- button1
- button2
-
Дополнительные:
- caption
- underline
Посмотреть в живую можно в документации типографической системы
Все стилевые объекты также можно импортировать по одному:
import React from 'react';
import styled from 'styled-components';
import { body1, headline2 } from '@salutejs/plasma-tokens';
const AppStyled = styled.div`
padding: 30px;
${body1}
`;
const App = () => {
return (
<AppStyled>
<h2 style={headline2}>Hello Plasma</h2>
<div>
<span>Сил человеческих хватает до известного предела.</span>
<br />
<span>Кто виноват, что именно этот предел играет решающую роль?</span>
</div>
</AppStyled>
);
};
export default App;
Если запустить приведенный выше пример, можно заметить две вещи:
- Текст написан не фирменным шрифтом.
- Размер шрифта выглядит хорошо на декстопном девайсе, но будет мелковат на ТВ-платформе.
Типографическая система основана на фирменном шрифте SB Sans Text
. Для того чтобы шрифт было удобно поставлять в web-приложения, шрифт был загружен на CDN.
Для использования типографической системы вам достаточно загрузить один css
файл:
Его необходимо добавить внутрь тега head
. Если в качестве основы web-приложения вы используете create-react-app, вам необходимо изменить файл ./public/index.html
.
<html>
<head>
<link rel="stylesheet" href="https://cdn-app.sberdevices.ru/shared-static/0.0.0/styles/SBSansText.0.2.0.css" />
</head>
<body>
...
</body>
</html>
Если посмотреть на объекты стилей которые предоставляет типографическая сетка, можно заметить что размер текста задан в единицах измерения rem
.
export const body1 = {
fontFamily: "'SB Sans Text','Helvetica','Arial',sans-serif",
fontWeight: 500,
fontStyle: 'normal',
fontSize: 'var(--plasma-typo-body1-font-size, 1rem)',
letterSpacing: '-0.0190em',
lineHeight: 'var(--plasma-typo-body1-line-height, 1.25rem)',
};
Это позволяет масштабировать весь интерфейс за счёт указания font-size
на html
теге.
Значение для устройств SberBox
& SberPortal
необходимо установить в значение 32px
.
Для остальных поверхностей предпологается использовать значение по умолчанию: 16px
.
html {
font-size: 32px;
}
Необходимые значения также предоставляются в пакете plasma-tokens
.
import { sberBox } from '@salutejs/plasma-tokens/typo';
Пример использования со [style-components][style-components]
import React from 'react';
// createGlobalStyle нужен для создания глобальных стилей
import styled, { createGlobalStyle } from 'styled-components';
// получаем значение для целевой платформы
import { sberBox } from '@salutejs/plasma-tokens/typo';
// получаем стилевые объекты для нашего интерфейса
import { body1, headline2 } from '@salutejs/plasma-tokens';
const AppStyled = styled.div`
padding: 30px;
${body1}
`;
// создаем react-компонент c глобальными стилями
const TypoScale = createGlobalStyle(sberBox);
const App = () => {
return (
<AppStyled>
{/* Используем react-компонент один раз */}
<TypoScale />
<h2 style={headline2}>Hello Plasma</h2>
<div>
<span>Сил человеческих хватает до известного предела.</span>
<br />
<span>Кто виноват, что именно этот предел играет решающую роль?</span>
</div>
</AppStyled>
);
};
export default App;
Также из пакета можно получить все возможные значения для:
fontSizes
fonts
fontWeights
lineHeights
-
letterSpacings
;
import { fonts } from '@salutejs/plasma-tokens';
console.log(fonts);
// –> {
// Medium: "'SB Sans Text','Helvetica','Arial',sans-serif",
// Bold: "'SB Sans Text','Helvetica','Arial',sans-serif",
// Semibold: "'SB Sans Text','Helvetica','Arial',sans-serif",
// Regular: "'SB Sans Text','Helvetica','Arial',sans-serif"
// }
Цветовая палитра это вторая основная часть ощущения платформы Salute
.
Цвета можно забират из корня пакета, для каждого цвета есть коментарий описывающий его использование.
import { accent } from '@salutejs/plasma-tokens';
/** Акцентный цвет призыва к действию */
export const accent = 'var(--theme-colors-accent, #2AC673)';
Цвета представляют собой CSS custom properties c заданным цветом по умолчанию. Это позволяет переопределять цвета с помощью Тем. Всю представленную палитру можно посмотреть в документации: https://bit.ly/3EI1ZBW
Также доступны сами значения пременных:
import { colorValues } from '@salutejs/plasma-tokens';
console.log(colorValues.black); // –> '#080808'
Пример использования цветов для создания основной подложки web-приложения:
import React from 'react';
// createGlobalStyle нужен для создания глобальных стилей
import { createGlobalStyle } from 'styled-components';
// получаем цвета для нашего интерфейса
import { text, background, gradient } from '@salutejs/plasma-tokens';
/**
* text - основной цвет текста
* background - овновной цвет фона
* gradient - градиентная заливка фона
*/
const DocStyles = createGlobalStyle`
html {
color: ${text};
background-color: ${background};
background-image: ${gradient};
/** необходимо залить градиентом всю подложку */
min-height: 100vh;
}
`;
const App = () => {
return (
<div>
{/* Используем глобальные react-компоненты один раз */}
<DocStyles />
</div>
);
};
export default App;
Каждая тема соотносится с персонажем ассистента, и меняет цветовую гамму web-приложения.
В пакете предоставлены 6 тем:
-
darkSber
– Тема по умолчанию, darkEva
darkJoy
lightSber
lightEva
lightJoy
Подключение:
import React from 'react';
// createGlobalStyle нужен для создания глобальных стилей
import { createGlobalStyle } from 'styled-components';
// получаем тему персонажа
import { darkJoy } from '@salutejs/plasma-tokens/themes';
// получаем цвета для нашего интерфейса
import { text, background, gradient } from '@salutejs/plasma-tokens';
const DocStyles = createGlobalStyle`
html {
color: ${text};
background-color: ${background};
background-image: ${gradient};
/** необходимо залить градиентом всю подложку */
min-height: 100vh;
}
`;
// создаем react-компонент для персонажа
const Theme = createGlobalStyle(darkJoy);
const App = () => {
return (
<div>
{/* Используем глобальные react-компоненты один раз */}
<DocStyles />
<Theme />
</div>
);
};
export default App;
npm run create:theme
В результате будут созданы файлы:
-
<name>.json
- файл темы -
<name>.html
- визуальное представление темы
в папке data/themes
Если файл темы <name>.json
был изменен вручную html
файл автоматически не перегенерируется, в данном случае необходимо выполнить команду:
"generate:theme-html": "npx ts-node ./lib/themeBuilder/generateThemeHTML"
в результате рядом с каждым файлом темы в каталоге data/themes
будет создан или обновлен html
файл темы