@salutejs/plasma-new-hope 0.66.0-dev.0 → 0.66.1-canary.1149.8446846250.0

package/styled-components/cjs/components/Tabs/Tabs.template-doc.mdx

@@ -0,0 +1,94 @@
+---
+id: tabs
+title: Tabs
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Tabs
+Набор компонентов для создания вкладок.
+Структура для вкладок похожа на структуру маркированных списков.
+
+## TabsController
+
+<Description name="TabsController" />
+<PropsTable name="TabsController" />
+
+## Tabs
+
+<Description name="Tabs" />
+<PropsTable name="Tabs" />
+
+## TabItem
+
+<Description name="TabItem" />
+<PropsTable name="TabItem" />
+
+
+## Использование
+
+### Cтандартное подключение, без клавиатурной навигации
+
+```tsx live
+import React, { useState } from 'react';
+import { Tabs, TabItem } from '@salutejs/{{ package }}';
+import { IconClock } from '@salutejs/plasma-icons';
+
+export function App() {
+    const items = Array(4).fill(0);
+    const [index, setIndex] = useState(0);
+
+    return (
+        <Tabs view="filled" stretch size="xs">
+            {items.map((_, i) => (
+                <TabItem
+                    view="secondary"
+                    key={`item:${i}`}
+                    size="xs"
+                    selected={i === index}
+                    tabIndex={0}
+                    contentLeft={<IconClock size="xs" color="inherit" />}
+                    onClick={() => setIndex(i)}
+                >
+                    Label
+                </TabItem>
+            ))}
+        </Tabs>
+    );
+}
+```
+
+### Подключение клавиатурной навигации
+Для этого необходимо дополнительно прокинуть свойства `index, itemIndex, onIndexChange`.
+Клавиши ArrowLeft, ArrowRight, Home, End для навигации по вкладкам.
+
+```tsx live
+import React, { useState } from 'react';
+import { Tabs, TabItem } from '@salutejs/{{ package }}';
+import { IconClock } from '@salutejs/plasma-icons';
+
+export function App() {
+    const items = Array(4).fill(0);
+    const [index, setIndex] = useState(0);
+
+    return (
+        <Tabs view="filled" stretch size="xs" index={index}>
+            {items.map((_, i) => (
+                <TabItem
+                    view="secondary"
+                    key={`item:${i}`}
+                    size="xs"
+                    itemIndex={i}
+                    onIndexChange={(i) => setIndex(i)}
+                    selected={i === index}
+                    tabIndex={0}
+                    contentLeft={<IconClock size="xs" color="inherit" />}
+                    onClick={() => setIndex(i)}
+                >
+                    Label
+                </TabItem>
+            ))}
+        </Tabs>
+    );
+}
+```

package/styled-components/cjs/components/TextArea/TextArea.template-doc.mdx

@@ -0,0 +1,88 @@
+---
+id: textarea
+title: TextArea
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# TextArea
+<Description name="TextArea" />
+<PropsTable name="TextArea" exclude={['$isFocused']} />
+
+## Использование
+Компонент `TextArea` может содержать иконку (или кнопку) справа.
+Для этого используйте свойство и `contentRight`:
+
+```tsx live
+import React from 'react';
+import { TextArea } from '@salutejs/{{ package }}';
+import { IconDownload } from '@salutejs/plasma-icons';
+
+export function App() {
+    return (
+        <div>
+            <TextArea
+                placeholder="Положение иконки"
+                defaultValue="Справа"
+                contentRight={<IconDownload />}
+            />
+        </div>
+    );
+}
+```
+
+Также можно регулировать высоту и ширину, используя свойства `height` и `width`, 
+указав значения в `rem` или соответствующие свойствам css значения.
+
+## Autoresize
+Также можно включить автоматическое регулирование высоты поля ввода по длине контента внутри (параметра `value`).
+Для этого необходимо использовать свойство `autoResize`. 
+При этом, если пользователь вручную регулирует высоту(`resize`), то она так и остается пользовательской.
+
+В этом режиме можно указать крайние значения высоты поля ввода, используя свойства `autoMin`, `autoMax`,
+указав их в `rem`.
+
+```tsx live
+import React from 'react';
+import { TextArea } from '@salutejs/{{ package }}';
+
+export function App() {
+    const [value, setValue] = React.useState('Значение');
+
+    return (
+        <div>
+            <TextArea
+                placeholder="Введите значение"
+                value={value}
+                onChange={(e) => {
+                    setValue(e.target.value);
+                }}
+                autoResize
+                minAuto={3}
+                maxAuto={5}
+            />
+        </div>
+    );
+}
+```
+
+### Подсказка
+Для вывода подсказки снизу от поля используйте свойство `leftHelper` и/или `rightHelper`.
+
+```tsx live
+import React from 'react';
+import { TextArea } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <TextArea
+                placeholder="Введите значение"
+                defaultValue="Значение"
+                leftHelper="Подсказка снизу слева"
+                rightHelper="Подсказка снизу справа"
+            />
+        </div>
+    );
+}
+```

