0.16.3 • Published 2 months ago

@snack-uikit/modal v0.16.3

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 months ago

Modal

Installation

npm i @snack-uikit/modal

Changelog

Пакет экспортирует 2 компонента:

  • Modal - компонент модального окна с определенным поведением и параметрами
  • ModalCustom - конструктор модального окна, позволяющий собрать компонент самостоятельно Содержит в себе дополнительные компоненты:
    • ModalCustom.Header
    • ModalCustom.Body
    • ModalCustom.Footer

ModalCustom

Props

nametypedefault valuedescription
children*ReactNode-Контент
onClose*() => void-Колбек закрытия компонента.
open*boolean-Управляет состоянием показан/не показан.
modeenum Mode: "regular", "aggressive", "forced"regularРежим отображения модального окна: - Regular - есть кнопка закрытия, клик на оверлей и нажатие кнопки Esc закрывают модалку - Aggressive - есть кнопка закрытия, но выключен клик на оверлей и не работает закрытие по клавише Esc - Forced - закрыть модальное окно можно только по нажатию на кнопку действия в нижней части
sizeenum Size: "s", "m", "l"sРазмер модального окна
classNamestring-CSS-класс

ModalCustom.Header

Props

nametypedefault valuedescription
title*ReactNode-Заголовок модального окна
titleTooltipReactNode-Тултип для заголовка
subtitleReactNode-Подзаголовок
pictureJSXElementConstructor<{ size?: number; className?: string; }> \| ModalHeaderImage-Можно передать иконку из пакета @snack-uikit/icon-predefined или путь к картинке и атрибут alt
alignenum ContentAlign: "default", "center"-Выравнивание контента
classNamestring-CSS-класс

ModalCustom.Body

Props

nametypedefault valuedescription
content*ReactNode-Содержимое модального окна
alignenum ContentAlign: "default", "center"-Выравнивание контента
classNamestring-CSS-класс

ModalCustom.Footer

Props

nametypedefault valuedescription
actions*ReactNode-Параметр для передачи кнопок
disclaimerReactNode-Параметр для небольшого текста под кнопками
alignenum Align: "vertical", "default", "center"-Выравнивание контента
classNamestring-CSS-класс

Modal

Props

nametypedefault valuedescription
approveButton*Omit<ButtonFilledProps, "data-test-id" \| "size">-Основная кнопка действия
title*string-Заголовок модального окна
onClose*() => void-Колбек закрытия компонента.
open*boolean-Управляет состоянием показан/не показан.
modeenum Mode: "regular", "aggressive", "forced"regularРежим отображения модального окна: - Regular - есть кнопка закрытия, клик на оверлей и нажатие кнопки Esc закрывают модалку - Aggressive - есть кнопка закрытия, но выключен клик на оверлей и не работает закрытие по клавише Esc - Forced - закрыть модальное окно можно только по нажатию на кнопку действия в нижней части
classNamestring-CSS-класс
titleTooltipReactNode-Всплывающая подсказка для заголовка
subtitlestring-Подзаголовок
contentReactNode-Содержимое модального окна
cancelButtonOmit<ButtonOutlineProps, "data-test-id" \| "size">-Кнопка отмены
additionalButtonOmit<ButtonSimpleProps, "data-test-id" \| "size">-Вторая кнопка действия
disclaimer{ text: string; link?: Pick<LinkProps, "text" \| "href" \| "target">; }-Небольшой текст под кнопками футера с возможностью передать дополнительно ссылку
truncate{ title?: number; subtitle?: number; }'{ title: 1; subtitle: 2; }'Максимальное кол-во строк - title - в заголовке - subtitle - в подзаголовке
size"s" | "m" | "l"sРазмер
alignenum Align: "vertical", "default", "center"defaultВыравнивание, для разных размеров доступны разные значения для size=s - все для size=m - align=default \| center для size=l - align=default
pictureJSXElementConstructor<{ size?: number; className?: string; }> \| ModalHeaderImage-Можно передать иконку из пакета @snack-uikit/icon-predefined, или путь к картинке и атрибут alt
0.14.13

6 months ago

0.14.12

6 months ago

0.14.11

7 months ago

0.14.10

7 months ago

0.14.17

5 months ago

0.14.16

5 months ago

0.14.15

6 months ago

0.14.14

6 months ago

0.14.19

5 months ago

0.14.18

5 months ago

0.14.5

9 months ago

0.14.6

8 months ago

0.14.7

8 months ago

0.14.8

8 months ago

0.14.9

8 months ago

0.14.2

9 months ago

0.14.3

9 months ago

0.14.4

9 months ago

0.15.4

5 months ago

0.15.5

5 months ago

0.15.6

5 months ago

0.15.0

5 months ago

0.15.1

5 months ago

0.15.2

5 months ago

0.15.3

5 months ago

0.16.3

3 months ago

0.16.0

4 months ago

0.16.1

4 months ago

0.16.2

3 months ago

0.13.0

10 months ago

0.14.0

10 months ago

0.14.1

9 months ago

0.12.5

11 months ago

0.12.6

11 months ago

0.11.0

1 year ago

0.11.1

1 year ago

0.11.2

1 year ago

0.11.3

1 year ago

0.11.4

1 year ago

0.10.1

1 year ago

0.12.0

1 year ago

0.10.2

1 year ago

0.12.1

1 year ago

0.10.3

1 year ago

0.12.2

12 months ago

0.12.3

11 months ago

0.12.4

11 months ago

0.9.23

1 year ago

0.10.0

1 year ago

0.9.22

1 year ago

0.9.21

1 year ago

0.9.20

1 year ago

0.9.19

1 year ago

0.9.18

1 year ago

0.9.17

1 year ago

0.9.16

1 year ago

0.9.15

1 year ago

0.9.14

1 year ago

0.9.13

1 year ago

0.9.12

1 year ago

0.9.11

1 year ago

0.9.10

2 years ago

0.9.8

2 years ago

0.9.9

2 years ago

0.9.7

2 years ago

0.9.6

2 years ago

0.9.5

2 years ago

0.9.4

2 years ago

0.9.3

2 years ago

0.9.2

2 years ago

0.9.1

2 years ago

0.9.0

2 years ago

0.8.1

2 years ago

0.8.0

2 years ago