@steroidsjs/core 3.0.0-beta.42 → 3.0.0-beta.43

package/ui/form/FieldList/FieldList.d.ts

@@ -4,7 +4,7 @@ import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../../form/Fi
  * FieldList
  * Создает список из сгруппированных полей формы
  */
-export interface IFieldListItem extends IFieldWrapperInputProps {
+export interface IFieldListItem extends IFieldWrapperInputProps, IUiComponent {
     /**
      * Будет ли отображён item ?
      * @example true
@@ -20,26 +20,17 @@ export interface IFieldListItem extends IFieldWrapperInputProps {
      * @example Your text...
      */
     placeholder?: string;
-    /**
-     * Дополнительный CSS-класс для item
-     */
-    className?: CssClassName;
     /**
      * Дополнительный CSS-класс для заголовка
      */
     headerClassName?: CssClassName;
-    /**
-     * Переопределение view React компонента для кастомизации отображения item
-     * @example MyCustomView
-     */
-    view?: CustomView;
     /**
      * Заголовок для колонки таблицы.
      */
     title?: string;
     [key: string]: any;
 }
-export interface IFieldListProps extends IFieldWrapperInputProps {
+export interface IFieldListProps extends IFieldWrapperInputProps, IUiComponent {
     /**
      * Начальные значения в полях
      * @example {name: 'Ivan', amount: 5}
@@ -66,19 +57,10 @@ export interface IFieldListProps extends IFieldWrapperInputProps {
      * @example true
      */
     showRemove?: boolean;
-    /**
-     * Дополнительный CSS-класс для списка с группами полей
-     */
-    className?: CssClassName;
     /**
      * Дополнительный CSS-класс для таблицы
      */
     tableClassName?: CssClassName;
-    /**
-     * Переопределение view React компонента для кастомизации отображения списка с группами полей
-     * @example MyCustomView
-     */
-    view?: CustomView;
     /**
      * Пропсы для компонента отображения списка с группами полей - FieldListView
      */

package/ui/form/FileField/FileField.d.ts

@@ -22,17 +22,7 @@ interface IFileFieldCommonProps extends IFileInput {
      */
     filesLayout?: FilesLayout | string;
 }
-export interface IFileFieldProps extends IFieldWrapperInputProps, IFileFieldCommonProps {
-    /**
-     * Дополнительный css класс
-     * @example true
-     */
-    className?: CssClassName;
-    /**
-     * View компонент
-     * @example true
-     */
-    view?: CustomView;
+export interface IFileFieldProps extends IFieldWrapperInputProps, IFileFieldCommonProps, IUiComponent {
     /**
      * View компонент для кнопки
      * @example true

package/ui/form/Form/Form.d.ts

@@ -6,12 +6,15 @@ import { IFieldProps } from '../Field/Field';
  * Form
  * Компонент для создания формы
  */
-export interface IFormProps {
+export interface IFormProps extends IUiComponent {
     /**
      * Идентификатор формы
      * @example BookingForm
      */
     formId?: string;
+    /**
+    * Префикс
+    */
     prefix?: string;
     /**
      * Модель с полями формы
@@ -87,20 +90,7 @@ export interface IFormProps {
      */
     initialValues?: any | any[];
     /**
-     * Дополнительный CSS-класс для \<form\>...\<\/form\>
-     */
-    className?: CssClassName;
-    /**
-     * Объект CSS стилей
-     * @example {width: '45%'}
-     */
-    style?: CustomStyle;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
-    /**
+     * Свойства для представления
      * @example {className: 'foo'}
      */
     viewProps?: any;
@@ -159,15 +149,37 @@ export interface IFormReducerState {
     isSubmitting: boolean;
 }
 export interface IFormContext {
+    /**
+    * Id формы
+    * @example {}
+    */
     formId?: string;
+    /**
+    * Модель с полями формы
+    */
     model?: any;
+    /**
+    * Префикс для полей формы
+    */
     prefix?: string | boolean;
+    /**
+    * Размер компонента
+    */
     size?: Size;
+    /**
+    * Провайдер
+    */
     provider?: any;
+    /**
+    * Редьюсер
+    */
     reducer?: {
         dispatch: React.Dispatch<any>;
         select: any;
     };
+    /**
+    * Диспатч
+    */
     dispatch?: any;
 }
 export declare const FormContext: React.Context<IFormContext>;

package/ui/form/HtmlField/HtmlField.d.ts

@@ -3,15 +3,11 @@ import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fiel
  * HtmlField
  * Компонент для создания HTML-разметки, использующий WYSIWYG-реадактор
  */
-export interface IHtmlFieldProps extends IFieldWrapperInputProps, IFieldWrapperOutputProps {
+export interface IHtmlFieldProps extends IFieldWrapperInputProps, IFieldWrapperOutputProps, IUiComponent {
     /**
      * Конфигурация wysiwyg реадактора
      */
     editorProps?: any;
-    /**
-     * Дополнительный CSS-класс
-     */
-    className?: CssClassName;
     /**
      * Url на который будет отправлена форма загрузки файла
      * @example /api/v1/upload-files
@@ -23,11 +19,6 @@ export interface IHtmlFieldProps extends IFieldWrapperInputProps, IFieldWrapperO
      * @example origin
      */
     uploadImagesProcessor?: string;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
     /**
      * Обработчик события при фокусе на редактора
      * @param event

package/ui/form/ImageField/ImageField.d.ts

@@ -19,16 +19,7 @@ export interface ICropConfig {
      */
     reactImageCropProps?: ReactCropProps;
 }
-export interface IImageFieldProps extends IFieldWrapperInputProps, Omit<IFileInput, 'multiple' | 'imagesOnly'> {
-    /**
-     * Дополнительный CSS-класс для компонента
-     */
-    className?: CssClassName;
-    /**
-     * Переопределение внешнего вида компонента
-     * @example MyCustomView
-     */
-    view?: CustomView;
+export interface IImageFieldProps extends IFieldWrapperInputProps, Omit<IFileInput, 'multiple' | 'imagesOnly'>, IUiComponent {
     /**
      * Переопределение внешнего вида модального окна
      * @example MyCustomModalView

package/ui/form/InputField/InputField.d.ts

@@ -4,13 +4,13 @@ import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fiel
 type IElementInputType = 'button' | 'checkbox' | 'color' | 'date' | 'datetime-local' | 'email' | 'file' | 'hidden' | 'image' | 'month' | 'number' | 'password' | 'radio' | 'range' | 'reset' | 'search' | 'submit' | 'tel' | 'text' | 'time' | 'url' | 'week' | string;
 export interface IBaseFieldProps extends IFieldWrapperInputProps, IUiComponent {
     /**
-     * Свойства для элемента \<input /\>
+     * Свойства для элемента input
      * @example {onKeyDown: ...}
      */
     inputProps?: any;
     /**
      * Показывать иконку очищения поля
-     * @example {'true'}
+     * @example true
     */
     showClear?: boolean;
     /**

package/ui/form/NavField/NavField.d.ts

@@ -5,7 +5,7 @@ import { IDataProviderConfig } from '../../../hooks/useDataProvider';
  * NavField
  * Навигация как часть формы
  */
-export interface INavFieldProps extends IFieldWrapperInputProps, IFieldWrapperOutputProps, IDataProviderConfig {
+export interface INavFieldProps extends IFieldWrapperInputProps, IFieldWrapperOutputProps, IDataProviderConfig, IUiComponent {
     /**
      * Свойства для компонента Nav
      */

package/ui/form/RadioField/RadioField.d.ts

@@ -1,20 +1,11 @@
 import * as React from 'react';
 import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fieldWrapper';
-export interface IRadioFieldProps extends IFieldWrapperInputProps {
+export interface IRadioFieldProps extends IFieldWrapperInputProps, IUiComponent {
     /**
-     * Свойства для элемента \<input /\>
+     * Свойства для элемента input
      * @example {onKeyDown: ...}
      */
     inputProps?: any;
-    /**
-     * Дополнительный CSS-класс для элемента \<input /\>
-     */
-    className?: CssClassName;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
     /**
      * Флаг определяющий включен ли элемент
      * @example {'true'}

package/ui/form/RadioListField/RadioListField.d.ts

@@ -7,25 +7,16 @@ import { IRadioFieldViewProps } from '../RadioField/RadioField';
  * RadioListField
  * Список с радиокнопками. Используется в формах для выбора одного значения.
  */
-export interface IRadioListFieldProps extends IFieldWrapperInputProps, IDataProviderConfig, Omit<IDataSelectConfig, 'items'> {
+export interface IRadioListFieldProps extends IFieldWrapperInputProps, IDataProviderConfig, Omit<IDataSelectConfig, 'items'>, IUiComponent {
     /**
-     * Свойства для элемента \<input /\>
+     * Свойства для элемента input
      * @example {onKeyDown: ...}
      */
     inputProps?: any;
-    /**
-     * Дополнительный CSS-класс для элемента отображения
-     */
-    className?: CssClassName;
     /**
      * Ориентация списка
      */
     orientation?: Orientation;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
 }
 export interface IRadioListFieldViewProps extends IFieldWrapperOutputProps {
     inputProps: {

package/ui/form/RateField/RateField.d.ts

@@ -7,7 +7,7 @@ export interface IRateFieldItem {
     id: number;
     value: number;
 }
-export interface IRateFieldProps extends IFieldWrapperInputProps {
+export interface IRateFieldProps extends IFieldWrapperInputProps, IUiComponent {
     /**
      * Максимальное количество звезд
      * @example 5
@@ -23,15 +23,6 @@ export interface IRateFieldProps extends IFieldWrapperInputProps {
      * @example false
      */
     allowClear?: boolean;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
-    /**
-     * Дополнительный CSS-класс для элемента отображения
-     */
-    className?: CssClassName;
     inputProps?: {
         [key: string]: any;
     };

package/ui/form/ReCaptchaField/ReCaptchaField.d.ts

@@ -10,12 +10,7 @@ import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fiel
  * получения токена. Далее этот токен с остальными данными формы отправится на бэкенд.
  * Сам компонент отображает ссылки на политику конфиденциальности и условия использования сервисов Google.
  */
-export interface IReCaptchaFieldProps extends IFieldWrapperInputProps {
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
+export interface IReCaptchaFieldProps extends IFieldWrapperInputProps, IUiComponent {
     [key: string]: any;
 }
 export interface IReCaptchaFieldViewProps extends IReCaptchaFieldProps, IFieldWrapperOutputProps {

package/ui/form/SliderField/SliderField.d.ts

@@ -4,20 +4,11 @@ import { IFieldWrapperInputProps, IFieldWrapperOutputProps } from '../Field/fiel
  * SliderField
  * Компонент с ползунком для выбора числового значения в пределах указанного промежутка
  */
-export interface ISliderFieldProps extends IFieldWrapperInputProps {
+export interface ISliderFieldProps extends IFieldWrapperInputProps, IUiComponent {
     /**
      * Свойства для компонента слайдера
      */
     sliderProps?: any;
-    /**
-     * Дополнительный CSS-класс для элемента отображения
-     */
-    className?: CssClassName;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
     /**
      * Минимальное значение в слайдере
      * @example 0
@@ -39,12 +30,12 @@ export interface ISliderFieldProps extends IFieldWrapperInputProps {
      */
     step?: null | number;
     /**
-     * Значение по-умолчанию при первом рендере. Для isRange=false исполуется number, для isRange=true - number[]
+     * Значение по-умолчанию при первом рендере. Для isRange=false используется number, для isRange=true - number[]
      * @example 1
      */
     defaultValue?: number | number[];
     /**
-     * Любое строкове значение после значения состояния слайдера в всплывающем окошке.
+     * Любое строковое значение после значения состояния слайдера в всплывающем окошке.
      * @example '%'
      */
     valuePostfix?: string;

package/ui/form/SliderField/SliderField.js

@@ -39,7 +39,7 @@ function SliderField(props) {
             props.input.onChange.call(null, value);
         }
     }); }, [props.min, props.max, props.step, props.marks, props.isRange, props.disabled, props.isVertical, props.input.value, props.input.onChange, props.valuePostfix, props.defaultValue, props.tooltipIsVisible]);
-    return components.ui.renderView('form.SliderFieldView', __assign(__assign({}, props), { sliderProps: sliderProps }));
+    return components.ui.renderView(props.view || 'form.SliderFieldView', __assign(__assign({}, props), { sliderProps: sliderProps }));
 }
 SliderField.defaultProps = {
     step: 1,

package/ui/form/SwitcherField/SwitcherField.d.ts

@@ -16,7 +16,7 @@ export interface ISwitcherItem {
  */
 export interface ISwitcherFieldProps extends IFieldWrapperInputProps, IDataProviderConfig, Omit<IDataSelectConfig, 'items'>, IUiComponent {
     /**
-    * Свойства для элемента \<input /\>
+    * Свойства для элемента input
     * @example {onKeyDown: ...}
     */
     inputProps?: any;

package/ui/form/TimeField/TimeField.d.ts

@@ -7,26 +7,12 @@ export interface ITimePanelViewProps extends Pick<ITimeFieldViewProps, 'value' |
  * TimeField
  * Поле для выбора времени
  */
-export interface ITimeFieldProps extends IDateInputStateInput {
+export interface ITimeFieldProps extends IDateInputStateInput, IUiComponent {
     /**
      * Отключить border вокруг элемента
      * @example 'true'
      */
     noBorder?: boolean;
-    /**
-     * Переопределение view React компонента для кастомизации отображения
-     * @example MyCustomView
-     */
-    view?: CustomView;
-    /**
-     * Дополнительный CSS-класс для элемента отображения
-     */
-    className?: CssClassName;
-    /**
-     * Объект CSS стилей
-     * @example {width: '45%'}
-     */
-    style?: CustomStyle;
     /**
      * Свойства для view компонента
      */

package/ui/format/BooleanFormatter/BooleanFormatter.d.ts

@@ -1,6 +1,13 @@
 import * as React from 'react';
 export interface IBooleanFormatterProps {
+    /**
+    * Значение для BooleanFormatter
+    */
     value?: string | number | boolean;
+    /**
+     * Переопределение view React компонента для кастомизации отображения
+     * @example MyCustomView
+     */
     view?: CustomView;
     [key: string]: any;
 }

package/ui/format/DateFormatter/DateFormatter.d.ts

@@ -5,12 +5,16 @@ export interface IDateFormatterProps {
      * @example LL
      */
     format?: string;
-    view?: CustomView;
     /**
      * Дата
      * @example 2023-09-11
      */
     value?: any;
+    /**
+     * Переопределение view React компонента для кастомизации отображения колонки
+     * @example MyCustomView
+     */
+    view?: CustomView;
     [key: string]: any;
 }
 export default function DateFormatter(props: IDateFormatterProps): JSX.Element;

package/ui/format/DateTimeFormatter/DateTimeFormatter.d.ts

@@ -11,12 +11,16 @@ export interface IDateTimeFormatterProps {
      * @example true
      */
     timeZone?: string | boolean;
-    view?: CustomView;
     /**
      * Дата
      * @example 2023-09-11
      */
     value?: any;
+    /**
+     * Переопределение view React компонента для кастомизации отображения колонки
+     * @example MyCustomView
+     */
+    view?: CustomView;
     [key: string]: any;
 }
 declare function DateTimeFormatter(props: IDateFormatterProps): JSX.Element;

package/ui/format/EnumFormatter/EnumFormatter.d.ts

@@ -12,6 +12,10 @@ export interface IEnumFormatterProps {
      * @example unique label
      */
     value?: number | string;
+    /**
+     * Переопределение view React компонента для кастомизации отображения колонки
+     * @example MyCustomView
+     */
     view?: CustomView;
     [key: string]: any;
 }

package/ui/format/FileSize/FileSize.d.ts

@@ -1,12 +1,11 @@
 /// <reference types="react" />
-export interface IFileSizeFormatterProps {
+export interface IFileSizeFormatterProps extends IUiComponent {
     /**
      * Если не указан размер файла, то в случае, если showZero = true
      * то будет показан `0`, иначе пустая строка
      * @example true
      */
     showZero?: boolean;
-    view?: CustomView;
     /**
      * Размер файла
      * @example 6920

package/ui/format/MoneyFormatter/MoneyFormatter.d.ts

@@ -15,7 +15,9 @@ export interface IMoneyFormatterProps {
      * @example 2
      */
     precision?: number;
-    view?: CustomView;
+    /**
+    * Значение для MoneyFormatter
+    */
     value?: any;
     [key: string]: any;
 }

package/ui/layout/Header/Header.d.ts

@@ -1,14 +1,18 @@
 /// <reference types="react" />
 import { INavProps } from '../../nav/Nav/Nav';
-export interface IHeaderProps {
-    className?: CssClassName;
-    view?: CustomView;
+export interface IHeaderProps extends IUiComponent {
+    /**
+    * Свойства для логотипа
+    */
     logo?: {
         title: string;
         linkProps?: Record<string, unknown>;
         icon?: string | any;
         className?: CssClassName;
     };
+    /**
+    * Свойства для навигации
+    */
     nav?: INavProps;
     /**
      * Размер

package/ui/layout/Loader/Loader.d.ts

@@ -1,7 +1,12 @@
 /// <reference types="react" />
 export interface ILoaderProps {
-    view?: CustomView;
+    /**
+    * Размер элемента
+    */
     size?: Size;
+    /**
+     * Название цвета
+     */
     color?: ColorName;
     [key: string]: any;
 }

package/ui/layout/Skeleton/Skeleton.d.ts

@@ -8,11 +8,30 @@ export interface ISkeletonViewProps {
     width?: string | number;
 }
 export interface ISkeletonProps {
+    /**
+    * Дополнительные CSS классы
+    * @example my-block
+    */
     className?: CssClassName;
+    /**
+    * Дочерние элементы
+    */
     children?: React.ReactNode;
+    /**
+    * Тип анимации
+    */
     animation?: 'pulse' | 'wave';
+    /**
+    * Тип компонента
+    */
     type?: 'text' | 'rect' | 'circle';
+    /**
+    * Высота элемента
+    */
     height?: string | number;
+    /**
+    * Ширина элемента
+    */
     width?: string | number;
 }
 declare function Skeleton(props: ISkeletonProps): JSX.Element;

package/ui/list/Pagination/Pagination.d.ts

@@ -39,6 +39,9 @@ export interface IPaginationProps {
      * Дополнительный CSS-класс для элемента отображения
      */
     className?: CssClassName;
+    /**
+    * Параметры кнопки
+    */
     buttonProps?: IButtonProps;
     /**
      * Переопределение view React компонента для кастомизации отображения

package/ui/list/SearchForm/SearchForm.d.ts

@@ -7,6 +7,9 @@ import { IFormProps } from '../../../ui/form/Form/Form';
  * после чего в list-компонент подгружаются новые элементы коллекции.
  */
 export interface ISearchFormProps extends IFormProps {
+    /**
+    * Id списка
+    */
     listId?: string;
 }
 declare const _default: React.MemoExoticComponent<(props: ISearchFormProps) => JSX.Element>;

package/ui/modal/TwoFactorModal/TwoFactorModal.d.ts

@@ -1,7 +1,12 @@
 /// <reference types="react" />
-interface ITwoFactorModalProps {
-    view?: CustomView;
+interface ITwoFactorModalProps extends IUiComponent {
+    /**
+    * Имя провайдера
+    */
     providerName: string;
+    /**
+    * Функция, которая вызывается при закрытии модального окна
+    */
     onClose?: any;
 }
 interface ITwoFactorModalPrivateProps extends ITwoFactorModalProps {

package/ui/typography/Text/Text.d.ts

@@ -1,30 +1,27 @@
 import React from 'react';
-export interface ITextProps {
-    view?: CustomView;
-    className?: CssClassName;
+export interface ITextProps extends IUiComponent {
     /**
     * Дочерние элементы
     */
     children?: React.ReactNode;
     /**
      * Тип текста
-     * @example {'body'}
+     * @example 'body'
      */
     type?: 'body' | 'span' | 'boldSpan' | string;
     /** HTML тег
-     * @example {'span'}
+     * @example 'span'
      */
     tag?: 'p' | 'span' | string;
     /**
      * Цвет текста
-     * @example {'primary'}
+     * @example 'primary'
      */
     color?: ColorName;
     /** Текст
-     * @example {'Simple text'}
+     * @example 'Simple text'
      */
     content?: string;
-    style?: CustomStyle;
 }
 export type ITextViewProps = ITextProps;
 declare function Text(props: ITextProps): JSX.Element;