package/styled-components/cjs/components/TextField/TextField.template-doc.mdx

@@ -0,0 +1,112 @@
+---
+id: textfield
+title: TextField
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# TextField
+<Description name="TextField" />
+<PropsTable name="TextField" exclude={['$isFocused']} />
+
+## Использование
+Компонент `TextField` может содержать иконку (или кнопку) слева и справа.
+Для этого используйте свойства `contentLeft` и `contentRight`:
+
+```tsx live
+import React from 'react';
+import { TextField } from '@salutejs/{{ package }}';
+import { IconDownload } from '@salutejs/plasma-icons';
+
+export function App() {
+    return (
+        <div>
+            <TextField
+                placeholder="Положение иконки"
+                defaultValue="Слева"
+                contentLeft={<IconDownload />}
+            />
+            <TextField
+                placeholder="Положение иконки"
+                defaultValue="Справа"
+                contentRight={<IconDownload />}
+            />
+        </div>
+    );
+}
+```
+
+### Размер поля
+Размер поля задаётся с помощью свойства `size`. Свойство принимает значения `"l"` и `"m"`:
+
+```tsx live
+import React from 'react';
+import { TextField } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <TextField
+                placeholder="Размер"
+                size="l"
+                defaultValue="L56"
+            />
+            <TextField
+                placeholder="Размер"
+                size="m"
+                defaultValue="M48"
+            />
+        </div>
+    );
+}
+```
+
+### Статус поля
+Статус поля задается с помощью свойства `status`. Возможные значения свойства: `success`, `warning` и `error`:
+
+```tsx live
+import React from 'react';
+import { TextField } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <TextField
+                placeholder="Статус"
+                status="success"
+                defaultValue="Успех"
+            />
+            <TextField
+                placeholder="Статус"
+                status="warning"
+                defaultValue="Успех"
+            />
+            <TextField
+                placeholder="Статус"
+                status="error"
+                defaultValue="Ошибка"
+            />
+        </div>
+    );
+}
+```
+
+### Подсказка
+Для вывода подсказки снизу от поля используйте свойство `helperText`:
+
+```tsx live
+import React from 'react';
+import { TextField } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <TextField
+                placeholder="Введите значение"
+                defaultValue="Значение"
+                helperText="Подсказка снизу"
+            />
+        </div>
+    );
+}
+```

package/styled-components/cjs/components/Toast/Toast.template-doc.mdx

