@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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@steroidsjs/core",
3
- "version": "3.0.0-beta.57",
3
+ "version": "3.0.0-beta.59",
4
4
  "description": "",
5
5
  "author": "Vladimir Kozhin <hello@kozhindev.com>",
6
6
  "repository": {
@@ -11,6 +11,23 @@ export interface IAccordionIcon {
11
11
  */
12
12
  close: React.ReactElement | string;
13
13
  }
14
+ /**
15
+ * Accordion
16
+ *
17
+ * Компонент-аккордеон позволяет создавать интерактивные списки или контейнеры,
18
+ * где содержимое может быть развернуто или свернуто по требованию пользователя.
19
+ * Каждый элемент аккордеона может быть раскрытым или свернутым, и пользователь может
20
+ * изменять их состояние путем нажатия на соответствующий заголовок элемента.
21
+ *
22
+ * Компонент `Accordion` обычно используется для создания разделов, подразделов или
23
+ * списков, где необходимо показывать или скрывать дополнительную информацию по требованию.
24
+ *
25
+ * Внутри компонента `Accordion` могут быть использованы дочерние элементы `AccordionItem`,
26
+ * каждый из которых представляет отдельный элемент аккордеона с заголовком и содержимым.
27
+ * При нажатии на заголовок, соответствующий элемент может быть развернут или свернут.
28
+ *
29
+ * Примечание: В компоненте `Accordion` должен быть указан хотя бы один дочерний элемент `AccordionItem`.
30
+ */
14
31
  export interface IAccordionProps extends IUiComponent {
15
32
  /**
16
33
  * Дочерние элементы
@@ -1,4 +1,20 @@
1
1
  import React from 'react';
2
+ /**
3
+ * Alert
4
+ *
5
+ * Компонент оповещения, который отображает сообщения для пользователя.
6
+ * Он может быть использован для показа уведомлений, предупреждений или ошибок,
7
+ * которые требуют внимания пользователя.
8
+ *
9
+ * Компонент `Alert` может содержать текстовое сообщение и дополнительное описание,
10
+ * а также опциональную кнопку для закрытия оповещения.
11
+ *
12
+ * Оповещения могут иметь различные типы, такие как 'success', 'info', 'warning', 'error'
13
+ * или другие пользовательские типы.
14
+ *
15
+ * Компонент также предлагает настройки для отображения иконки, анимации, а также
16
+ * обратного вызова при закрытии оповещения.
17
+ */
2
18
  export interface IAlertProps extends IUiComponent {
3
19
  /**
4
20
  * Дочерние элементы
@@ -1,4 +1,16 @@
1
1
  /// <reference types="react" />
2
+ /**
3
+ * Avatar
4
+ *
5
+ * Компонент аватара, который отображает изображение пользователя или иконку.
6
+ * Он может использоваться для представления пользователя, контакта или профиля.
7
+ *
8
+ * Компонент `Avatar` позволяет указать размер, форму, изображение или иконку,
9
+ * а также добавить альтернативный текст и статус онлайна.
10
+ *
11
+ * Если изображение аватара не загружается, можно показать альтернативный текст
12
+ * или иконку вместо него.
13
+ */
2
14
  export interface IAvatarProps extends IUiComponent {
3
15
  /**
4
16
  * Альтернативный текст для изображения
@@ -11,6 +11,17 @@ export interface ICounter {
11
11
  */
12
12
  content: string | number;
13
13
  }
14
+ /**
15
+ * Badge
16
+ *
17
+ * Компонент бэйджа, который используется для отображения информационных меток на элементах пользовательского интерфейса.
18
+ * Он может использоваться для обозначения статуса, количества, типа или любой другой важной информации.
19
+ *
20
+ * Компонент `Badge` позволяет указать тип бэйджа, стиль скругления, наличие кнопки для закрытия,
21
+ * текст сообщения, отображение счетчика и размер.
22
+ *
23
+ * Если установлен флаг `showClose`, то пользователь может закрыть бэйдж, вызывая соответствующую callback функцию `onClose`.
24
+ */
14
25
  export interface IBadgeProps extends IUiComponent {
15
26
  /**
16
27
  * Тип badge
@@ -1,5 +1,17 @@
1
1
  /// <reference types="react" />
2
2
  import { DayPickerProps } from 'react-day-picker';
3
+ /**
4
+ * Calendar
5
+ *
6
+ * Компонент календаря, который позволяет выбирать даты или диапазоны дат.
7
+ * Он предоставляет пользователю удобный способ выбора даты и может использоваться для различных целей,
8
+ * таких как выбор даты доставки, даты резервирования и т.д.
9
+ *
10
+ * Компонент `Calendar` позволяет указать значение даты или диапазона дат, формат значения, callback функцию при изменении,
11
+ * свойства для компонента `DayPicker`, отображение панели выбора месяца/года, количество отображаемых месяцев и другие свойства.
12
+ *
13
+ * Если установлено значение `showFooter`, то будет отображаться футер с кнопкой "Today".
14
+ */
3
15
  export interface ICalendarProps extends IUiComponent {
4
16
  /**
5
17
  * Значение задает выбранные в календаре дату или диапазон дат.
@@ -28,6 +28,15 @@ export interface ICardHeader {
28
28
  */
29
29
  subhead?: string;
30
30
  }
31
+ /**
32
+ * Card
33
+ *
34
+ * Компонент карточки, который представляет контент в структурированном формате с заголовком, обложкой, описанием,
35
+ * кнопками, ссылками и другими элементами.
36
+ *
37
+ * Компонент `Card` позволяет передать дочерние элементы, обложку, описание, заголовок, параметры заголовка,
38
+ * футер, коллекцию ссылок и коллекцию кнопок.
39
+ */
31
40
  export interface ICardProps extends IUiComponent {
32
41
  /**
33
42
  * Дочерние элементы
@@ -1,5 +1,18 @@
1
1
  import React from 'react';
2
2
  import { IShowNotificationParameters } from '../../../actions/notifications';
3
+ /**
4
+ * CopyToClipboard
5
+ *
6
+ * Компонент, позволяющий копировать заданное значение в буфер обмена при клике.
7
+ *
8
+ * Компонент `CopyToClipboard` принимает значение `value` для копирования, а также
9
+ * может отображать иконку, дополнительный текст или другие дочерние элементы.
10
+ *
11
+ * При успешном копировании значения, можно также отобразить уведомление с помощью
12
+ * параметра `notification`. Можно задать текст уведомления, его уровень и параметры.
13
+ *
14
+ * Компонент также поддерживает обработчик `onCopy`, который вызывается при копировании.
15
+ */
3
16
  export interface ICopyToClipboardProps extends IUiComponent {
4
17
  /**
5
18
  * Значение, которое будет использоваться при копировании
@@ -31,6 +31,20 @@ export interface IDetailResponsive {
31
31
  */
32
32
  media: IDetailMedia[];
33
33
  }
34
+ /**
35
+ * Detail
36
+ *
37
+ * Представление данных в виде таблицы, в которой поля группируются по принципу "ключ-значение".
38
+ *
39
+ * Компонент `Detail` принимает данные в виде дочерних компонентов `DetailItem`, которые отображаются
40
+ * в виде таблицы с ячейками "ключ-значение".
41
+ *
42
+ * Компонент поддерживает различные настройки, такие как размер ячеек, вариант расположения
43
+ * ячеек ("horizontal" или "vertical"), а также респонсивный режим, позволяющий перестраивать
44
+ * таблицу при изменении размеров окна.
45
+ *
46
+ * Компонент также может отображать заголовок таблицы и контролы, расположенные рядом с таблицей.
47
+ */
34
48
  export interface IDetailProps extends IUiComponent {
35
49
  /**
36
50
  * Размер ячеек в таблице
@@ -1,5 +1,11 @@
1
1
  import * as React from 'react';
2
2
  import { IAbsolutePositioningInputProps, IAbsolutePositioningOutputProps } from '../../../hooks/useAbsolutePositioning';
3
+ /**
4
+ * Menu
5
+ *
6
+ * Компонент, представляющий меню с элементами, которые могут быть выбраны или нажаты.
7
+ * Компонент позволяет отображать и скрывать содержимое меню, а также управлять его позиционированием.
8
+ */
3
9
  export interface IDropDownProps extends IAbsolutePositioningInputProps {
4
10
  /**
5
11
  * Содержимое DropDown (компонент или jsx-код)
@@ -17,6 +17,11 @@
17
17
  *
18
18
  * That get the icon used <Icon name={'icon-name'} />
19
19
  */
20
+ /**
21
+ * Icon
22
+ *
23
+ * Компонент, представляющий иконку. Иконки могут быть импортированы при старте приложения.
24
+ */
20
25
  export interface IIconProps extends IUiComponent {
21
26
  /**
22
27
  * Имя иконки (латиницей). Импорт иконок происходит на старте приложения.
@@ -18,6 +18,21 @@ export interface IMenuItem {
18
18
  */
19
19
  hasBorder?: boolean;
20
20
  }
21
+ /**
22
+ * Menu
23
+ *
24
+ * Компонент-меню позволяет создавать выпадающие списки с элементами, которые могут быть выбраны
25
+ * или выполнить определенные действия при клике на них.
26
+ *
27
+ * Компонент `Menu` обычно используется для создания навигационных меню или контекстных меню,
28
+ * где пользователь может выбирать опции или выполнять определенные действия в зависимости от выбранного элемента.
29
+ *
30
+ * Компонент `Menu` принимает массив `items`, каждый элемент которого представляет собой отдельный пункт меню.
31
+ * Каждый пункт меню имеет заголовок `label`, функцию `onClick`, которая будет вызываться при клике на элемент,
32
+ * кастомную иконку `icon` (необязательно) и флаг `hasBorder`, определяющий наличие нижней границы у элемента.
33
+ *
34
+ * Примечание: Компонент `Menu` требует указания хотя бы одного элемента меню в свойстве `items`.
35
+ */
21
36
  export interface IMenuProps extends IUiComponent {
22
37
  /**
23
38
  * Элементы меню
@@ -1,7 +1,19 @@
1
1
  import React from 'react';
2
2
  import { Options, SplideProps } from '@splidejs/react-splide';
3
3
  /**
4
- * Пропсы для компонента Slider.
4
+ * Slider
5
+ *
6
+ * Компонент слайдера позволяет создавать слайдшоу, где элементы могут быть пролистаны
7
+ * с помощью прокрутки или перетаскивания.
8
+ *
9
+ * Компонент `Slider` принимает следующие свойства:
10
+ *
11
+ * - `sliderOptions`: опции слайдера, используемые для настройки поведения слайдера. (тип: Options)
12
+ * - `items`: элементы слайдера, представленные в виде массива записей. (тип: Record<string, any>[])
13
+ * - `itemView`: представление элемента слайдера, используемое для кастомизации отображения каждого слайда. (тип: CustomView | any)
14
+ * - дополнительные свойства: любые дополнительные свойства, которые могут быть переданы компоненту.
15
+ *
16
+ * Примечание: Компонент `Slider` требует указания опций слайдера (`sliderOptions`) и элементов слайдера (`items`).
5
17
  */
6
18
  export interface ISliderProps extends IUiComponent, Omit<SplideProps, 'items'> {
7
19
  /**
@@ -72,6 +72,37 @@ export interface ICrudClickProps {
72
72
  goToAction: (nextAction: string) => any;
73
73
  errorHandler?: (error: any, dispatch: any) => void;
74
74
  }
75
+ /**
76
+ * Crud
77
+ *
78
+ * Компонент CRUD (Create, Read, Update, Delete) предоставляет интерфейс для выполнения операций создания,
79
+ * чтения, обновления и удаления записей. Он позволяет создавать, просматривать, редактировать и удалять
80
+ * записи из некоторой модели данных.
81
+ *
82
+ * Компонент `Crud` принимает следующие свойства:
83
+ *
84
+ * - `crudId`: идентификатор для CRUD (тип: string)
85
+ * - `mode`: режим работы CRUD (тип: 'page' | 'modal')
86
+ * - `restUrl`: ссылка на REST API (тип: string)
87
+ * - `restApi`: методы REST API (тип: IApiRest)
88
+ * - `primaryKey`: первичный ключ записей (тип: 'id' | string)
89
+ * - `queryKey`: ключ запроса (тип: 'id' | string)
90
+ * - `model`: модель данных (тип: string)
91
+ * - `searchModel`: модель данных используемая для поиска (тип: string)
92
+ * - `index`: параметры для колонки index (тип: boolean | ICrudItem)
93
+ * - `create`: параметры для колонки create (тип: boolean | ICrudItem)
94
+ * - `update`: параметры для колонки update (тип: boolean | ICrudItem)
95
+ * - `view`: параметры для колонки view (тип: boolean | ICrudItem)
96
+ * - `delete`: параметры для колонки delete (тип: boolean | ICrudItem)
97
+ * - `items`: коллекция элементов (тип: ICrudItem[] | { [key: string]: ICrudItem })
98
+ * - `grid`: параметры Grid (тип: IGridProps | React.ReactNode)
99
+ * - `form`: параметры формы (тип: IFormProps | React.ReactNode)
100
+ * - `detail`: параметры для колонки detail (тип: any)
101
+ * - `crudView`: представление для CRUD (тип: CustomView)
102
+ * - `errorHandler`: функция-обработчик ошибок (тип: (error, dispatch: any) => void)
103
+ *
104
+ * Примечание: Компонент `Crud` требует указания идентификатора CRUD (`crudId`) и ссылки на REST API (`restUrl`).
105
+ */
75
106
  export interface ICrudProps {
76
107
  /**
77
108
  * Id для Crud
@@ -13,8 +13,18 @@ export interface IAutoCompleteItem {
13
13
  [key: string]: unknown;
14
14
  }
15
15
  /**
16
- * AutoComplete
17
- * Поле ввода текста с подсказками (auto-complete)
16
+ * AutoCompleteField
17
+ *
18
+ * Поле ввода текста с подсказками (auto-complete). Он позволяет пользователю вводить текст и предлагает
19
+ * варианты автозаполнения на основе предоставленных данных.
20
+ *
21
+ * Компонент `AutoCompleteField` принимает следующие свойства:
22
+ *
23
+ * - `searchOnFocus`: при фокусировке на поле ввода будет запускаться поиск (тип: boolean)
24
+ * - все остальные свойства являются наследниками интерфейсов `IBaseFieldProps`, `IDataProviderConfig` и `IDataSelectConfig`
25
+ *
26
+ * Примечание: Компонент `AutoCompleteField` требует указания списка элементов (`items`) и предоставления
27
+ * конфигурации для провайдера данных (`dataProvider`) и выборки данных (`autoComplete` и `autoFetch`).
18
28
  */
19
29
  export interface IAutoCompleteFieldProps extends IBaseFieldProps, IDataProviderConfig, Omit<IDataSelectConfig, 'items'> {
20
30
  /**
@@ -1,5 +1,16 @@
1
1
  import * as React from 'react';
2
2
  import { IFieldWrapperInputProps } from '../Field/fieldWrapper';
3
+ /**
4
+ * BlankField
5
+ *
6
+ * Пустое поле. Он отображает переданный текст или дочерние элементы.
7
+ *
8
+ * Компонент `BlankField` принимает следующие свойства:
9
+ *
10
+ * - `text`: текст для отображения (тип: string | React.ReactNode)
11
+ * - `children`: дочерние элементы (тип: React.ReactNode)
12
+ * - все остальные свойства являются наследниками интерфейсов `IFieldWrapperInputProps` и `IUiComponent`
13
+ */
3
14
  export interface IBlankFieldProps extends IFieldWrapperInputProps, IUiComponent {
4
15
  /**
5
16
  * Текст для отображения
@@ -2,6 +2,7 @@ import * as React from 'react';
2
2
  import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fieldWrapper';
3
3
  /**
4
4
  * CheckboxField
5
+ *
5
6
  * Одиночный чекбокс. Используется в формах для отметки булевого значения.
6
7
  */
7
8
  export interface ICheckboxFieldProps extends IFieldWrapperInputProps, IUiComponent {
@@ -5,7 +5,9 @@ import { IDataSelectConfig } from '../../../hooks/useDataSelect';
5
5
  import { ICheckboxFieldViewProps } from '../CheckboxField/CheckboxField';
6
6
  /**
7
7
  * CheckboxListField
8
+ *
8
9
  * Список с чекбоксами. Используется в формах для выбора нескольких значений.
10
+ *
9
11
  */
10
12
  export interface ICheckboxListFieldProps extends IFieldWrapperInputProps, IDataProviderConfig, Omit<IDataSelectConfig, 'items'>, IUiComponent {
11
13
  /**
@@ -2,6 +2,15 @@
2
2
  import { MaskitoOptions } from '@maskito/core';
3
3
  import { ICalendarProps } from '../../content/Calendar/Calendar';
4
4
  import { IDateInputStateInput, IDateInputStateOutput } from './useDateInputState';
5
+ /**
6
+ * DateField
7
+ *
8
+ * Поле ввода с выпадающим календарём для выбора даты.
9
+ *
10
+ * Компонент `DateField` предоставляет возможность создания поля ввода с календарём для выбора даты.
11
+ * Он предоставляет пользователю удобный интерфейс для выбора даты с помощью календаря,
12
+ * а также поддерживает настройку формата отображения даты и другие параметры.
13
+ */
5
14
  export interface IDateFieldProps extends IDateInputStateInput, IUiComponent {
6
15
  /**
7
16
  * Свойства для view компонента
@@ -3,7 +3,11 @@ import { IDateInputStateInput, IDateInputStateOutput } from '../DateField/useDat
3
3
  import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../../form/Field/fieldWrapper';
4
4
  /**
5
5
  * DateRangeField
6
- * Поле ввода дипазона двух дат с выпадающим календарём
6
+ *
7
+ * Поле ввода дипазона двух дат с выпадающим календарём.
8
+ *
9
+ * Компонент `DateRangeField` предоставляет возможность создания поля ввода диапазона двух дат с выпадающим календарём.
10
+ * Он позволяет пользователю выбрать начальную и конечную даты с помощью календаря и предоставляет удобный интерфейс для работы с диапазоном дат.
7
11
  */
8
12
  export interface IDateRangeFieldProps extends IDateInputStateInput, Omit<IFieldWrapperInputProps, 'attribute'>, IUiComponent {
9
13
  /**
@@ -1,5 +1,13 @@
1
1
  import { ICalendarProps } from '../../content/Calendar/Calendar';
2
2
  import { IDateInputStateInput, IDateInputStateOutput } from '../../form/DateField/useDateInputState';
3
+ /**
4
+ * DateTimeField
5
+ *
6
+ * Поля ввода с выпадающими списками для выбора даты и времени.
7
+ *
8
+ * Компонент `DateTimeField` предоставляет возможность создания полей ввода для выбора даты и времени с помощью выпадающих списков.
9
+ * Он объединяет функциональность компонента `DateField` для выбора даты и компонента `TimePanel` для выбора времени.
10
+ */
3
11
  export interface IDateTimeFieldProps extends IDateInputStateInput, IUiComponent {
4
12
  /**
5
13
  * Свойства для компонента Calendar
@@ -4,7 +4,12 @@ import { IDateInputStateInput, IDateInputStateOutput } from '../../form/DateFiel
4
4
  import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../../form/Field/fieldWrapper';
5
5
  /**
6
6
  * DateTimeRangeField
7
- * Поле ввода дипазона двух дат со временем, с выпадающим календарём
7
+ *
8
+ * Поле ввода дипазона двух дат со временем, с выпадающим календарём.
9
+ *
10
+ * Компонент `DateTimeRangeField` предоставляет возможность создания поля ввода для выбора диапазона двух дат с временем
11
+ * с помощью выпадающих списков и календаря.
12
+ * Он объединяет функциональность компонента `DateRangeField` для выбора диапазона дат и компонента `DateTimeField` для выбора времени.
8
13
  */
9
14
  export interface IDateTimeRangeFieldProps extends Omit<IDateInputStateInput, 'inputProps' | 'input'>, Omit<IFieldWrapperInputProps, 'attribute'>, IUiComponent {
10
15
  /**
@@ -46,8 +46,13 @@ export interface IDropDownFieldItemViewProps extends IAccordionItemViewProps, Pi
46
46
  }
47
47
  /**
48
48
  * DropDownField
49
- * Выпадающий список для выбора одного или нескольких значений
50
- */
49
+ *
50
+ * Выпадающий список для выбора одного или нескольких значений.
51
+ *
52
+ * Компонент `DropDownField` предоставляет возможность создания выпадающего списка для выбора одного или нескольких значений.
53
+ * Он поддерживает различные типы контента для элементов списка, такие как флажки, радиокнопки, иконки и изображения.
54
+ *
55
+ **/
51
56
  export interface IDropDownFieldProps extends IFieldWrapperInputProps, Omit<IDataProviderConfig, 'items'>, Omit<IDataSelectConfig, 'items'>, IUiComponent {
52
57
  /**
53
58
  * Placeholder подсказка
@@ -3,8 +3,9 @@ import { IFieldWrapperInputProps } from './fieldWrapper';
3
3
  import { Model } from '../../../components/MetaComponent';
4
4
  /**
5
5
  * Field
6
- * Компонент, который рендерит соответствующее поле, исходя из переданной модели и названия аттрибута.
7
- * По дефолту будет отрендерен InputField.
6
+ *
7
+ * Компонент, который рендерит соответствующее поле, исходя из переданной модели и названия атрибута.
8
+ * По умолчанию будет отрендерен InputField.
8
9
  * Также можно не использовать модель, а передавать компонент поля напрямую через пропсы.
9
10
  */
10
11
  export interface IFieldProps extends IFieldWrapperInputProps {
@@ -1,7 +1,9 @@
1
1
  import * as React from 'react';
2
2
  /**
3
3
  * FieldLayout
4
- * Специальный шаблон для поля, который настраивает его расположение внутри формы, рендерит лейбл, подсказки и ошибки
4
+ *
5
+ * Специальный шаблон для поля, который настраивает его расположение внутри формы, рендерит лейбл, подсказки и ошибки.
6
+ *
5
7
  */
6
8
  export interface IFieldLayoutProps extends IUiComponent {
7
9
  /**
@@ -22,6 +22,13 @@ interface IFileFieldCommonProps extends IFileInput {
22
22
  */
23
23
  filesLayout?: FilesLayout | string;
24
24
  }
25
+ /**
26
+ * FileField
27
+ *
28
+ * Компонент `FileField` представляет собой поле формы для загрузки файлов.
29
+ * Он использует хук `useFile` для управления состоянием файлов и выполнения операций с файлами, таких как выбор и удаление.
30
+ * Компонент поддерживает различные варианты отображения файлов (список или стена) с помощью перечисления `FilesLayout`.
31
+ **/
25
32
  export interface IFileFieldProps extends IFieldWrapperInputProps, IFileFieldCommonProps, IUiComponent {
26
33
  /**
27
34
  * View компонент для кнопки
@@ -4,7 +4,9 @@ import { IApiMethod } from '../../../components/ApiComponent';
4
4
  import { IFieldProps } from '../Field/Field';
5
5
  /**
6
6
  * Form
7
- * Компонент для создания формы
7
+ *
8
+ * Компонент для создания формы. Предоставляет управление и синхронизацию состояния формы,
9
+ * а также позволяет выполнять отправку данных формы на сервер с возможностью валидации и обработки результатов.
8
10
  */
9
11
  export interface IFormProps extends IUiComponent {
10
12
  /**
@@ -1,7 +1,7 @@
1
1
  import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fieldWrapper';
2
2
  /**
3
3
  * HtmlField
4
- * Компонент для создания HTML-разметки, использующий WYSIWYG-реадактор
4
+ * Компонент для создания HTML-разметки, использующий WYSIWYG редактор
5
5
  */
6
6
  export interface IHtmlFieldProps extends IFieldWrapperInputProps, IFieldWrapperOutputProps, IUiComponent {
7
7
  /**
@@ -20,6 +20,11 @@ export interface ICropConfig {
20
20
  */
21
21
  reactImageCropProps?: ReactCropProps;
22
22
  }
23
+ /**
24
+ * ImageField
25
+ *
26
+ * Компонент для загрузки изображений с возможностью обрезки и предпросмотра.
27
+ **/
23
28
  export interface IImageFieldProps extends IFieldWrapperInputProps, Omit<IFileInput, 'multiple' | 'imagesOnly'>, IUiComponent {
24
29
  /**
25
30
  * Переопределение внешнего вида модального окна
@@ -1,5 +1,10 @@
1
1
  /// <reference types="react" />
2
2
  import { IInputFieldProps } from '../InputField/InputField';
3
+ /**
4
+ * MaskField
5
+ *
6
+ * Компонент поля ввода текста с маской.
7
+ **/
3
8
  export type IMaskFieldProps = IInputFieldProps;
4
9
  declare function MaskField(props: IMaskFieldProps): JSX.Element;
5
10
  export default MaskField;
@@ -3,8 +3,11 @@ import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../../form/Fi
3
3
  import { IDataProviderConfig } from '../../../hooks/useDataProvider';
4
4
  /**
5
5
  * NavField
6
- * Навигация как часть формы
7
- */
6
+ * Компонент навигации как часть формы.
7
+ *
8
+ * Этот компонент представляет собой навигационное меню, которое можно использовать
9
+ * как часть формы для выбора различных элементов или вкладок.
10
+ **/
8
11
  export interface INavFieldProps extends IFieldWrapperInputProps, IFieldWrapperOutputProps, IDataProviderConfig, IUiComponent {
9
12
  /**
10
13
  * Свойства для компонента Nav
@@ -2,8 +2,9 @@ import { IBaseFieldProps } from '../InputField/InputField';
2
2
  import { IFieldWrapperOutputProps } from '../Field/fieldWrapper';
3
3
  /**
4
4
  * NumberField
5
- * Числовое поле ввода
6
- */
5
+ *
6
+ * Числовое поле ввода. Этот компонент представляет собой поле ввода для числовых значений.
7
+ **/
7
8
  export interface INumberFieldProps extends IBaseFieldProps {
8
9
  /**
9
10
  * Минимальное значение
@@ -3,8 +3,10 @@ import { IBaseFieldProps } from '../InputField/InputField';
3
3
  import { IFieldWrapperOutputProps } from '../Field/fieldWrapper';
4
4
  /**
5
5
  * PasswordField
6
- * Поле ввода пароля
7
- */
6
+ *
7
+ * Поле ввода пароля. Этот компонент представляет собой поле ввода для паролей.
8
+ *
9
+ **/
8
10
  export interface IPasswordFieldProps extends IBaseFieldProps {
9
11
  /**
10
12
  * Если true, то отображается шкала сложности пароля
@@ -1,5 +1,10 @@
1
1
  import * as React from 'react';
2
2
  import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fieldWrapper';
3
+ /**
4
+ * RadioField
5
+ *
6
+ * Компонент RadioField представляет собой элемент выбора типа "radio". Он позволяет пользователю выбрать один вариант из нескольких предложенных.
7
+ **/
3
8
  export interface IRadioFieldProps extends IFieldWrapperInputProps, IUiComponent {
4
9
  /**
5
10
  * Свойства для элемента input
@@ -3,7 +3,7 @@ import { IFieldWrapperOutputProps } from '../Field/fieldWrapper';
3
3
  import { IBaseFieldProps } from '../InputField/InputField';
4
4
  /**
5
5
  * TextField
6
- * Поле для ввода нескольких строк теста
6
+ * Поле для ввода нескольких строк текста
7
7
  */
8
8
  export interface ITextFieldProps extends IBaseFieldProps {
9
9
  /**
@@ -1,6 +1,11 @@
1
1
  import { IDateInputStateInput, IDateInputStateOutput } from '../DateField/useDateInputState';
2
2
  import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fieldWrapper';
3
3
  import { ITimePanelViewProps } from '../TimeField/TimeField';
4
+ /**
5
+ * TimeRangeField
6
+ *
7
+ * Компонент TimeRangeField представляет собой поле выбора временного диапазона, состоящего из двух элементов ввода времени (from и to).
8
+ **/
4
9
  export interface ITimeRangeFieldProps extends IDateInputStateInput, Omit<IFieldWrapperInputProps, 'attribute'>, IUiComponent {
5
10
  /**
6
11
  * Аттрибут (название) поля в форме
@@ -1,4 +1,10 @@
1
1
  import * as React from 'react';
2
+ /**
3
+ * BooleanFormatter
4
+ *
5
+ * Компонент BooleanFormatter предназначен для форматирования значения типа boolean, string или number.
6
+ * Он позволяет кастомизировать отображение значения, используя переданный view React компонент.
7
+ **/
2
8
  export interface IBooleanFormatterProps {
3
9
  /**
4
10
  * Значение для BooleanFormatter
@@ -1,4 +1,10 @@
1
1
  /// <reference types="react" />
2
+ /**
3
+ * DateFormatter
4
+ *
5
+ * Компонент DateFormatter предназначен для форматирования даты с использованием заданного формата.
6
+ * Он позволяет кастомизировать отображение даты, используя переданный view React компонент.
7
+ **/
2
8
  export interface IDateFormatterProps {
3
9
  /**
4
10
  * Формат даты
@@ -1,5 +1,11 @@
1
1
  /// <reference types="react" />
2
2
  import { IDateFormatterProps } from '../DateFormatter/DateFormatter';
3
+ /**
4
+ * DateTimeFormatter
5
+ *
6
+ * Компонент DateTimeFormatter предназначен для форматирования даты и времени с использованием заданного формата.
7
+ * Он позволяет кастомизировать отображение даты и времени, используя переданный view React компонент.
8
+ **/
3
9
  export interface IDateTimeFormatterProps {
4
10
  /**
5
11
  * Формат даты