@steroidsjs/core 3.0.0-beta.50 → 3.0.0-beta.51

package/actions/list.d.ts

@@ -1,25 +1,89 @@
 import { IApiMethod } from '../components/ApiComponent';
 export interface IList {
+    /**
+    * Url, который вернет коллекцию элементов.
+    * @example api/v1/articles
+    */
     action?: string | IApiMethod;
+    /**
+    * Тип HTTP запроса (GET | POST | PUT | DELETE)
+    */
     actionMethod?: string;
+    /**
+    * Функция обратного вызова, вызываемая при получении списка.
+    */
     onFetch?: (list: IList, query: Record<string, unknown>, components: any) => Promise<any>;
+    /**
+    * Функция условия, используемая для определения поведения списка на основе параметров запроса.
+    */
     condition?: (query: Record<string, unknown>) => any;
+    /**
+    * Массив строк, представляющих область списка.
+    */
     scope?: string[];
+    /**
+    * Общее количество элементов в списке.
+    */
     total?: number;
+    /**
+    * Массив элементов списка.
+    */
     items?: Array<any>;
+    /**
+    * Массив исходных элементов списка.
+    */
     sourceItems?: Array<any>;
+    /**
+    * Логическое значение, указывающее, является ли список удаленным или нет.
+    */
     isRemote?: boolean;
+    /**
+    * Логическое значение, указывающее, можно ли загрузить еще элементы для списка.
+    */
     loadMore?: boolean;
+    /**
+    * Первичный ключ для списка.
+    */
     primaryKey?: string;
+    /**
+    * Идентификатор списка.
+    */
     listId?: string;
+    /**
+    * Идентификатор формы, связанной с данным списком.
+    */
     formId?: string;
+    /**
+    * Атрибут страницы для списка.
+    */
     pageAttribute?: string;
+    /**
+    * Атрибут размера страницы для списка.
+    */
     pageSizeAttribute?: string;
+    /**
+    * Атрибут сортировки для списка.
+    */
     sortAttribute?: string;
+    /**
+    * Атрибут макета для списка.
+    */
     layoutAttribute?: string;
+    /**
+    * Дополнительные метаданные для списка.
+    */
     meta?: any;
+    /**
+    * Логическое значение, указывающее, был ли список получен или нет.
+    */
     isFetched?: boolean;
+    /**
+    * Логическое значение, указывающее, находится ли список в процессе загрузки или нет.
+    */
     isLoading?: boolean;
+    /**
+    * Название макета, связанного с данным списком.
+    */
     layoutName?: null;
 }
 export declare const LIST_INIT = "@list/init";

package/components/ClientStorageComponent.js

