@steroidsjs/core 3.0.0-beta.9 → 3.0.0-beta.90

package/components/UiComponent.d.ts

@@ -1,10 +1,139 @@
+import * as React from 'react';
 import { ReactNode } from 'react';
 import { IComponents } from '../providers/ComponentsProvider';
 /**
  * Ui Component
  * Компонент для подгрузки и конфигурации UI компонентов приложения
  */
-export default class UiComponent {
+export interface IUiApplicationComponent {
+    /**
+    * Компоненты приложения.
+    */
+    components: IComponents;
+    /**
+    * Иконки для использования в приложении.
+    */
+    icons: {
+        [name: string]: string | number | ReactNode;
+    };
+    /**
+    * Компоненты полей формы для использования в приложении.
+    */
+    fields: any;
+    /**
+    * Компоненты форматтеры для использования в приложении.
+    */
+    formatters: any;
+    /**
+    * Зарегистрированные компоненты полей формы.
+    */
+    _registeredFields: any;
+    /**
+    * Элемент портала.
+    */
+    _portalElement: HTMLElement | null;
+    /**
+     * Добавляет компоненты представлений.
+     * @param {any} components - Компоненты представлений.
+     */
+    addViews(components: any): void;
+    /**
+     * Рендерит компонент представления.
+     * @param {any} Component - Компонент или путь к компоненту представления.
+     * @param {any} props - Свойства компонента.
+     * @param {boolean} [forceNode=false] - Флаг, указывающий на принудительное отображение компонента как узла.
+     * @returns {React.ReactElement<any>|null} Возвращает элемент React или null.
+     */
+    renderView(Component: any, props: any, forceNode?: boolean): React.ReactElement<any> | null;
+    /**
+     * Возвращает компонент представления по указанному пути.
+     * @param {string} path - Путь к компоненту представления.
+     * @returns {any} Компонент представления или undefined, если не найден.
+     */
+    getView(path: any): any;
+    /**
+     * Добавляет компоненты полей формы.
+     * @param {any} components - Компоненты полей формы.
+     */
+    addFields(components: any): void;
+    /**
+     * Возвращает компонент поля формы по указанному пути.
+     * @param {string} path - Путь к компоненту поля формы.
+     * @returns {React.ComponentType<any>|undefined} Компонент поля формы или undefined, если не найден.
+     */
+    getField(path: string): React.ComponentType<any> | undefined;
+    /**
+     * Возвращает свойства конфигурации компонента поля формы по указанному пути.
+     * @param {string} path - Путь к компоненту поля формы.
+     * @param {any} model - Модель.
+     * @param {any} attribute - Атрибут.
+     * @returns {any} Свойства конфигурации компонента поля формы.
+     */
+    getFieldProps(path: string, model?: any, attribute?: any): any;
+    /**
+     * Добавляет компоненты форматтеров.
+     * @param {any} components - Компоненты форматтеров.
+     */
+    addFormatters(components: any): void;
+    /**
+     * Возвращает компонент форматтера по указанному пути.
+     * @param {string} path - Путь к компоненту форматтера.
+     * @returns {React.ComponentType<any>|undefined} Компонент форматтера или undefined, если не найден.
+     */
+    getFormatter(path: string): React.ComponentType<any> | undefined;
+    /**
+     * Возвращает свойства конфигурации компонента форматтера по указанному пути.
+     * @param {string} path - Путь к компоненту форматтера.
+     * @returns {any} Свойства конфигурации компонента форматтера.
+     */
+    getFormatterProps(path: string): any;
+    /**
+     * Добавляет иконки.
+     * @param {{ [name: string]: string | ReactNode }} icons - Иконки.
+     */
+    addIcons(icons: {
+        [name: string]: string | ReactNode;
+    }): void;
+    /**
+     * Возвращает иконку по указанному имени.
+     * @param {string} name - Имя иконки.
+     * @returns {string | number | ReactNode | null} Иконка или null, если не найдена.
+     */
+    getIcon(name: string): string | number | ReactNode | null;
+    /**
+     * Добавляет модели.
+     * @param {any} models - Модели.
+     */
+    addModels(models: any): void;
+    /**
+     * Регистрирует поле формы.
+     * @param {string} formId - Идентификатор формы.
+     * @param {string} attribute - Атрибут.
+     * @param {any} type - Тип.
+     */
+    registerField(formId: string, attribute: string, type: any): void;
+    /**
+     * Возвращает зарегистрированные поля формы для указанного идентификатора формы.
+     * @param {string} formId - Идентификатор формы.
+     * @returns {any} Зарегистрированные поля формы.
+     */
+    getRegisteredFields(formId: string): any;
+    /**
+     * Задает элемент портала.
+     * @param {HTMLElement} element - Элемент портала.
+     */
+    setPortalElement(element: HTMLElement): void;
+    /**
+     * Возвращает элемент портала.
+     * @returns {HTMLElement | null} Элемент портала или null, если не задан.
+     */
+    getPortalElement(): HTMLElement | null;
+}
+/**
+ * Ui Component
+ * Компонент для подгрузки и конфигурации UI компонентов приложения
+ */
+export default class UiComponent implements IUiApplicationComponent {
     components: IComponents;
     _components: any;
     _models: any;