@steroidsjs/core 3.0.0-beta.57 → 3.0.0-beta.59

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/docs-autogen-result.json +1378 -550
  2. package/package.json +1 -1
  3. package/ui/content/Accordion/Accordion.d.ts +17 -0
  4. package/ui/content/Alert/Alert.d.ts +16 -0
  5. package/ui/content/Avatar/Avatar.d.ts +12 -0
  6. package/ui/content/Badge/Badge.d.ts +11 -0
  7. package/ui/content/Calendar/Calendar.d.ts +12 -0
  8. package/ui/content/Card/Card.d.ts +9 -0
  9. package/ui/content/CopyToClipboard/CopyToClipboard.d.ts +13 -0
  10. package/ui/content/Detail/Detail.d.ts +14 -0
  11. package/ui/content/DropDown/DropDown.d.ts +6 -0
  12. package/ui/content/Icon/Icon.d.ts +5 -0
  13. package/ui/content/Menu/Menu.d.ts +15 -0
  14. package/ui/content/Slider/Slider.d.ts +13 -1
  15. package/ui/crud/Crud/Crud.d.ts +31 -0
  16. package/ui/form/AutoCompleteField/AutoCompleteField.d.ts +12 -2
  17. package/ui/form/BlankField/BlankField.d.ts +11 -0
  18. package/ui/form/CheckboxField/CheckboxField.d.ts +1 -0
  19. package/ui/form/CheckboxListField/CheckboxListField.d.ts +2 -0
  20. package/ui/form/DateField/DateField.d.ts +9 -0
  21. package/ui/form/DateRangeField/DateRangeField.d.ts +5 -1
  22. package/ui/form/DateTimeField/DateTimeField.d.ts +8 -0
  23. package/ui/form/DateTimeRangeField/DateTimeRangeField.d.ts +6 -1
  24. package/ui/form/DropDownField/DropDownField.d.ts +7 -2
  25. package/ui/form/Field/Field.d.ts +3 -2
  26. package/ui/form/FieldLayout/FieldLayout.d.ts +3 -1
  27. package/ui/form/FileField/FileField.d.ts +7 -0
  28. package/ui/form/Form/Form.d.ts +3 -1
  29. package/ui/form/HtmlField/HtmlField.d.ts +1 -1
  30. package/ui/form/ImageField/ImageField.d.ts +5 -0
  31. package/ui/form/MaskField/MaskField.d.ts +5 -0
  32. package/ui/form/NavField/NavField.d.ts +5 -2
  33. package/ui/form/NumberField/NumberField.d.ts +3 -2
  34. package/ui/form/PasswordField/PasswordField.d.ts +4 -2
  35. package/ui/form/RadioField/RadioField.d.ts +5 -0
  36. package/ui/form/TextField/TextField.d.ts +1 -1
  37. package/ui/form/TimeRangeField/TimeRangeField.d.ts +5 -0
  38. package/ui/format/BooleanFormatter/BooleanFormatter.d.ts +6 -0
  39. package/ui/format/DateFormatter/DateFormatter.d.ts +6 -0
  40. package/ui/format/DateTimeFormatter/DateTimeFormatter.d.ts +6 -0
  41. package/ui/format/EnumFormatter/EnumFormatter.d.ts +6 -0
  42. package/ui/format/FileSize/FileSize.d.ts +6 -0
  43. package/ui/format/Format/Format.d.ts +6 -0
  44. package/ui/format/MoneyFormatter/MoneyFormatter.d.ts +6 -0
  45. package/ui/layout/Header/Header.d.ts +6 -0
  46. package/ui/layout/Loader/Loader.d.ts +6 -0
  47. package/ui/layout/Notifications/Notifications.d.ts +3 -0
  48. package/ui/layout/Skeleton/Skeleton.d.ts +4 -0
  49. package/ui/layout/Tooltip/Tooltip.d.ts +3 -0
  50. package/ui/list/ControlsColumn/ControlsColumn.d.ts +2 -3
  51. package/ui/list/Steps/Steps.d.ts +3 -0
  52. package/ui/modal/ModalPortal/ModalPortal.d.ts +3 -0
  53. package/ui/modal/TwoFactorModal/TwoFactorModal.d.ts +3 -0
  54. package/ui/nav/Breadcrumbs/Breadcrumbs.d.ts +2 -3
  55. package/ui/nav/ButtonGroup/ButtonGroup.d.ts +3 -0
  56. package/ui/nav/ButtonGroup/ButtonGroup.js +3 -3