@@ -53,7 +53,7 @@ var ClientStorageComponent = /** @class */ (function () {
         if (this.sessionStorageAvailable) {
             try {
                 window.sessionStorage.setItem('sessionStorageAvailable', '1');
-                this.sessionStorageAvailable = window.localStorage.getItem('sessionStorageAvailable') === '1';
+                this.sessionStorageAvailable = window.sessionStorage.getItem('sessionStorageAvailable') === '1';
                 window.sessionStorage.removeItem('sessionStorageAvailable');
             }
             catch (e) {

package/hooks/useAddressBar.d.ts

@@ -2,8 +2,19 @@
 import { Model } from '../components/MetaComponent';
 export type ListControlPosition = 'top' | 'bottom' | 'both' | string;
 export interface IAddressBarConfig {
+    /**
+   * Флаг для управления включением синхронизации с addressBar
+    * @example true
+    */
     enable?: boolean;
+    /**
+    * Использовать ли #
+    * @example false
+    */
     useHash?: boolean;
+    /**
+    * Модель
+    */
     model?: Model;
 }
 export interface IAddressBarOutput {

package/hooks/useDataSelect.d.ts

@@ -1,5 +1,11 @@
 export interface IDataSelectItem {
+    /**
+    * Идентификатор элемента
+    */
     id: number | string | boolean;
+    /**
+    * Отображаемое название для IDataSelectItem
+    */
     label?: string;
     [key: string]: unknown;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@steroidsjs/core",
- "version": "3.0.0-beta.50",
+ "version": "3.0.0-beta.51",
  "description": "",
  "author": "Vladimir Kozhin <hello@kozhindev.com>",
  "repository": {

package/ui/content/Accordion/Accordion.d.ts

@@ -1,6 +1,14 @@
 import * as React from 'react';
 export interface IAccordionIcon {
+    /**
+    * Пользовательская иконка открытия
+    * @example 'user
+    */
     open: React.ReactElement | string;
+    /**
+    * Пользовательская иконка закрытия
+    * @example 'user'
+    */
     close: React.ReactElement | string;
 }
 export interface IAccordionProps extends IUiComponent {

package/ui/crud/Crud/Crud.d.ts

@@ -6,16 +6,54 @@ import { IFormProps } from '../../form/Form/Form';
 import { IGridProps } from '../../list/Grid/Grid';
 import { IControlItem } from '../../nav/Controls/Controls';
 export interface ICrudItem extends Omit<IControlItem, 'visible' | 'confirm' | 'onClick'> {
+    /**
+    * Заголовок
+    * @example 'Title'
+    */
     title?: string;
+    /**
+    * Название для action
+    * @example
+    */
     actionName?: string;
+    /**
+    * Обязателен ли Personal Key
+    * @example true
+    */
     pkRequired?: boolean;
+    /**
+    * Режим отображения
+    * @example 'modal'
+    */
     mode?: 'page' | 'modal';
+    /**
+    * Компонент
+    */
     component?: any;
+    /**
+    * Свойства компонента
+    */
     componentProps?: any;
+    /**
+    * Коллекция Controls
+    */
     controlsInclude?: string[];
+    /**
+    * Коллекция исключенных Controls
+    */
     controlsExclude?: string[];
+    /**
+    * Управление отображением
+    * @example true
+    */
     visible?: boolean | ((item: any, crudItem: ICrudItem, isGrid: boolean) => boolean);
+    /**
+    * Сообщение о подтверждении
+    */
     confirm?: string | ((e: any, props: ICrudClickProps) => any);
+    /**
+    * Функция обратного вызова, срабатывает после нажатия
+    */
     onClick?: (e: Event | React.MouseEvent, props: ICrudClickProps) => any;
 }
 export interface ICrudClickProps {

package/ui/form/Button/Button.d.ts

@@ -1,8 +1,24 @@
 import * as React from 'react';
 export interface IButtonBadge {
+    /**
+    * Включить/выключить badge
+    * @example true
+    */
     enable?: boolean;
+    /**
+    * Значение badge
+    * @example 'Badge'
+    */
     value?: number;
+    /**
+    * Цвет
+    * @example 'secondary'
+    */
     color?: ColorName;
+    /**
+    * Дополнительный CSS-класс для элемента отображения
+    * @example bem.element('additional-class')
+    */
     className?: CssClassName;
 }
 /**

package/ui/form/DropDownField/DropDownField.d.ts

@@ -11,9 +11,23 @@ export declare const IMG_CONTENT_TYPE = "img";
 export type ContentType = 'checkbox' | 'radio' | 'icon' | 'img';
 export type ItemSwitchType = ContentType | 'group' | string;
 export interface IDropDownFieldItem {
+    /**
+    * Идентификатор элемента
+    */
     id: number | string | boolean;
+    /**
+    * Отображаемое название
+    */
     label: string;
+    /**
+    * Тип контента для элемента
+    * @example 'img'
+    */
     contentType?: ContentType | string;
+    /**
+    * Источник контента
+    * @example 'https://steroids.kozhindev.com/images/icon.png'
+    */
     contentSrc?: string | React.ReactElement;
 }
 export interface IDropDownFieldItemViewProps extends IAccordionItemViewProps, Pick<IDropDownFieldProps, 'itemsContent'> {

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

@@ -23,6 +23,12 @@ export interface IRateFieldProps extends IFieldWrapperInputProps, IUiComponent {
      * @example false
      */
     allowClear?: boolean;
+    /**
+    * Значок (бэйдж) с заголовком.
+    */
+    badge?: {
+        title: string;
+    };
     inputProps?: {
         [key: string]: any;
     };

package/ui/form/RateField/RateField.js

@@ -47,6 +47,7 @@ function RateField(props) {
 RateField.defaultProps = {
     allowClear: false,
     itemsCount: 5,
-    disabled: false
+    disabled: false,
+    size: 'md'
 };
 exports["default"] = (0, fieldWrapper_1["default"])('RateField', RateField);

package/ui/layout/Notifications/Notifications.d.ts

@@ -14,6 +14,9 @@ import * as React from 'react';
  * ```
  */
 interface INotificationItem {
+    /**
+    * Идентификатор уведомления
+    */
     id?: number;
     /**
      * Цвет всплывающего уведомления
@@ -28,14 +31,37 @@ interface INotificationItem {
     isClosing?: boolean;
 }
 export interface INotificationsProps {
+    /**
+    * Исходные уведомления
+    */
     initialFlashes?: {
         [key: string]: string | any;
     };
+    /**
+    * Коллекция уведомлений
+    */
     notifications?: INotificationItem[];
+    /**
+    * Задержка перед закрытием
+    */
     closeTimeoutMs?: number;
+    /**
+    * Дополнительный CSS-класс для элемента отображения
+    */
     className?: CssClassName;
+    /**
+     * Переопределение view React компонента для кастомизации отображения
+     * @example MyCustomView
+     */
     view?: CustomView;
+    /**
+     * Переопределение view React компонента для кастомизации отображения элемента
+     * @example MyCustomView
+     */
     itemView?: any;
+    /**
+    * Позиционирование элемента уведомления
+    */
     position?: string;
     [key: string]: any;
 }

package/ui/layout/Tooltip/Tooltip.d.ts

@@ -5,14 +5,35 @@
  */
 type TooltipPosition = 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft' | 'bottomRight' | 'left' | 'leftTop' | 'leftBottom' | 'right' | 'rightTop' | 'rightBottom' | string;
 export interface ITooltipArrowPosition {
+    /**
+    * Позиция стрелки слева
+    */
     left?: number | string;
+    /**
+    * Позиция стрелки справа
+    */
     right?: number | string;
+    /**
+    * Позиция стрелки сверху
+    */
     top?: number | string;
+    /**
+    * Позиция стрелки снизу
+    */
     bottom?: number | string;
 }
 export interface ITooltipStylePosition {
+    /**
+    * Позиция Tooltip слева
+    */
     left: 'unset' | number;
+    /**
+    * Позиция Tooltip справа
+    */
     right: 'unset' | number;
+    /**
+    * Позиция Tooltip сверху
+    */
     top: 'unset' | number;
 }
 export interface ITooltipProps {