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

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

Компоненты реализованы с помощью React и поставляются в виде предсобранного CSS.

Установка

info

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

$ npm install --save react react-dom
$ npm install --save @salutejs/sdds-sbcom @salutejs-ds/sdds_sbcom

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

Единственный вариант поставки — предсобранный CSS.

Точка входа	Реализация	Дополнительные зависимости
@salutejs/sdds-sbcom	предсобранный CSS	нет

import { Button } from '@salutejs/sdds-sbcom';

Beta-компоненты доступны из точки входа @salutejs/sdds-sbcom/beta. Подробнее — в разделе Beta.

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

info

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

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

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

html

info

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

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

<html>
    <head>
        <link
            href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400..700;1,400..700&display=swap"
            rel="stylesheet"
        />
        <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/sdds-sbcom";

export default function Home() {
  return (
    <>
      <Head>
        <title>Create Next App with sdds-sbcom components</title>
        <link
            href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400..700;1,400..700&display=swap"
            rel="stylesheet"
        />
        <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> SDDS SBCOM </H2>
                <Button text="Hello" />
            </div>
        </main>
      </div>
    </>
  );
}

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

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

info

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

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

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

css

tip

Возможные дополнительные настройки в проекте:

Bundle tools:

• webpack + css
• vite

import React from 'react';
import { Button, BodyL } from '@salutejs/sdds-sbcom';

import '@salutejs-ds/sdds_sbcom/css/sdds_sbcom__light.css';

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

export default App;

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

@import '@salutejs-ds/sdds_sbcom/css/sdds_sbcom__light.css';

css-module

tip

Возможные дополнительные настройки в проекте:

Bundle tools:

• webpack + css
• webpack + css-modules
• vite

TS:

Создайте global.d.ts

declare module "*.css" {
  export default {
    [index: string]: string;
  }
}

import React from 'react';
import { Button, BodyL } from '@salutejs/sdds-sbcom';

import styles from '@salutejs-ds/sdds_sbcom/css/sdds_sbcom.module.css';

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

export default App;

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

css

tip

Возможные дополнительные настройки в проекте:

Bundle tools:

• webpack + css
• vite

import React, { useLayoutEffect, useState } from 'react';
import { Switch } from '@salutejs/sdds-sbcom';

import './index.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-ds/sdds_sbcom/css/sdds_sbcom.module.css';

css-module

tip

Возможные дополнительные настройки в проекте:

Bundle tools:

• webpack + css
• webpack + css-modules
• vite

TS:

Создайте global.d.ts

declare module "*.css" {
  export default {
    [index: string]: string;
  }
}

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

import { Switch } from '@salutejs/sdds-sbcom';
import webThemes from '@salutejs-ds/sdds_sbcom/css/sdds_sbcom.module.css';

import './style.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;

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

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

import { Button, BodyL } from '@salutejs/sdds-sbcom';

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

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

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

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

Способ подключения:

import { textPrimary, h5 } from '@salutejs-ds/sdds_sbcom/theme/tokens';

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

/** Токены типографики для компонента 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;

Что дальше

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

• Как работать с иконками
• FAQ