@steroidsjs/core 2.0.0-rc.6 → 2.0.1-beta.112

package/dist/ui/nav/Router/Router.d.ts

@@ -1,49 +1,157 @@
-import * as React from 'react';
-import { IFetchHocConfigFunc } from '../../../hoc/fetch';
-export interface IRouteItem {
-    id?: string;
-    label?: string;
-    title?: string;
-    path?: string;
-    exact?: boolean;
-    redirectTo?: boolean | string;
-    component?: any;
-    componentProps?: any;
-    layout?: string;
-    isVisible?: boolean;
-    isNavVisible?: boolean;
-    models?: string | string[];
-    enums?: string | string[];
-    roles?: string[];
-    fetch?: IFetchHocConfigFunc;
-    items?: IRouteItem[] | {
-        [key: string]: IRouteItem;
-    };
-    [key: string]: any;
-}
-export interface IRouterProps {
-    wrapperView?: any;
-    wrapperProps?: any;
-    routes?: IRouteItem[] | {
-        [key: string]: IRouteItem;
-    };
-    pathname?: string;
-    routeId?: string;
-    activeRouteIds?: string[];
-    defaultRoles?: string[];
-    autoScrollTop?: boolean;
-    history?: any;
-    store?: any;
-    basename?: any;
-    activePath?: string;
-    children?: React.ReactNode;
-}
-export declare const walkRoutesRecursive: (item: any, defaultItem?: any, parentItem?: any) => any;
-export declare const treeToList: (item: any, isRoot?: boolean) => any;
-declare function Router(props: IRouterProps): JSX.Element;
-declare namespace Router {
-    var defaultProps: {
-        autoScrollTop: boolean;
-    };
-}
-export default Router;
+import * as React from 'react';
+import { IFetchConfig } from '../../../hooks/useFetch';
+import { IListProps } from '../../list/List/List';
+import { IFetchHocConfigFunc } from '../../../hoc/fetch';
+export declare const ROUTER_ROLE_LOGIN = "login";
+export declare const ROUTER_ROLE_MODAL = "modal";
+export declare const ROUTER_ROLE_404 = "404";
+/**
+ * Router
+ * Маршрутизатор.
+ * Компонент получает общий для приложения шаблон и дерево роутов. Из дерева роутов посредством React Router
+ * образуется switch-конструкция, которая в зависимости от текущего пути рендерит соответствующий компонент страницы.
+ * Или осуществляет редирект на другую страницу. Все страницы оборачиваются в переданный шаблон.
+ */
+export interface IRouteItem {
+    /**
+     * Идентификатор роута
+     * @example 'catalog'
+     */
+    id?: string;
+    /**
+     * Текст, который отобразится на кнопке навигации для данного роута
+     * @example 'Каталог'
+     */
+    label?: string;
+    /**
+     * Заголовок страницы
+     * @example 'Каталог'
+     */
+    title?: string;
+    /**
+     * Путь до роута
+     * @example '/catalog'
+     */
+    path?: string;
+    /**
+     * Если true, то путь должен точно соответствовать location.pathname
+     * @example '/catalog'
+     */
+    exact?: boolean;
+    /**
+     * В свойстве можно передать как путь, на который осуществится редирект, так и булево значение.
+     * Если свойство равно true - то редирект произойдет на первый из вложенных роутов.
+     * @example true
+     */
+    redirectTo?: boolean | string;
+    /**
+     * Компонент страницы, который отобразится, если путь будет соответствовать location.pathname
+     * @example CatalogPage
+     */
+    component?: any;
+    /**
+     * Свойства для компонента страницы
+     */
+    componentProps?: any;
+    /**
+     * Тип шаблона для данного роута
+     * @example 'dark'
+     */
+    layout?: string;
+    /**
+     * Отображать или показывать роут
+     * @example true
+     */
+    isVisible?: boolean;
+    /**
+     * Отображать ссылку или кнопку в навигации для перехода на данный роут
+     * @example false
+     */
+    isNavVisible?: boolean;
+    /**
+     * Название или список с названиями моделей, полученных с бэкенда
+     */
+    models?: string | string[];
+    /**
+     * Название или список с названиями перечислений, полученных с бэкенда
+     */
+    enums?: string | string[];
+    /**
+     * Назначение страницы, указывается, чтобы приложение автоматически могло найти страницу авторизации или 404-ю..
+     * @example 'login'
+     */
+    role?: 'login' | 'modal' | '404' | string;
+    /**
+     * Список с ролями, который показывает, кому из пользователей будет доступен просмотр страницы
+     * @example ['user', 'admin']
+     */
+    roles?: string[];
+    /**
+     * Обработчик, который возвращает конфигурацию для осуществления HTTP-запроса. Запрос происходит каждый раз
+     * перед рендерингом страницы, чтобы получить для неё все необходимые данные
+     * @param {*} props
+     * @return {Object} Например, {url: '/api/v1/some-data', key: 'someData'}
+     */
+    fetch?: IFetchHocConfigFunc;
+    /**
+     * Вложенные роуты
+     */
+    items?: IRouteItem[] | {
+        [key: string]: IRouteItem;
+    };
+    /**
+     * Обработчик, который принимает параметры URL и возвращает массив с пропсами для хука useFetch и компонента
+     * List.
+     * Функция запускается перед рендерингом приложения в режиме SSR и используется для предварительной
+     * загрузки данных, необходимых на текущей странице.
+     * Хук useFetch и компонент List не будут повторно инициализироваться и делать запросы на клиенте,
+     * если подгруженные данные существуют.
+     * @param {Object} match
+     * @return {Array} Например, [{url: '/api/v1/some-data'}, {listId: 'someList', action: '/api/v1/some-list'}]
+     */
+    preloadData?: (match: Record<string, any>) => (IFetchConfig | IListProps)[];
+    [key: string]: any;
+}
+export interface IRouterProps {
+    /**
+     * Общий шаблон, который оборачивает страницы приложения
+     * @example Layout
+     */
+    wrapperView?: any;
+    /**
+     * Свойства шаблона
+     */
+    wrapperProps?: any;
+    /**
+     * Дерево роутов
+     * @example {id: 'root', path: '/', component: IndexPage, items: [...]}
+     */
+    routes?: IRouteItem[] | {
+        [key: string]: IRouteItem;
+    };
+    /**
+     * Если у роута не задано свойство roles, которое определяет, кому из пользователей будет доступен контент
+     * на соответствующей странице, то подставится стандартный список с ролями
+     * @example [null, 'user', 'admin']
+     */
+    defaultRoles?: string[];
+    /**
+     * Прокрутить страницу к началу при смене url
+     * @example true
+     */
+    autoScrollTop?: boolean;
+    /**
+     * Контент, который отобразится под каждой страницей приложения
+     * @example SomeComponent
+     */
+    children?: React.ReactNode;
+}
+export declare const walkRoutesRecursive: (item: any, defaultItem?: any, parentItem?: any) => any;
+export declare const treeToList: (item: any, isRoot?: boolean) => any;
+declare function Router(props: IRouterProps): JSX.Element;
+declare namespace Router {
+    var defaultProps: {
+        autoScrollTop: boolean;
+    };
+}
+export default Router;