Библиотека компонентов для вертикали PLASMA HOMEDS

Реализация компонентов для создания веб-приложений.

Компоненты реализованы с помощью React и поставляются в варианте на styled-components.

Установка​

info

Требуются react и react-dom версии 16.13.1 или выше, а также styled-components версии 5.3.11.

$ npm install --save react react-dom
$ npm install --save @salutejs/plasma-homeds @salutejs/plasma-themes
$ npm install --save styled-components@5.3.11

Варианты поставки​

Единственный вариант поставки — styled-components.

Точка входаРеализацияДополнительные зависимости
@salutejs/plasma-homedsstyled-componentsstyled-components@5.3.11
import { Button } from '@salutejs/plasma-homeds';

Подключение шрифтов​

info

Для того чтобы шрифт было удобно поставлять в web-приложения, шрифт был загружен на CDN.

Типографическая система основана на фирменных шрифтах.

Для её использования, необходимо загрузить три css файла в зависимости от используемых шрифтов в теме.

info

Если в качестве основы web-приложения вы используете create-react-app, вам необходимо изменить файл ./public/index.html.

Добавить внутрь тега head.

<html>
    <head>
        <link rel="stylesheet" href="https://cdn-app.sberdevices.ru/shared-static/0.0.0/styles/SBSansText.0.2.0.css" />
        <link
            rel="stylesheet"
            href="https://cdn-app.sberdevices.ru/shared-static/0.0.0/styles/SBSansDisplay.0.2.0.css"
        />
        <link
            rel="stylesheet"
            href="https://cdn-app.sberdevices.ru/shared-static/0.0.0/styles/SBSansTextMono.0.2.0.css"
        />
        <title>Web App</title>
    </head>
    <body>
    ...
    </body>
</html>

Подключение темы​

Тема включает в себя цветовые и типографические токены и подключается один раз в корне приложения.

info

Точкой входа является корень приложения:

  • Если вы используете Create React App, делайте вызов внутри src/index.tsx.
  • Если вы используете Next.js, создайте файл pages/_app.tsx и подключите стили в нем.

Доступны светлая и тёмная темы — plasma_homeds__light и plasma_homeds__dark.

import React from 'react';
import { createGlobalStyle } from 'styled-components';
import { Button, BodyL } from '@salutejs/plasma-homeds';
import { plasma_homeds__light } from '@salutejs/plasma-themes';

const Theme = createGlobalStyle(plasma_homeds__light);

const App = () => {
    return (
        <>
            <Theme />
            <BodyL>Hello world</BodyL>
            <Button text="This is themed button" />
        </>
    );
};

export default App;

Переключение тем​

import React, { useState } from 'react';
import { createGlobalStyle } from 'styled-components';

import { Switch } from '@salutejs/plasma-homeds';
import { plasma_homeds__light, plasma_homeds__dark } from '@salutejs/plasma-themes';

import './style.css';

const LightTheme = createGlobalStyle(plasma_homeds__light);
const DarkTheme = createGlobalStyle(plasma_homeds__dark);

const App = () => {
    const [theme, setTheme] = useState('light');

    return (
        <>
            {theme === 'light' ? <LightTheme /> : <DarkTheme />}

            <div className="wrapper">
                <Switch
                    label={`app theme: ${theme}`}
                    onChange={() => {
                        setTheme((theme) => (theme === 'light' ? 'dark' : 'light'));
                    }}
                />
            </div>
        </>
    );
};

export default App;

Использование компонентов​

Все компоненты доступны напрямую из пакета:

import { Button, BodyL } from '@salutejs/plasma-homeds';

export const App = () => {
    return (
        <>
            <BodyL>Hello, PLASMA HOMEDS!</BodyL>
            <Button>Кнопка</Button>
        </>
    );
};

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

Все css токены завернуты в js переменные для более удобного доступа:

/** Основной цвет текста */
export const textPrimary = 'var(--text-primary, #F5F5F5)';
/** Основной фон */
export const backgroundPrimary = 'var(--background-primary, #000000)';

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

/** Токены типографики для компонента DsplL */
export const dsplL = ({
    fontFamily: 'var(--plasma-typo-dspl-l-font-family)',
    fontSize: 'var(--plasma-typo-dspl-l-font-size)',
    fontStyle: 'var(--plasma-typo-dspl-l-font-style)',
    fontWeight: 'var(--plasma-typo-dspl-l-font-weight)',
    letterSpacing: 'var(--plasma-typo-dspl-l-letter-spacing)',
    lineHeight: 'var(--plasma-typo-dspl-l-line-height)',
} as unknown) as CSSObject;

Есть два пути импорта токенов:

tip

Путь @salutejs/plasma-themes/tokens/plasma_homeds следует использовать, когда нужны токены, которые есть только в этой теме.

  • базовый набор — из @salutejs/plasma-themes/tokens
  • уникальные токены темы — из @salutejs/plasma-themes/tokens/plasma_homeds

Пример использования:

import React from 'react';
import styled from 'styled-components';
import { textAccent, backgroundPrimary, textL } from '@salutejs/plasma-themes/tokens';

const AppStyled = styled.div`
    padding: 2rem;
    color: ${textAccent};
    background-color: ${backgroundPrimary};
`;

const Container = styled.div`
    ${textL};
    margin: 1rem;
`;

const App = () => {
    return (
        <AppStyled>
            <Container>
                <span>Hello world</span>
            </Container>
        </AppStyled>
    );
};

export default App;

Что дальше​

Подробные руководства собраны в разделе «Руководства»: