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

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

@@ -0,0 +1,208 @@
+---
+id: calendar
+title: Calendar
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Calendar
+Компоненты календарей для выбора даты или диапазона дат.
+
+## Calendar
+
+<Description name="Calendar" />
+<PropsTable name="Calendar" />
+
+Представляет собой универсальный компонент `Calendar`, в котором можно настроить любое доступное представление: базовый, двойной, базовый с диапазоном, двойной с диапазоном.
+
+```tsx live
+import React from 'react';
+import { Calendar } from '@salutejs/{{ package }}';
+
+export function App() {
+    const isRange = false;
+    const isDouble = false;
+    const min = new Date(2022, 4, 0);
+    const max = new Date(2022, 6, 15);
+    const date = {
+        day: 6,
+        monthIndex: 5,
+        year: 2022,
+    }
+
+    const [value, setValue] = React.useState(new Date(2022, 5, 6));
+    const [valueRange, setValueRange] = React.useState([new Date(2022, 5, 6), new Date(2022, 5, 10)]);
+
+    const handleOnChange = React.useCallback((newValue) => {
+        setValue(newValue);
+    }, []);
+    const handleOnRangeChange = React.useCallback((newValue) => {
+        setValueRange(newValue);
+    }, []);
+
+    const baseEvents = [
+        {
+            date: new Date(2022, 5, 6),
+        },
+        {
+            date: new Date(2022, 5, 10),
+            color: 'red',
+        },
+        {
+            date: new Date(2022, 5, 10),
+            color: 'green',
+        },
+        {
+            date: new Date(2022, 5, 10),
+            color: 'blue',
+        },
+    ];
+
+    const eventsRange = Array.from(Array(10),((_, day) => ({
+        date: new Date(2022, 5, 15 + day),
+        color: 'purple',
+    })));
+
+    const disabledDays = Array.from(Array(5),((_, day) => ({
+        date: new Date(2022, 5, 11 + day),
+
+    })));
+
+    return (
+        <div>
+            <Calendar
+                isRange={isRange}
+                isDouble={isDouble}
+                value={(isRange ? valueRange : value)}
+                eventList={[...baseEvents, ...eventsRange]}
+                disabledList={disabledDays}
+                date={date}
+                min={min}
+                max={max}
+                onChangeValue={(isRange ? handleOnRangeChange : handleOnChange)}
+            />
+        </div>
+    );
+}
+```
+
+## CalendarBase
+<Description name="CalendarBase" />
+<PropsTable name="CalendarBase" />
+
+```tsx live
+import React from 'react';
+import { CalendarBase } from '@salutejs/{{ package }}';
+
+export function App() {
+    const min = new Date(2022, 4, 0);
+    const max = new Date(2022, 7, 15);
+
+    const [value, setValue] = React.useState(new Date(2022, 5, 6));
+    const handleOnChange = React.useCallback((newValue) => {
+        setValue(newValue);
+    }, []);
+
+    return (
+        <div>
+            <CalendarBase
+                value={value}
+                min={min}
+                max={max}
+                onChangeValue={handleOnChange}
+            />
+        </div>
+    );
+}
+```
+
+## CalendarDouble
+<Description name="CalendarDouble" />
+<PropsTable name="CalendarDouble" />
+
+```tsx live
+import React from 'react';
+import { CalendarDouble } from '@salutejs/{{ package }}';
+
+export function App() {
+    const min = new Date(2022, 4, 0);
+    const max = new Date(2022, 7, 15);
+
+    const [value, setValue] = React.useState(new Date(2022, 5, 6));
+    const handleOnChange = React.useCallback((newValue) => {
+        setValue(newValue);
+    }, []);
+
+    return (
+        <div>
+            <CalendarDouble
+                value={value}
+                min={min}
+                max={max}
+                onChangeValue={handleOnChange}
+            />
+        </div>
+    );
+}
+```
+
+## CalendarBaseRange
+<Description name="CalendarBaseRange" />
+<PropsTable name="CalendarBaseRange" />
+
+```tsx live
+import React from 'react';
+import { CalendarBaseRange } from '@salutejs/{{ package }}';
+
+export function App() {
+    const min = new Date(2022, 4, 0);
+    const max = new Date(2022, 7, 15);
+
+    const [value, setValue] = React.useState([new Date(2022, 5, 6), new Date(2022, 5, 16)]);
+    const handleOnChange = React.useCallback((newValue) => {
+        setValue(newValue);
+    }, []);
+
+    return (
+        <div>
+            <CalendarBaseRange
+                value={value}
+                min={min}
+                max={max}
+                onChangeValue={handleOnChange}
+            />
+        </div>
+    );
+}
+```
+
+## CalendarDoubleRange
+<Description name="CalendarDoubleRange" />
+<PropsTable name="CalendarDoubleRange" />
+
+```tsx live
+import React from 'react';
+import { CalendarDoubleRange } from '@salutejs/{{ package }}';
+
+export function App() {
+    const min = new Date(2022, 4, 0);
+    const max = new Date(2022, 7, 15);
+
+    const [value, setValue] = React.useState([new Date(2022, 5, 6), new Date(2022, 6, 16)]);
+    const handleOnChange = React.useCallback((newValue) => {
+        setValue(newValue);
+    }, []);
+
+    return (
+        <div>
+            <CalendarDoubleRange
+                value={value}
+                min={min}
+                max={max}
+                onChangeValue={handleOnChange}
+            />
+        </div>
+    );
+}
+```
+

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

@@ -0,0 +1,44 @@
+---
+id: checkbox
+title: Checkbox
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Checkbox
+<Description name="Checkbox" />
+<PropsTable name="Checkbox" exclude={['css', 'focused']} />
+
+## Использование
+Компонент `Checkbox` может содержать лейбл и описание.
+
+```tsx live
+import React from 'react';
+import { Checkbox } from '@salutejs/s{{package}}';
+
+export function App() {
+    return (
+        <Checkbox label="Чекбокс" description="Описание" defaultChecked />
+    );
+}
+```
+
+Свойства `description` и `label` могут принимать JSX элементы.
+
+По умолчанию, контент внутри лейбла и описания многострочный.
+
+Для того чтобы стал однострочным, необходимо использовать свойство `singleLine`(по умолчанию `false`).
+
+```tsx live
+import React from 'react';
+import { Checkbox } from '@salutejs/s{{package}}';
+
+export function App() {
+    return (
+        <Checkbox
+            label={<div>Чекбокс со <a href="/#">ссылкой</a></div>}
+            description={<div>Описание чекбокса со <a href="/#">ссылкой</a></div>}
+        />
+    );
+}
+```

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

@@ -0,0 +1,90 @@
+---
+id: chip
+title: Chip
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Chip
+Chips могут отображаться в нескольких размерах и цветах, могут содержать текст и/или иконку.
+
+## Chip
+<Description name="Chip" />
+<PropsTable name="Chip" exclude={['css', 'focused']} />
+
+## Использование
+Компонент `Chip` может содержать текст, который указывается в
+свойстве `text`, или любой контент напрямую через `children`.
+
+Свойство `text` можно использовать вместе со свойствами `contentLeft` и `contentRight`.
+С их помощью можно размещать **иконку** слева или справа от текста.
+
+Так же есть свойство `contentClearButton`, которое позволяет прокинуть custom **иконку**.
+
+```tsx live
+import React from 'react';
+import { Chip } from '@salutejs/{{ package }}';
+import { IconDownload } from '@salutejs/plasma-icons';
+
+export function App() {
+    return (
+        <div>
+            <Chip text="Текст" />
+
+            <Chip text="Текст" contentLeft={<IconDownload color="inherit" />} />
+
+            <Chip contentLeft={<IconDownload color="inherit" />} />
+
+            <Chip text="Текст" />
+
+            <Chip text="Текст" contentLeft={<IconDownload color="inherit" />} />
+
+            <Chip>
+                Текст
+            </Chip>
+        </div>
+    );
+}
+```
+
+## Примеры
+
+### Размер Chip
+Размер Chip задается с помощью свойства `size`. Возможные значения свойства: `"l"`, `"m"`, `"s"` или `"xs"`:
+
+```tsx live
+import React from 'react';
+import { Chip } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <Chip text="Chip" size="l" />
+            <Chip text="Chip" size="m" />
+            <Chip text="Chip" size="s" />
+            <Chip text="Chip" size="xs" />
+        </div>
+    );
+}
+```
+
+### Вид Chip
+Вид Chip задается с помощью свойства `view`. Возможные значения свойства `view`:
++ `"default"` – основная;
++ `"secondary"` – вторичная;
++ `"positive"` – успешное завершение;
+
+```tsx live
+import React from 'react';
+import { Chip } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <Chip text="Chip" size="m" view="default" />
+            <Chip text="Chip" size="m" view="secondary" />
+            <Chip text="Chip" size="m" view="positive" />
+        </div>
+    );
+}
+```

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

@@ -0,0 +1,237 @@
+---
+id: combobox
+title: Combobox
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Combobox
+Компонент, отвечающий за выпадающий список с возможностью фильтрации элементов и их выбора.
+Доступен в двух режимах: единичный и множественный выбор.
+
+## Combobox
+<Description name="Combobox" />
+<PropsTable name="Combobox" exclude={['css', 'focused']} />
+
+## Использование
+Компонент `Combobox` должен содержать компоненты из следующего списка: `ComboboxDivider`, `ComboboxFooter`, `ComboboxGroup`, `ComboboxHeader`, `ComboboxItem`.
+Для управления режимом, необходимо установить свойство `valueType = 'single'` для единичного выбора и `valueType='multiple'` для множественного. 
+Так же для выбора отображения множественного режима свойство `enumerationType = 'comma'` для перечисления выбранных значений через запятую,
+и `enumerationType = 'chip'` для перечисления выбранных значений с помощью компонента `Chip`.
+
+## Клавиатурная навигация
+
+Данный компонент может полностью управляться с помощью клавиатуры, используя следующие клавиши:
+-  `Tab` - переход на таргет (инпут)
+-  `Shift` + `tab` - выход с него (теряем фокус)
+-  `Стрелка вверх` / `стрелка вниз` - открыть выпадающий список и переместиться на первый элемент
+-  `Стрелка вверх` / `стрелка вниз` ходим по элементам с зацикливанием
+-  `Enter` - выбираем элемент, закрываем выпадающий список и переходим фокусом снова на таргет (инпут)
+-  Если мы ходим по селекту и нажимаем `Tab` - выпадающий список закрывается и теряем фокус
+-  Если мы ходим по селекту и нажимаем `Escape` - выпадающий список закрывается и фокусом остаёмся на таргете
+-  В мультиселекте то же самое кроме закрытия выпадающего списка при выборе элемента
+-  Когда находимся на первом чипе, нажимаем `стрелку влево` / `стрелку вправо` - переходим по чипам
+-  Когда оказываемся на последнем чипе и нажимаем `стрелку вправо` - переходим на таргет (инпут)  
+-  Когда находимся на таргете (инпуте) и нажимаем `Backspace` - удаляется последний чип
+-  Когда находимся на таргете (инпуте) и нажимаем `стрелку влево` - переходим на последний чип
+-  Нажимаем `Backspace` - удаляем выбранный чип и переходим на предыдущий
+-  Если удалили последний чип, то фокусируемся на таргете
+-  Если находимся в выборе элемента из выпадающего списка и нажимаем `стрелку влево` / `стрелку вправо` - попадаем на самый последний чип
+-  Если находимся в режиме выбора элемента и нажимаем `стрелку вниз` / `стрелку вверх` находясь на последнем / первом элементе, то перескакиваем в начало / в конец
+-  Если находимся в режиме выбора элемента и нажимаем любую клавишу **кроме** `стрелки вниз` / `вверх` / `влево` / `вправо` / `Escape` / `Tab` / `Enter`, то переходим на таргет (инпут) и вводим значения
+-  Ввод значение в таргет (инпут) приводит к фильтрации элементов в выпадающем списке. Если значение не соответствует ни одному элементу, то отобразится сообщение "Элементы не найдены"
+
+### Single 
+
+```tsx live
+import React from 'react';
+import { Combobox, ComboboxItem } from '@salutejs/{{ package }}';
+import { IconDone } from '@salutejs/plasma-icons';
+
+export function App() {
+    const [value, setValue] = React.useState(undefined);
+    const handleOnChange = React.useCallback((newValue) => {
+        setValue(newValue);
+    }, []);
+
+    return (
+        <div>
+            <Combobox value={value} onChangeValue={handleOnChange} frame="document" usePortal placeholder="Placeholder">
+                <ComboboxItem value={undefined} text="Clear" />
+                <ComboboxItem
+                    value="item_0"
+                    text="item 0"
+                    contentLeft={"item_0" === value ? <IconDone size="s" color="inherit" /> : undefined}
+                />
+                <ComboboxItem
+                    value="item_1"
+                    text="item 1"
+                    contentLeft={"item_1" === value ? <IconDone size="s" color="inherit" /> : undefined}
+                />
+                <ComboboxItem
+                    value="extra_item_0"
+                    text="extra item 0"
+                    contentLeft={"extra_item_0" === value ? <IconDone size="s" color="inherit" /> : undefined}
+                />
+                <ComboboxItem
+                    value="extra_item_1"
+                    text="extra item 1"
+                    contentLeft={"extra_item_1" === value ? <IconDone size="s" color="inherit" /> : undefined}
+                />
+                <ComboboxItem
+                    value="extra_item_2"
+                    text="extra item 2"
+                    contentLeft={"extra_item_2" === value ? <IconDone size="s" color="inherit" /> : undefined}
+                />
+            </Combobox>
+        </div>
+    );
+}
+```
+
+### Multiple
+
+```tsx live
+import React from 'react';
+import { Combobox, ComboboxItem, Checkbox } from '@salutejs/{{ package }}';
+
+export function App() {
+    const [value, setValue] = React.useState(['item_0']);
+    const handleOnChange = React.useCallback((newValue) => {
+        setValue(newValue);
+    }, []);
+
+    return (
+        <div>
+            <Combobox 
+                    value={value} 
+                    onChangeValue={handleOnChange} 
+                    frame="document" 
+                    usePortal 
+                    valueType="multiple"
+                    enumerationType="chip"
+                    label="Label">
+                <ComboboxItem value={undefined} text="Clear" />
+                <ComboboxItem
+                    value="item_0"
+                    text="item 0"
+                    contentLeft={Checkbox}
+                />
+                <ComboboxItem
+                    value="item_1"
+                    text="item 1"
+                    contentLeft={Checkbox}
+                />
+                <ComboboxItem
+                    value="extra_item_0"
+                    text="extra item 0"
+                    contentLeft={Checkbox}
+                />
+                <ComboboxItem
+                    value="extra_item_1"
+                    text="extra item 1"
+                    contentLeft={Checkbox}
+                />
+                <ComboboxItem
+                    value="extra_item_2"
+                    text="extra item 2"
+                    contentLeft={Checkbox}
+                />
+            </Combobox>
+        </div>
+    );
+}
+```
+
+## Примеры
+
+### Размер Combobox
+Размер `Combobox` задается с помощью свойства `size`.
+Возможные значения свойства: `"l"`, `"m"`, `"s"` или `"xs"`, а также соответствующие размеры компонент `Checkbox` и `IconDone`:
+
+Для иконок верно такое соответствие размеров (`Icon = Combobox`): 
+- xs = xs,
+- s = s,
+- m = s,
+- l = s,
+
+Для `Checkbox` / `Radiobox` верно такое соответствие размеров (`Checkbox / Radiobox = Combobox`): 
+- xs = s,
+- s = m,
+- m = m,
+- l = m,
+
+```tsx live
+import React from 'react';
+import { Combobox } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div style=\{{flexDirection: 'column'}}>
+            <Combobox usePortal frame="document" label="Label" size="xs" />
+            <Combobox usePortal frame="document" label="Label" size="s" />
+            <Combobox usePortal frame="document" label="Label" size="m" />
+            <Combobox usePortal frame="document" label="Label" size="l" />
+        </div>
+    );
+}
+```
+
+### Применение пользовательского фильтра 
+`Combobox` поддерживает возможность создавать собственные правила для фильтрации списка элементов с помощью функции колбэка `filterFunction`,
+которая срабатывает на каждый элемент и если возвращает `true`, то элемент рендерится, иначе нет.
+
+```tsx live
+import React from 'react';
+import { Combobox } from '@salutejs/{{ package }}';
+
+export function App() {
+    const [value, setValue] = React.useState(['item_0']);
+    const handleOnChange = React.useCallback((newValue) => {
+        setValue(newValue);
+    }, []);
+
+    const customFilterFunction = React.useCallback((childText, filterValue) => {
+        return childText.startWith(filterValue);
+    }, []);
+
+    return (
+        <div style=\{{flexDirection: 'column'}}>
+             <Combobox 
+                    value={value} 
+                    onChangeValue={handleOnChange} 
+                    frame="document" 
+                    usePortal 
+                    valueType="multiple"
+                    label="Label">
+                <ComboboxItem value={undefined} text="Clear" />
+                <ComboboxItem
+                    value="item_0"
+                    text="item 0"
+                    contentLeft={Checkbox}
+                />
+                <ComboboxItem
+                    value="item_1"
+                    text="item 1"
+                    contentLeft={Checkbox}
+                />
+                <ComboboxItem
+                    value="extra_item_0"
+                    text="extra item 0"
+                    contentLeft={Checkbox}
+                />
+                <ComboboxItem
+                    value="extra_item_1"
+                    text="extra item 1"
+                    contentLeft={Checkbox}
+                />
+                <ComboboxItem
+                    value="extra_item_2"
+                    text="extra item 2"
+                    contentLeft={Checkbox}
+                />
+            </Combobox>
+        </div>
+    );
+}
+```

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

@@ -0,0 +1,76 @@
+---
+id: counter
+title: Counter
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Counter
+<Description name="Counter" />
+<PropsTable name="Counter"  exclude={['css']} />
+
+## Примеры
+
+### Максимальное значение числового бейджа
+Задается с помощью свойства `maxCount`.
+
+```tsx live 
+import React from 'react';
+import { Counter } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <Counter count={10} maxCount={9} />
+            <Counter count={100} maxCount={99} />
+        </div>
+    );
+}
+```
+
+### Размер числового бейджа
+Размер задается с помощью свойства `size`. Возможные значения свойства: `"xs"` или `"xxs"`.
+
+```tsx live 
+import React from 'react';
+import { Counter } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <Counter count={10} size="xs" />
+            <Counter count={10} size="xxs" />
+        </div>
+    );
+}
+```
+
+### Вид числового бейджа
+Вид задается с помощью свойства `view`. Возможные значения свойства `view`:
+
++ `"primary"` – основной бейдж;
++ `"accent"` – бейдж акцентного цвета;
++ `"positive"` – успешное завершение;
++ `"warning"` – предупреждение;
++ `"negative"` – ошибка;
++ `"dark"` – темный бэйдж;
++ `"light"` – светлый бэйдж.
+
+```tsx live 
+import React from 'react';
+import { Counter } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <div>
+            <Counter count={10} view="primary" />
+            <Counter count={10} view="accent" />
+            <Counter count={10} view="positive" />
+            <Counter count={10} view="warning" />
+            <Counter count={10} view="negative" />
+            <Counter count={10} view="dark" />
+            <Counter count={10} view="light" />
+        </div>
+    );
+}
+```