0.6.19 • Published 4 days ago

@snack-uikit/drawer v0.6.19

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 days ago

Drawer

Installation

npm i @snack-uikit/drawer

Changelog

DrawerCustom

Компонент-конструктор

Props

nametypedefault valuedescription
onClose*() => void-Колбэк закрытия
open*boolean-Управление состоянием показан/не показан.
modeenum Mode: "regular", "soft"-Режим отображения
positionenum Position: "right", "left"-Расположение открытого Drawer
classNamestring-CSS-класс для элемента с контентом
rootClassNamestring-CSS-класс для корневого элемента
sizestring \| number-Размер
pushboolean \| PushConfig-Смещение при открытии "вложенного" компонента
containerstring \| HTMLElement-Контейнер в котором будет рендерится Drawer. По-умолчанию - body
nestedDrawerReactElement<DrawerCustomProps, string \| JSXElementConstructor<any>>-Вложенный Drawer

Drawer

Готовый компонент Drawer

Props

nametypedefault valuedescription
title*string-Заголовок
content*ReactNode-Контент
onClose*() => void-Колбэк закрытия
open*boolean-Управление состоянием показан/не показан.
modeenum Mode: "regular", "soft"-Режим отображения
positionenum Position: "right", "left"-Расположение открытого Drawer
classNamestring-CSS-класс для элемента с контентом
rootClassNamestring-CSS-класс для корневого элемента
containerstring \| HTMLElement-Контейнер в котором будет рендерится Drawer. По-умолчанию - body
titleTooltipReactNode-Тултип для заголовка
image{ src: string; alt: string; }-Изображение
subtitlestring-Подзаголовок
sizeenum Size: "s", "m", "l"-Размер
approveButtonOmit<ButtonFilledProps, "data-test-id" \| "size">-Основная кнопка
cancelButtonOmit<ButtonOutlineProps, "data-test-id" \| "size">-Кнопка отмены
additionalButtonOmit<ButtonSimpleProps, "data-test-id" \| "size">-Дополнительная кнопка
nestedDrawerReactElement<DrawerProps, string \| JSXElementConstructor<any>>-Вложенный Drawer

DrawerCustom.Header

Вспомогательный компонент для добавления "шапки" в DrawerCustom

Props

nametyperequireddefault valuedescription
titlestringtrue-Заголовок
titleTooltipReactNodefalse-Тултип для заголовка
subtitlestringfalse-Подзаголовок
image{ src: string; alt: string; }false-Изображение
classNamestringfalse-CSS-класс

DrawerCustom.Body

Вспомогательный компонент для добавления "тела" в DrawerCustom

Props

nametyperequireddefault valuedescription
contentReactNodetrue-Контент
classNamestringfalse-CSS-класс

DrawerCustom.Footer

Вспомогательный компонент для добавления "футера" в DrawerCustom

Props

nametyperequireddefault valuedescription
actionsReactNodetrue-Слот для добавления кнопок-действий
classNamestringfalse-CSS-класс