@@ -1,5 +1,11 @@
1
1
  /// <reference types="react" />
2
2
  import { DataProviderItems } from '../../../hooks/useDataProvider';
3
+ /**
4
+ * IEnumFormatterProps
5
+ *
6
+ * Компонент EnumFormatter предназначен для форматирования перечисления элементов с использованием заданного формата.
7
+ * Он позволяет кастомизировать отображение элементов, используя переданный view React компонент.
8
+ **/
3
9
  export interface IEnumFormatterProps {
4
10
  /**
5
11
  * Перечисление элементов.
@@ -1,4 +1,10 @@
1
1
  /// <reference types="react" />
2
+ /**
3
+ * IFileSizeFormatterProps
4
+ *
5
+ * Компонент FileSize предназначен для форматирования размера файла в человеко-читаемом формате.
6
+ * Он позволяет кастомизировать отображение размера файла, используя переданный view React компонент.
7
+ **/
2
8
  export interface IFileSizeFormatterProps extends IUiComponent {
3
9
  /**
4
10
  * Если не указан размер файла, то в случае, если showZero = true
@@ -1,4 +1,10 @@
1
1
  /// <reference types="react" />
2
+ /**
3
+ * IFormatProps
4
+ *
5
+ * Компонент Format предназначен для форматирования значения на основе заданного форматтера.
6
+ * Он позволяет кастомизировать отображение значения, используя переданный view React компонент.
7
+ **/
2
8
  export interface IFormatProps {
3
9
  attribute?: string;
4
10
  model?: string | ((...args: any[]) => any) | any;
@@ -1,4 +1,10 @@
1
1
  /// <reference types="react" />
2
+ /**
3
+ * IMoneyFormatterProps
4
+ *
5
+ * Компонент MoneyFormatter предназначен для форматирования денежных значений с учетом валюты и округления.
6
+ * Он позволяет кастомизировать отображение денежного значения, используя переданный view React компонент.
7
+ **/
2
8
  export interface IMoneyFormatterProps {
3
9
  /**
4
10
  * Валюта @enum {eur, rub, usd}
@@ -1,5 +1,11 @@
1
1
  /// <reference types="react" />
2
2
  import { INavProps } from '../../nav/Nav/Nav';
3
+ /**
4
+ * IHeaderProps
5
+ *
6
+ * Компонент Header представляет собой верхнюю часть макета страницы.
7
+ * Он может содержать логотип и навигацию, а также кастомизироваться с помощью переданного view React компонента.
8
+ **/
3
9
  export interface IHeaderProps extends IUiComponent {
4
10
  /**
5
11
  * Свойства для логотипа
@@ -1,4 +1,10 @@
1
1
  /// <reference types="react" />
2
+ /**
3
+ * ILoaderProps
4
+ *
5
+ * Компонент Loader представляет собой индикатор загрузки,
6
+ * который может использоваться для обозначения процесса загрузки данных или выполнения операции.
7
+ **/
2
8
  export interface ILoaderProps {
3
9
  /**
4
10
  * Размер элемента
@@ -30,6 +30,9 @@ interface INotificationItem {
30
30
  message?: string;
31
31
  isClosing?: boolean;
32
32
  }
33
+ /**
34
+ * Компонент Notifications представляет собой контейнер для отображения всплывающих уведомлений.
35
+ **/
33
36
  export interface INotificationsProps {
34
37
  /**
35
38
  * Исходные уведомления
@@ -7,6 +7,10 @@ export interface ISkeletonViewProps {
7
7
  height?: string | number;
8
8
  width?: string | number;
9
9
  }
10
+ /**
11
+ * Компонент Skeleton представляет собой заглушку для отображения временных данных
12
+ * во время загрузки или ожидания загрузки реальных данных.
13
+ **/
10
14
  export interface ISkeletonProps {
11
15
  /**
12
16
  * Дополнительные CSS классы
@@ -36,6 +36,9 @@ export interface ITooltipStylePosition {
36
36
  */
37
37
  top: 'unset' | number;
38
38
  }
39
+ /**
40
+ * Компонент Tooltip предоставляет всплывающую подсказку для дочерних элементов.
41
+ **/
39
42
  export interface ITooltipProps {
40
43
  /**
41
44
  * Текст подсказки
@@ -6,9 +6,8 @@ export interface IControlsColumnItem extends IButtonProps {
6
6
  visible?: boolean;
7
7
  }
8
8
  /**
9
- * ControlsColumn
10
- * Колонка для контролов
11
- */
9
+ * Компонент ControlsColumn предоставляет колонку с контролами.
10
+ **/
12
11
  export interface IControlsColumnProps {
13
12
  /**
14
13
  * Первичный ключ
@@ -1,4 +1,7 @@
1
1
  import React from 'react';
2
+ /**
3
+ * Компонент Steps предоставляет шаги для выполнения определенного процесса.
4
+ **/
2
5
  interface IStepsProps {
3
6
  stepItems: IStepItem[];
4
7
  currentStep: number;
@@ -1,4 +1,7 @@
1
1
  /// <reference types="react" />
2
+ /**
3
+ * Компонент ModalPortal отвечает за отображение модальных окон.
4
+ **/
2
5
  export interface IModalPortalProps {
3
6
  /**
4
7
  * Время, через которое произойдет закрытие Modal
@@ -18,6 +18,9 @@ interface ITwoFactorModalPrivateProps extends ITwoFactorModalProps {
18
18
  isConfirmed: string;
19
19
  };
20
20
  }
21
+ /**
22
+ * Компонент TwoFactorModal отображает модальное окно для двухфакторной аутентификации.
23
+ **/
21
24
  export interface ITwoFactorModalViewProps extends ITwoFactorModalPrivateProps {
22
25
  description?: string;
23
26
  formProps?: any;
@@ -1,9 +1,8 @@
1
1
  /// <reference types="react" />
2
2
  import { IRouteItem } from '../Router/Router';
3
3
  /**
4
- * Breadcrumbs
5
- * Хлебные крошки
6
- */
4
+ * Компонент Breadcrumbs отображает хлебные крошки.
5
+ **/
7
6
  export interface IBreadcrumbsProps {
8
7
  /**
9
8
  * Кастомный CSS-класс
@@ -1,6 +1,9 @@
1
1
  /// <reference types="react" />
2
2
  import { IButtonProps } from 'src/ui/form/Button/Button';
3
3
  import { DataProviderItems } from '../../../hooks/useDataProvider';
4
+ /**
5
+ * Компонент ButtonGroup отображает группу кнопок.
6
+ **/
4
7
  export interface IButtonGroupProps extends IUiComponent {
5
8
  /**
6
9
  * Элементы для группы кнопок
@@ -31,12 +31,12 @@ var hooks_1 = require("../../../hooks");
31
31
  var useDataProvider_1 = __importDefault(require("../../../hooks/useDataProvider"));
32
32
  var DEFAULT_BUTTON_GROUP_SIZE = 'md';
33
33
  function ButtonGroup(props) {
34
- var _a;
34
+ var _a, _b;
35
35
  var components = (0, hooks_1.useComponents)();
36
36
  var items = (0, useDataProvider_1["default"])({
37
37
  items: props.items
38
38
  }).items;
39
- var _b = (0, react_1.useState)(props.activeButton || props.defaultActiveButton || items[0].id), activeButton = _b[0], setActiveButton = _b[1];
39
+ var _c = (0, react_1.useState)(props.activeButton || props.defaultActiveButton || ((_a = items[0]) === null || _a === void 0 ? void 0 : _a.id)), activeButton = _c[0], setActiveButton = _c[1];
40
40
  react_1["default"].useEffect(function () {
41
41
  if (props.activeButton) {
42
42
  setActiveButton(props.activeButton);
@@ -50,7 +50,7 @@ function ButtonGroup(props) {
50
50
  className: props.className,
51
51
  style: props.style,
52
52
  buttonProps: props.buttonProps,
53
- size: ((_a = props.buttonProps) === null || _a === void 0 ? void 0 : _a.size) || DEFAULT_BUTTON_GROUP_SIZE,
53
+ size: ((_b = props.buttonProps) === null || _b === void 0 ? void 0 : _b.size) || DEFAULT_BUTTON_GROUP_SIZE,
54
54
  activeButton: activeButton,
55
55
  items: items,
56
56
  onClick: onClick