Skip to content

salute-developers/plasma-ui

Repository files navigation

Plasma

plasma

Использование дизайн-системы Plasma позволяет реализовать Canvas App как часть экосистемы виртуальных ассистентов семейства "Салют" и клиентские приложения B2B- и B2C-ориентированности. Все текущие приложения в экосистеме Salute реализованы с помощью Plasma.

Состав:

  • @salutejs/plasma-ui
  • @salutejs/plasma-tokens
  • @salutejs/plasma-tokens-web
  • @salutejs/plasma-tokens-b2c
  • @salutejs/plasma-icons

plasma-ui

Пакет с набором готовых компонентов и утилит для создания Canvas App. Компоненты реализованы с помощью React. Для компонентов доступны Storybook и документация.

npm ui

plasma-tokens, plasma-tokens-web, plasma-tokens-b2c

Пакеты с набором дизайн-токенов. В пакет входят типографические и цветовые константы. Дизайн-токены поставляются в качестве CSS custom propperties и JavaScript переменных. Перед использованием рекомендуется ознакомится с документацией по токенам.

npm ui npm ui npm ui

plasma-icons

Пакет с набором иконок, которые доступны к просмотру в хранилище, а также в Storybook и документации.

npm ui

Начальная установка

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

npm install --ignore-scripts
npm run bootstrap
npm run build

Быстрый старт

Canvas App это web-приложение, для его создания вам потребуется:

Установка

После создания основы приложения:

npm i -S styled-components@5.1.1 @salutejs/plasma-ui @salutejs/plasma-tokens @salutejs/plasma-icons

Компоненты реализованы с помощью styled-components. Поэтому необходимо поставить их в зависимость.

NB: Если вы решили не использовать Create React App, то вам потребуется установить react и react-dom:

npm i -S react react-dom

Более подробно можно ознакомиться на странице документации.

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

// ./src/App.jsx
import React from 'react';

import { Button } from '@salutejs/plasma-ui';

function App() {
    return (
        <div className="App">
            <p>
                <Button view="primary">Hello Plasma</Button>
            </p>
        </div>
    );
}

export default App;

Более подробно можно ознакомиться на странице документации.

Обратная связь

Разработка дизайн-системы Plasma ведется в репозитории https://github.com/salute-developers/plasma. Если вы хотите добавить новый компонент, вы можете прислать pull request. Также вы можете завести задачу на создание нового компонента или описать некорректное поведение текущего.

About

Реализация компонентов для создания смартаппов

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages