@salutejs/plasma-new-hope 0.67.0-canary.1148.8444175533.0 → 0.67.0-canary.1148.8449317874.0

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

@@ -0,0 +1,72 @@
+---
+id: popover
+title: Popover
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Popover
+<Description name="Popover" />
+<PropsTable name="Popover" />
+
+```tsx live
+import React from 'react';
+import styled from "styled-components";
+import { surfaceSolid03 } from "@salutejs/plasma-tokens/brands/{{ theme }}";
+import { Popover, Button } from '@salutejs/{{ package }}';
+
+export function App() {
+    const [isOpen, setIsOpen] = React.useState(false);
+
+    const StyledArrow = styled.div`
+        visibility: hidden;
+
+        &,
+        &::before {
+            position: absolute;
+            width: 0.5rem;
+            height: 0.5rem;
+            background: ${surfaceSolid03};
+        }
+
+        &::before {
+            visibility: visible;
+            content: '';
+            transform: rotate(45deg);
+        }
+    `;
+
+    const StyledContent = styled.div`
+        background: ${surfaceSolid03};
+        padding: 1rem;
+
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+    `;
+
+    return (
+        <section style=\{{width: '20rem', height: '15rem'}}>
+            <Popover
+                isOpen={isOpen}
+                onToggle={(is) => setIsOpen(is)}
+                role="presentation"
+                id="popover"
+                target={<Button>Target</Button>}
+                offset={[0, 6]}
+                arrow={<StyledArrow/>}
+                placement='bottom'
+                trigger='click'
+                closeOnOverlayClick
+                closeOnEsc
+                isFocusTrapped
+            >
+                <StyledContent>
+                    <>Content</>
+                    <Button onClick={() => setIsOpen(false)}>close</Button>
+                </StyledContent>
+            </Popover>
+        </section>
+    );
+}
+```

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

@@ -0,0 +1,209 @@
+---
+id: popupBase
+title: PopupBase
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# PopupBase
+<Description name="PopupBase" />
+<PropsTable name="PopupBase" />
+
+### Провайдер контекста
+
+Поместите `PopupBaseProvider` в [корень приложения](../../#корень-приложения) или там, где будете применять PopupBase:
+
+```tsx title="index.ts"
+import ReactDOM from 'react-dom';
+import { PopupBaseProvider } from '@salutejs/{{ package }}';
+
+import { App } from './App';
+
+ReactDOM.render(
+    <PopupBaseProvider>
+        <App />
+    </PopupBaseProvider>,
+    document.getElementById('root')
+);
+```
+
+### Использование
+
+PopupBase можно использовать как и на всем окне, так и в отдельном фрейме - свойство `frame`.
+Также это свойство поддерживает передачу id элемента, в котором будет использоваться компонент.
+Само позиционирование можно указать с помощью свойства `placement`(center - по умолчанию; left, right, top, bottom и их комбинации),
+ а также определить отступы от точки с помощью `offset`.
+
+```tsx live
+import React, { useRef } from 'react';
+import { surfaceSolid03, surfaceSolid02 } from '@salutejs/plasma-tokens/brands/{{ theme }}';
+import { SSRProvider, Button, PopupBase, PopupBaseProvider } from  '@salutejs/{{ package }}';
+
+export function App() {
+    const [isOpenA, setIsOpenA] = React.useState(false);
+    const [isOpenB, setIsOpenB] = React.useState(false);
+
+    const ref = useRef();
+
+    return (
+        <SSRProvider>
+            <PopupBaseProvider>
+                <div style=\{{height: "500px"}}>
+                    <div style=\{{ display: 'flex', flexDirection: 'column' }}>
+                        <Button 
+                            style=\{{
+                                marginTop: "1rem",
+                                width: "15rem"
+                            }} 
+                            text="Открыть в document" 
+                            onClick={() => setIsOpenB(true)} 
+                        />
+                        <Button 
+                            style=\{{
+                                marginTop: "1rem",
+                                width: "15rem"
+                            }} 
+                            text="Открыть во Frame" 
+                            onClick={() => setIsOpenA(true)} 
+                        />
+                    </div>
+                    <PopupBase
+                        id="popupA"
+                        frame={ref}
+                        isOpen={isOpenA}
+                        placement="center"
+                        offset={[0, 0]}
+                    >
+                        <div style=\{{ background: surfaceSolid02, padding: "1rem" }}>
+                            <Button onClick={() => setIsOpenA(false)}>Close</Button>
+                            <>Content</>
+                        </div>
+                    </PopupBase>
+                    <div 
+                        ref={ref} 
+                        style=\{{
+                            marginTop: "1rem",
+                            width: "400px",
+                            height: "500px",
+                            background: surfaceSolid03,
+                            position: "absolute",
+
+                            display: "flex",
+                            alignItems: "flex-start",
+                            justifyContent: "center",
+                            padding: "1rem",
+
+                            bottom: 0,
+                            right: 0
+                        }}
+                    >
+                        <>Frame</>
+                    </div>
+                    <PopupBase
+                        id="popupB"
+                        frame="document"
+                        isOpen={isOpenB}
+                        placement="center"
+                        offset={[0, 0]}
+                    >
+                        <Content>
+                            <Button onClick={() => setIsOpenB(false)}>Close</Button>
+                            <>Content</>
+                        </Content>
+                    </PopupBase>
+                </div>
+            </PopupBaseProvider>
+        </SSRProvider>
+    );
+}
+```
+
+## Подключение анимации
+
+Для подключения анимации нужно добавить параметр `withAnimation`.
+Само управление происходит с помощью классов через переменные `endAnimation`, `endTransition` из объекта `popupBaseClasses` для `PopupBase`.
+Для добавления анимации необходимо использовать класс `.popup-base-root` через переменную `popupBaseClasses.root` из пакета.
+
+Пример:
+
+```tsx
+const StyledPopupTransition = styled(PopupBase)`
+    && > .${popupBaseClasses.root} {
+        opacity: 1;
+        transition: opacity 0.5s 0.1s;
+    }
+
+    &&.${popupBaseClasses.endTransition} > .${popupBaseClasses.root} {
+        opacity: 0;
+        transition: opacity 0.5s 0.1s;
+    }
+`;
+```
+
+или
+
+```tsx
+const StyledPopupAnimation = styled(PopupBase)`
+    && > .${popupBaseClasses.root} {
+        animation: fadeIn 1s forwards;
+    }
+
+    &&.${popupBaseClasses.endAnimation} > .${popupBaseClasses.root} {
+        animation: fadeOut 1s forwards;
+    }
+
+    @keyframes fadeIn {
+        from {
+            opacity: 0;
+        }
+
+        to {
+            opacity: 1;
+        }
+    }
+
+    @keyframes fadeOut {
+        from {
+            opacity: 1;
+        }
+
+        to {
+            opacity: 0;
+        }
+    }
+`;
+```
+
+И в самом компоненте:
+
+```tsx
+    const [isOpen, setIsOpen] = React.useState(false);
+
+    return (
+        <>
+            <div>
+                <Button 
+                    style=\{{
+                        marginTop: "1rem",
+                        width: "15rem"
+                    }} 
+                    text="Открыть" 
+                    onClick={() => setIsOpen(true)} 
+                />
+            </div>
+            <StyledPopupAnimation
+                id="popup-id"
+                withAnimation
+                frame="document"
+                isOpen={isOpen}
+                placement="center"
+                offset={[0, 0]}
+            >
+                <div>
+                    <Button onClick={() => setIsOpen(false)}>Close</Button>
+                </div>
+            </StyledPopupAnimation>
+        </>
+    );
+}
+```

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

@@ -0,0 +1,38 @@
+---
+id: radiobox
+title: Radiobox
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Radiobox
+<Description name="Radiobox" />
+<PropsTable name="Radiobox" exclude={['css', 'focused']} />
+
+## Использование
+Компонент `Radiobox` может содержать лейбл и описание.
+
+По умолчанию, контент внутри лейбла и описания многострочный. 
+
+Для того чтобы стал однострочным, необходимо использовать свойство `singleLine`(по умолчанию `false`).
+
+```tsx live
+import React from 'react';
+import { Radiobox } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <Radiobox label="Радиокнопка" description="Описание" defaultChecked />
+    );
+}
+```
+
+## Группа радиокнопок
+Компоненты `Radiobox` следует объединять в `RadioGroup`
+```tsx live
+<RadioGroup aria-labelledby="radiogroup-title-id">
+    <H3 id="radiogroup-title-id">Заголовок</H3>
+    <Radiobox name="radio-1" label="Радиокнопка 1" description="Описание 1" defaultChecked />
+    <Radiobox name="radio-1" label="Радиокнопка 2" description="Описание 2" />
+</RadioGroup>
+```

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

@@ -0,0 +1,61 @@
+---
+id: segment
+title: Segment
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Segment
+Набор компонентов для создания группы сегментов.
+Структура для сегментов похожа на структуру маркированных списков.
+
+## SegmentGroup
+
+<Description name="SegmentGroup" />
+<PropsTable name="SegmentGroup"  exclude={['css', 'selectedView']} />
+
+## SegmentItem
+
+<Description name="SegmentItem" />
+<PropsTable name="SegmentItem"  exclude={['css', 'filledBackground', 'disabled']} />
+
+### Провайдер контекста
+
+Оберните в `SegmentProvider` компонент, в котором будут использованы SegmentGroup с SegmentItem. 
+Внутри данного провайдера есть доступ к хуку `useSegment`.
+
+```tsx live
+import React, { useState } from 'react';
+import { SegmentGroup, SegmentItem, SegmentProvider } from '@salutejs/{{ package }}';
+
+export function App() {
+    const items = Array(8).fill(0);
+
+    const SegmentTemplate = () => {
+        const {selectedSegmentItems} = useSegment();
+
+        return (
+            <>
+                <div>Выбранные элементы: {selectedSegmentItems.join(', ')}</div>
+                <SegmentGroup  view='filled' selectionMode='multiple' filledBackground pilled>
+                    {items.map((_, i) => (
+                        <SegmentItem
+                            label={`Label ${i}`}
+                            value={`label_${i}`}
+                            key={`label_${i}`}
+                            view='default'
+                            pilled
+                        />
+                    ))}
+                </SegmentGroup>
+            </>
+        )
+    }
+
+    return (
+        <SegmentProvider>
+            <SegmentTemplate/>
+        </SegmentProvider>
+    );
+}
+```

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

@@ -0,0 +1,115 @@
+---
+id: select
+title: Select
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Select
+<Description name="Select" />
+<PropsTable name="Select" />
+
+```tsx live
+import React, { useState } from 'react';
+import { Select } from '@salutejs/{{ package }}';
+
+export function App() {
+    const items = [
+        { value: 'each', label: 'Каждый' },
+        { value: 'hunter', label: 'Охотник', isDisabled: true },
+        { value: 'wants', label: 'Желает' },
+        {
+            value: 'toKnow',
+            label: 'Знать',
+            items: [
+                { value: '_fullText', label: 'Каждый охотник желает знать, где сидит фазан' },
+                { value: '_thePheasant', label: 'Фазан' },
+                { value: '_is', label: 'Сидит' },
+            ],
+        },
+        { value: 'where', label: 'Где' },
+        { value: 'is', label: 'Сидит' },
+        { value: 'thePheasant', label: 'Фазан' },
+        { value: 'fullText', label: 'Каждый охотник желает знать, где сидит фазан' },
+    ];
+
+    const [value, setValue] = useState(null);
+
+    return (
+        <div style=\{{ maxWidth: '20rem' }}>
+            <div style=\{{ marginBottom: '1rem' }}>
+                <Select
+                    value={value}
+                    items={items}
+                    onChange={(v) => {
+                        setValue(v);
+                    }}
+                    placeholder="Выберите пример"
+                    helperText="Заполните пример"
+                    status="success"
+                />
+            </div>
+            <div>
+                <Select value={null} items={[]} placeholder="Another select" />
+            </div>
+        </div>
+    );
+}
+```
+
+### Управление высотой выпадающего меню
+Что бы задать высоту и `scroll` для выпадающего меню можно использовать **props** для компонента `Select`:
+- **listOverflow**
+- **listHeight**
+
+> Эти **props** необязательные, если их не указать будет использовано значение - [initial](https://developer.mozilla.org/en-US/docs/Web/CSS/initial)
+
+```tsx live
+import React, { useState, useCallback } from 'react';
+import { Select, Modal, ModalsProvider, H3, Button } from '@salutejs/{{ package }}';
+
+export function App() {
+    const [value, setValue] = useState(null);
+    const [isOpenA, setIsOpenA] = useState(false);
+
+    const onCloseA = useCallback(() => setIsOpenA(false), []);
+
+    const items = [
+        { value: 'each', label: 'Каждый' },
+        { value: 'hunter', label: 'Охотник', isDisabled: true },
+        { value: 'wants', label: 'Желает' },
+        {
+            value: 'toKnow',
+            label: 'Знать',
+            items: [
+                { value: '_fullText', label: 'Каждый охотник желает знать, где сидит фазан' },
+                { value: '_thePheasant', label: 'Фазан' },
+                { value: '_is', label: 'Сидит' },
+            ],
+        },
+        { value: 'where', label: 'Где' },
+        { value: 'is', label: 'Сидит' },
+        { value: 'thePheasant', label: 'Фазан' },
+        { value: 'fullText', label: 'Каждый охотник желает знать, где сидит фазан' },
+    ];
+
+    return (
+        <section>
+            <ModalsProvider>
+                <Button text="Open modal" onClick={() => setIsOpenA(true)} />
+
+                <Modal style=\{{ "height": "20rem" }} id="modalA" isOpen={isOpenA} onClose={onCloseA}>
+                    <H3>Фильтр</H3>
+                    <Select
+                        value={value}
+                        onChange={setValue}
+                        items={items}
+                        listHeight={11}
+                        listOverflow="scroll"
+                    />
+                </Modal>
+            </ModalsProvider>
+        </section>
+    );
+}
+```

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

@@ -0,0 +1,103 @@
+---
+id: skeleton
+title: Skeleton
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Skeleton
+Набор компонентов для создания скелетов загрузки (плейсхолдеров).
+
+## LineSkeleton
+<Description name="LineSkeleton" />
+<PropsTable name="LineSkeleton" />
+
+```tsx live
+import React from 'react';
+import { LineSkeleton } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <LineSkeleton size="headline3" />
+    );
+}
+```
+
+## RectSkeleton
+<Description name="RectSkeleton" />
+<PropsTable name="RectSkeleton" />
+
+```tsx live
+import React from 'react';
+import { RectSkeleton } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <RectSkeleton width="12rem" height="8rem" />
+    );
+}
+```
+
+## TextSkeleton
+<Description name="TextSkeleton" />
+<PropsTable name="TextSkeleton" />
+
+```tsx live
+import React from 'react';
+import { TextSkeleton } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <TextSkeleton size="paragraph1" lines={4} />
+    );
+}
+```
+## На примере карточки
+
+```tsx live
+import React from 'react';
+import { Button, withSkeleton } from '@salutejs/{{ package }}';
+
+export function App() {
+    const ButtonSkeleton = withSkeleton(Button);
+
+    return (
+        <ButtonSkeleton
+            fullWidth
+            text="Загрузка..."
+            view="primary"
+            size="s"
+            scaleOnInteraction={false}
+            outlined={false}
+            skeleton={true}
+            tabIndex={-1}
+        />
+    );
+}
+```
+
+## Доступность
+При использование хока `withSkeleton` необходимо воспользоваться атрибутами WAI ARIA. Пример с кнопкой:
+
+```tsx
+import React, { useState } from 'react';
+import { Button } from '@salutejs/{{ package }}';
+
+const ButtonSkeleton = withSkeleton<ButtonProps & WithSkeletonProps>(BasicButton);
+
+export default function App () {
+    const [skeleton, setSkeleton] = useState(false);
+
+    return (
+        <ButtonSkeleton
+            type="button"
+            text={skeleton ? 'Загрузка' : 'Нажмите'}
+            skeleton={skeleton}
+            aria-busy={skeleton}
+            onClick={() => setSkeleton((prevValue) => !prevValue)}
+        />
+    );
+}
+```
+
+Таким образом, при `skeleton=true` и `aria-busy=true` скринридер будет оповещать о соответствующем статусе компонента.

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

@@ -0,0 +1,21 @@
+---
+id: spinner
+title: Spinner
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Spinner
+<Description name="Spinner" />
+<PropsTable name="Spinner" exclude={['css', 'focused']}/>
+
+```tsx live
+import React from 'react';
+import { Spinner } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <Spinner size={32} />
+    );
+}
+```

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

@@ -0,0 +1,24 @@
+---
+id: switch
+title: Switch
+---
+
+import { PropsTable, Description } from '@site/src/components';
+
+# Switch
+<Description name="Switch" />
+<PropsTable name="Switch" />
+
+## Использование
+Компонент `Switch` может содержать лейбл.
+
+```tsx live
+import React from 'react';
+import { Switch } from '@salutejs/{{ package }}';
+
+export function App() {
+    return (
+        <Switch label="Переключатель" defaultChecked />
+    );
+}
+```