@salutejs/caldera
v0.27.1
Published
Salute Design System / React UI kit for Caldera web applications
Downloads
52
Readme
Библиотека компонентов Caldera
Реализация компонентов для создания веб-приложений.
Использование
Компоненты реализованы на typescript с помощью react и styled-components;
Использование данного пакета предполагает установку зависимостей: react
& react-dom
;
Использование styled-components
на проект необязательно, так же как и использование typescript
.
Но для того чтобы компоненты работали корректно необходимо установить styled-components
.
Установка пакета
$ npm install --save react react-dom
$ npm install --save styled-components
$ npm install --save @salutejs/caldera @salutejs/caldera-online-themes
Настройка
Создайте компонент для подключения глобальных стилей:
import { createGlobalStyle } from 'styled-components';
import { caldera__light } from '@salutejs/caldera-online-themes';
const ThemeStyle = createGlobalStyle(caldera__light);
export const GlobalStyle = () => (
<>
<ThemeStyle />
</>
);
Корень приложения
В корне приложения вызовите компонент глобальных стилей GlobalStyle
:
- Если вы используете Create React App, делайте вызов внутри
src/index.tsx
. - Если вы используете Next.js, создайте файл
pages/_app.tsx
и подключите стили в нем.
Для корректной работы server side rendering приложение нужно обернуть SSRProvider
(доступен в caldera);
Использование компонентов
Все компоненты доступны из папки components
или напрямую из пакета:
// App.tsx
import { Button } from '@salutejs/caldera';
import { textAccent } from '@salutejs/caldera-online-themes/tokens';
export const App = () => {
return (
<Button>Hello, Caldera!</Button>
<p style={{color: textAccent}}>
Token usage example
</p>
);
};