@@ -0,0 +1,153 @@
+---
+id: toast
+title: Toast
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Toast
+<Description name="Toast" />
+<PropsTable name="Toast" />
+
+## Система подсказок
+Существует готовая система текстовых подсказок, для использования которой необходимо обернуть приложение в `ToastProvider`:
+
+```jsx title="App.tsx"
+import React from 'react';
+import { ToastProvider } from '@salutejs/{{ package }}';
+
+export const App = () => (
+    <ToastProvider>
+        <div className="App">Hello, world!</div>
+    </ToastProvider>
+);
+```
+
+После этого, с помощью хука `useToast` можно получить доступ к управлению подсказками.
+
+```jsx title="MyComponent.tsx"
+import React from 'react'
+import { useToast, Button } from '@salutejs/{{ package }}'
+
+export const MyComponent = () => {
+    const { showToast, hideToast } = useToast()
+
+    const onHide = () => {}
+
+    return (
+        <Button onClick={() => showToast({ text, position, timeout, fade, contentLeft, role, onHide })} />
+    )
+}
+```
+
+`showToast` имеет необязательный аргумент `position`, отвечающий за позиционирование подсказки.
+
+```ts
+type Position = 'top' | 'bottom';
+```
+
+`showToast` имеет необязательный аргумент `timeout`, отвечающий за время отображения подсказки.
+Если аргумент не передается, по умолчанию подсказка отображается пока пользователь ее не закроет.
+
+Скрыть текущую подсказку в любой момент можно с помощью функции `hideToast`.
+
+## Аргументы функции `showToast`
+| Название | Тип             | Значение | Описание           |
+|----------|-----------------|----------|--------------------|
+| `args`   | `ShowToastArgs` |          | Конфигурация toast |
+
+```ts
+import type { ReactNode } from 'react';
+
+export interface ShowToastArgs {
+    /**
+     * Текстовая надпись
+     */
+    text?: string;
+    /**
+     * Слот для контента слева, например `Icon`
+     */
+    contentLeft?: ReactNode;
+    /**
+     * Место отображения подсказки
+     */
+    position?: ToastPosition;
+    /**
+     * WAI-ARIA роль
+     */
+    role?: ToastRole;
+    /**
+     * Отображать ли подложку блока подсказки
+     */
+    fade?: boolean;
+    /**
+     * Значение для дополнительно отступа блока подсказки, считается в rem.
+     */
+    offset?: number;
+    /**
+     * Блок подсказки c округлым border-radius
+     */
+    pilled?: boolean;
+    /**
+     * Отображать ли иконку закрытия
+     */
+    hasClose?: boolean;
+    /**
+     * Размер блока подсказки
+     */
+    size?: string;
+    /**
+     * Вид блока подсказки
+     */
+    view?: string;
+    /**
+     * Время отображения подсказки. Если не передать значение, подсказка будет отображаться пока ее не закроют.
+     */
+    timeout?: number;
+    /**
+     * callback срабатывающий в момент события hideToast
+     */
+    onHide?: () => void;
+    /**
+     * callback срабатывающий в момент события showToast
+     */
+    onShow?: () => void;
+}
+```
+
+## Пример использования
+
+```jsx live
+import React from 'react'
+import { useToast, ToastProvider, Button } from '@salutejs/{{ package }}'
+
+export function App() {
+
+    const ToastExample = () => {
+        const { showToast, hideToast } = useToast()
+
+        const onShow = () => {}
+        const onHide = () => {}
+        const toastData = {
+            text: 'Подсказка вызванная showToast',
+            position: 'bottom',
+            role: 'status',
+            hasClose: true,
+            fade: false,
+            size: 'm',
+            view: 'dark',
+            timeout: 3000,
+            onShow,
+            onHide
+        }
+
+        return <Button onClick={() => showToast(toastData)} text="Вызвать подсказку" />
+    }
+
+    return (
+        <ToastProvider>
+            <ToastExample />
+        </ToastProvider>
+    )
+}
+```

package/styled-components/cjs/components/Tooltip/Tooltip.template-doc.mdx

@@ -0,0 +1,30 @@
+---
+id: Tooltip
+title: Tooltip
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Tooltip
+<Description name="Tooltip" />
+<PropsTable name="Tooltip" />
+
+## Базовое применение
+
+`Tooltip` оборачивает собой любой компонент и открывается в заданную сторону(причем можно передавать массив, тогда сторона будет определяться автоматически из переданных).
+
+Предполагается оборачивать иконки из пакета `@salutejs/plasma-icons`
+
+```tsx live
+import React from 'react';
+import { Tooltip } from '@salutejs/{{ package }}';
+import { IconApps } from '@salutejs/plasma-icons';
+
+export function App() {
+    return (
+        <div style=\{{marginLeft: '100px',marginBottom: '35px'}}>
+            <Tooltip target={( <IconApps />)} text="Высокое качество воспроизведения" placement="bottom" hasArrow isOpen />
+        </div>
+    );
+}
+```

package/styled-components/cjs/components/Typography/Typography.template-doc.mdx

