Библиотека компонентов "PLASMA WEB"

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

Компоненты реализованы с помощью React и поставляются в двух вариантах:

• на styled-components (по умолчанию),
• на предсобранном CSS.

Установка

info

Требуются react и react-dom версии 16.13.1 или выше.

$ npm install --save react react-dom
$ npm install --save @salutejs/plasma-web @salutejs/plasma-themes

Дальнейшие шаги зависят от выбранного варианта поставки.

Для варианта на styled-components:

$ npm install --save styled-components@5.3.11

CSS-вариант дополнительных зависимостей не требует.

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

info

Вариант на styled-components является поставкой по умолчанию.

Один и тот же набор компонентов доступен из двух точек входа:

Точка входа	Реализация	Дополнительные зависимости
@salutejs/plasma-web	styled-components	styled-components@5.3.11
@salutejs/plasma-web/css	предсобранный CSS	нет

import { Button } from '@salutejs/plasma-web';
// или
import { Button } from '@salutejs/plasma-web/css';

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

info

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

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

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

html

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>

NextJS

info

Если в качестве основы web-приложения вы используете Next.js, добавьте ссылки на шрифты через next/head — например, в ./pages/index.tsx.

import Head from "next/head";

import { H2, Button } from "@salutejs/plasma-web";

export default function Home() {
  return (
    <>
      <Head>
        <title>Create Next App with plasma-web components</title>
        <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"
        />
      </Head>
      <div>
        <main>
            <div>
                <H2> PLASMA WEB </H2>
                <Button text="Hello" />
            </div>
        </main>
      </div>
    </>
  );
}

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

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

info

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

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

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

css

import React from 'react';
import { Button, BodyL } from '@salutejs/plasma-web/css';

import '@salutejs/plasma-themes/css/plasma_web__light.css';

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

export default App;

Или подключите тему в файле, где собраны все стили приложения, например index.css

@import '@salutejs/plasma-themes/css/plasma_web__light.css';

css-module

import React from 'react';
import { Button, BodyL } from '@salutejs/plasma-web/css';

import styles from '@salutejs/plasma-themes/css/plasma_web.module.css';

const App = () => {
    return (
        <div className={styles.light}>
            <BodyL>Hello world</BodyL>
            <Button text="This is themed button" />
        </div>
    );
};

export default App;

styled-components

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

const Theme = createGlobalStyle(plasma_web__light);

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

export default App;

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

css

import React, { useLayoutEffect, useState } from 'react';
import { Switch } from '@salutejs/plasma-web/css';

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

    useLayoutEffect(() => {
        document.documentElement.className = theme;
    }, [theme]);

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

export default App;

В файле, где происходит подключение всех стилей, например index.css

@import '@salutejs/plasma-themes/css/plasma_web.module.css';

css-module

import React, { useLayoutEffect, useState } from 'react';

import { Switch } from '@salutejs/plasma-web/css';
import webThemes from '@salutejs/plasma-themes/css/plasma_web.module.css';

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

    useLayoutEffect(() => {
        document.documentElement.className = webThemes[theme];
    }, [theme]);

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

export default App;

styled-components

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

import { Switch } from '@salutejs/plasma-web';
import { plasma_web__light, plasma_web__dark } from '@salutejs/plasma-themes';

const LightTheme = createGlobalStyle(plasma_web__light);
const DarkTheme = createGlobalStyle(plasma_web__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-web';

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

Что дальше

Цвета, отступы и типографика собраны в разделе «Дизайн-система»:

• Цветовая палитра
• Стандартные отступы
• Типографика

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

• Работа с Next — RSC, 'use client', transpilePackages
• Как работать с MCP — актуальная документация для AI-агентов
• Как работать с sdds-icons
• Как работать с plasma-icons
• Поддержка React 16, 17 — SSRProvider
• FAQ

Хуки, хоки, миксины и утилиты собраны в разделе «Функции»:

• Хуки
• Хоки
• Миксины
• Утилиты