Библиотека компонентов "SDDS-INSOL"

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

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

Компоненты реализованы на typescript с помощью react , styled-components

Использование данного пакета предполагает установку зависимостей: react & react-dom;

Использование styled-components на проект необязательно, так же как и использование typescript.

Но для того чтобы компоненты работали корректно необходимо установить styled-components.

Установка зависимостей

$ npm install --save react react-dom
$ npm install --save @salutejs/sdds-insol @salutejs/sdds-themes

Так же надо установить пакет styled-components. Примечание: Важно использовать версию пакета 5.3.1

$ npm install --save styled-components@5.3.1

Или, если вы используете препроцессоры, например sass, то

$ npm install --save sass

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

Типографическая система основана на фирменных шрифтах. Для того чтобы шрифт было удобно поставлять в 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" />
        <link
            rel="stylesheet"
            href="https://cdn-app.sberdevices.ru/shared-static/0.0.0/styles/SBSansDisplay.0.2.0.css"
        />
    </head>
    <body>
        ...
    </body>
</html>

С помощью `styled-component`

import React from 'react';
import { createGlobalStyle } from 'styled-components';
import { Button, BodyL } from '@salutejs/sdds-insol';
import { sdds_insol__light } from '@salutejs/sdds-themes';

const Theme = createGlobalStyle(sdds_insol__light);

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

export default App;

С помощью импорта `css` файла

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

import '@salutejs/sdds-themes/css/sdds_insol__dark.css';

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

export default App;

С помощью импорта модульного `css` файла

caution

Потребуется дополнительно настроить TypeScript

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

import styles from '@salutejs/sdds-themes/css/sdds_insol.module.css';

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

export default App;

С помощью импорта `sass` файла

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

import './main.sass';

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

export default App;

@use '@salutejs/sdds-themes/css/sdds_insol__dark.css'

С помощью импорта модульного `sass` файла

caution

Потребуется дополнительно настроить TypeScript

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

import styles from './main.module.sass';

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

export default App;

@use '@salutejs/sdds-themes/css/sdds_insol.module.css'

Смена тем

Пример на `styled-components`:

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

import { Switch } from '@salutejs/sdds-insol';
import { sdds_insol__light, sdds_insol__dark } from '@salutejs/sdds-themes';

import './style.css';

const LightTheme = createGlobalStyle(sdds_insol__light);
const DarkTheme = createGlobalStyle(sdds_insol__dark);

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

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

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

export default App;

Пример на `css-modules`:

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

import { Switch } from '@salutejs/sdds-insol';
import webThemes from '@salutejs/sdds-themes/css/sdds_insol.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="dark theme: "
                onChange={() => {
                    setTheme((theme) => (theme === 'light' ? 'dark' : 'light'));
                }}
            />
        </div>
    );
};

export default App;

Пример на `css`:

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

import { Switch } from '@salutejs/sdds-insol';

// добавьте импорт в css файл
// @import '@salutejs/sdds-themes/css/sdds_insol.module.css';
import './style.css';

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

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

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

export default App;

Пример на `sass`:

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

// добавьте импорт в sass файл
// @use '@salutejs/sdds-themes/css/sdds_insol.module.css';
import './style.sass';

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

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

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

export default App;

Корень приложения

В корне приложения вызовите компонент глобальных стилей GlobalStyle:

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

Для корректной работы SSR - server side rendering приложение нужно обернуть SSRProvider;

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

Все 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;

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

Из вертикали @salutejs/sdds-themes/tokens - подходит в большинстве случаев, т.к. там лежит весь базовый набор токенов.
Непосредственно из темы @salutejs/sdds-themes/tokens/sdds_insol - следует использовать, когда необходимо импортировать уникальные токены, которые лежат только в этой теме.

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

import React from 'react';
import styled from 'styled-components';
import { textAccent, backgroundPrimary, textL } from '@salutejs/sdds-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;

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

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

import styled from 'styled-components';
import { Button } from '@salutejs/sdds-insol';
import { textAccent } from '@salutejs/sdds-themes/tokens';

export const App = () => {
    const StyledP = styled.p`
        color: ${textAccent};
    `;

    return (
        <>
            <Button>Hello, Plasma!</Button>

            <StyledP>
                Token usage example
            </StyledP>
        </>
    );
};

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

Установка зависимостей​

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

С помощью styled-component​

С помощью импорта css файла​

С помощью импорта модульного css файла​

С помощью импорта sass файла​

С помощью импорта модульного sass файла​

Смена тем​

Пример на styled-components:​

Пример на css-modules:​

Пример на css:​

Пример на sass:​

Корень приложения​

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

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