@@ -0,0 +1,127 @@
+---
+id: typography
+title: Typography
+---
+
+# Typography
+В состав Plasma Web входят компоненты, реализующие типографическую систему [типографическую систему Plasma](../../design/typography).
+Они заменяют обычные HTML-теги, такие, как `h1`, `h2`, `h3`, `h4`, `p`, etc.
+
+## Установка шрифта
+Компоненты типографики используют фирменный шрифт **SB Sans Text**.
+О том, как установить данный шрифт, смотрите на странице [Типографическая система](../../design/typography#установка-шрифта).
+
+## Отступы
+По умолчанию типографика поддерживает стандартные отступы.
+О том, как использовать отступы, читайте на странице [Стандартные отступы](../../design/spacing#встроенные-отступы-в-типографике).
+
+## Переносы
+По умолчанию в типографике слова переносятся по слогам.
+Чтобы отключить данный функционал, необходимо установить свойство `breakWord` в значении `false`.
+
+## Состав
+
+### Hero unit
+
+```tsx live
+import React from 'react';
+import { DsplL, DsplM, DsplS } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div style=\{{ display: 'block' }}>
+            <DsplL bold={false}>DsplL</DsplL>
+            <DsplL>DsplL Bold</DsplL>
+
+            <DsplM bold={false}>DsplM</DsplM>
+            <DsplM>DsplM Bold</DsplM>
+
+            <DsplS bold={false}>DsplS</DsplS>
+            <DsplS>DsplS Bold</DsplS>
+        </div>
+    );
+}
+```
+
+### Заголовки
+
+```tsx live
+import React from 'react';
+import { H1, H2, H3, H4, H5 } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div style=\{{ display: 'block' }}>
+            <H1 bold={false}>H1</H1>
+            <H1>H1 Bold</H1>
+
+            <H2 bold={false}>H2</H2>
+            <H2>H2 Bold</H2>
+
+            <H3 bold={false}>H3</H3>
+            <H3>H3 Bold</H3>
+
+            <H4 bold={false}>H4</H4>
+            <H4>H4 Bold</H4>
+
+            <H5 bold={false}>H5</H5>
+            <H5>H5 Bold</H5>
+        </div>
+    );
+}
+```
+
+### Интерфейсы
+Типографика для таких частей интерфейса, как button, label, подписи, и т.п.
+
+```tsx live
+import React from 'react';
+import { BodyL, BodyM, BodyS, BodyXS, BodyXXS } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div style=\{{ display: 'block' }}>
+            <BodyL>BodyL</BodyL>
+            <BodyL bold>BodyL полужирный</BodyL>
+
+            <BodyM>BodyM</BodyM>
+            <BodyM bold>BodyM полужирный</BodyM>
+
+            <BodyS>BodyS</BodyS>
+            <BodyS bold>BodyS полужирный</BodyS>
+
+            <BodyXS>BodyXS</BodyXS>
+            <BodyXS bold>BodyXS полужирный</BodyXS>
+
+            <BodyXXS>BodyXXS</BodyXXS>
+            <BodyXXS bold>BodyXXS полужирный</BodyXXS>
+        </div>
+    );
+}
+```
+
+### Текст
+Типографические элементы для описаний к статьям, дополнительной информации и т.д.
+
+```tsx live
+import React from 'react';
+import { TextL, TextM, TextS, TextXS } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div style=\{{ display: 'block' }}>
+            <TextL>TextL</TextL>
+            <TextL bold>TextL полужирный</TextL>
+
+            <TextM>TextM</TextM>
+            <TextM bold>TextM полужирный</TextM>
+
+            <TextS>TextS</TextS>
+            <TextS bold>TextS полужирный</TextS>
+
+            <TextXS>TextXS</TextXS>
+            <TextXS bold>TextXS полужирный</TextXS>
+        </div>
+    );
+}
+```

package/styled-components/es/components/Avatar/Avatar.template-doc.mdx

@@ -0,0 +1,97 @@
+---
+id: avatar
+title: Avatar
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Avatar
+<Description name="Avatar" />
+<PropsTable name="Avatar" exclude={['css']} />
+
+
+## Примеры
+
+### Размер аватара
+Размер задается с помощью свойства `size`. Возможные значения свойства: `"xxl"`, `"l"`, `"m"`, `"s"`, `"fit"`.
+
+```tsx live
+import React from 'react';
+import { Avatar } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <>
+            <Avatar size="xxl" url="https://avatars.githubusercontent.com/u/1813468?v=4" />
+            <Avatar size="l" url="https://avatars.githubusercontent.com/u/1813468?v=4" />
+            <Avatar size="m" url="https://avatars.githubusercontent.com/u/1813468?v=4" />
+            <Avatar size="s" url="https://avatars.githubusercontent.com/u/1813468?v=4" />
+        </>
+    );
+}
+```
+
+### Инициалы вместо фотографии
+Инициалы можно задать с помощью свойства `name`. Желательный формат строки - "Имя Фамилия". Также не должно быть свойства url.
+
+```tsx live
+import React from 'react';
+import { Avatar } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <>
+            <Avatar name="Иван Фадеев" />
+        </>
+    );
+}
+```
+
+### Статус аватара
+Статус задается с помощью свойства `status`. Возможные значения: `"active"`, `"inactive"`.
+
+```tsx live
+import React from 'react';
+import { Avatar } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <>
+            <Avatar status="active" name="Иван Фадеев" />
+            <Avatar status="inactive" name="Иван Фадеев" />
+        </>
+    );
+}
+```
+
+### Увеличение при наведении
+Опциональное свойство `"isScalable"`.
+
+```tsx live
+import React from 'react';
+import { Avatar } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <>
+            <Avatar isScalable name="Иван Фадеев" />
+        </>
+    );
+}
+```
+
+### Доступность
+Добавляем `"role"` и `"tabIndex"`.
+
+```tsx live
+import React from 'react';
+import { Avatar } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <>
+            <Avatar role="button" tabIndex="0" name="Иван Фадеев" />
+        </>
+    );
+}
+```