path-rush 1.4.1 → 1.6.0

package/dist/react.d.cts

@@ -1,7 +1,8 @@
 import * as React from 'react';
 import React__default from 'react';
-import { LinkProps } from 'react-router-dom';
-export { LinkProps, Location, NavLink, NavLinkProps, Navigate, NavigateOptions, NavigateProps, Params, To, useLocation, useNavigate, useParams, useSearchParams } from 'react-router-dom';
+import * as react_router_dom from 'react-router-dom';
+import { LinkProps, NavLinkProps, Navigate as Navigate$1, Location as Location$1 } from 'react-router-dom';
+export { LinkProps, NavLinkProps, NavigateOptions, NavigateProps, To } from 'react-router-dom';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 declare function useLink(props: {
@@ -11,8 +12,84 @@ declare function useLink(props: {
     isActive: boolean;
 };
 
+/**
+ * Компонент для навигационных ссылок
+ *
+ * Используется для клиентской навигации без перезагрузки страницы
+ *
+ * @example
+ * ```tsx
+ * <Link to="/about">About</Link>
+ * <Link to="/users/123" state={{ from: 'home' }}>User Profile</Link>
+ * ```
+ */
 declare const Link: React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLAnchorElement>>;
 
+/**
+ * Компонент для навигационных ссылок с поддержкой активного состояния
+ *
+ * Автоматически добавляет класс 'active' когда маршрут активен
+ *
+ * @example
+ * ```tsx
+ * <NavLink to="/about">About</NavLink>
+ * <NavLink to="/users" className={({ isActive }) => isActive ? 'active' : ''}>
+ *   Users
+ * </NavLink>
+ * ```
+ */
+declare const NavLink: React.ForwardRefExoticComponent<NavLinkProps & React.RefAttributes<HTMLAnchorElement>>;
+
+/**
+ * Компонент для программного редиректа
+ *
+ * @example
+ * ```tsx
+ * <Navigate to="/login" replace />
+ * <Navigate to="/dashboard" state={{ from: location }} />
+ * ```
+ */
+declare const Navigate: typeof Navigate$1;
+
+interface RouteTransitionProps {
+    children: React__default.ReactNode;
+    /**
+     * CSS класс для анимации входа
+     * @default 'route-enter'
+     */
+    enterClass?: string;
+    /**
+     * CSS класс для активного состояния (после входа)
+     * @default 'route-enter-active'
+     */
+    enterActiveClass?: string;
+    /**
+     * CSS класс для анимации выхода
+     * @default 'route-exit'
+     */
+    exitClass?: string;
+    /**
+     * CSS класс для активного состояния выхода
+     * @default 'route-exit-active'
+     */
+    exitActiveClass?: string;
+    /**
+     * Длительность анимации в миллисекундах
+     * @default 300
+     */
+    duration?: number;
+    /**
+     * Кастомная функция для анимации
+     */
+    onTransition?: (direction: 'enter' | 'exit') => void;
+    /**
+     * Режим анимации: 'fade', 'slide', 'custom'
+     * @default 'fade'
+     */
+    mode?: 'fade' | 'slide' | 'custom';
+}
+declare function RouteTransition({ children, enterClass, enterActiveClass, exitClass, exitActiveClass, duration, onTransition, mode, }: RouteTransitionProps): react_jsx_runtime.JSX.Element;
+
 type RouterProviderProps = {
     /**
      * ⏳ Кастомный индикатор загрузки
@@ -39,9 +116,96 @@ type RouterProviderProps = {
      * @default '/'
      */
     basePath?: string;
+    /**
+     * 🎬 Включить анимации переходов между страницами
+     *
+     * ▸ Если true, страницы будут анимироваться при переключении
+     *
+     * ▸ Можно настроить через transitionConfig
+     *
+     * @default false
+     */
+    enableTransitions?: boolean;
+    /**
+     * ⚙️ Конфигурация анимаций переходов
+     *
+     * ▸ Настройка CSS классов и параметров анимации
+     *
+     * ▸ Если не указано, используются значения по умолчанию
+     */
+    transitionConfig?: {
+        enterClass?: string;
+        enterActiveClass?: string;
+        exitClass?: string;
+        exitActiveClass?: string;
+        duration?: number;
+        mode?: 'fade' | 'slide' | 'custom';
+        onTransition?: (direction: 'enter' | 'exit') => void;
+    };
     children?: React__default.ReactNode;
 };
 
-declare function RouterProvider({ children, preloader, basePath, }: Readonly<RouterProviderProps>): react_jsx_runtime.JSX.Element;
+declare function RouterProvider({ children, preloader, basePath, enableTransitions, transitionConfig, }: Readonly<RouterProviderProps>): react_jsx_runtime.JSX.Element;
+
+/**
+ * Тип локации с информацией о текущем маршруте
+ */
+type Location = Location$1;
+/**
+ * Хук для получения текущей локации
+ *
+ * @returns Объект с информацией о текущем маршруте
+ *
+ * @example
+ * ```tsx
+ * const location = useLocation()
+ * console.log(location.pathname) // '/about'
+ * console.log(location.search) // '?id=123'
+ * ```
+ */
+declare function useLocation(): Location;
+
+/**
+ * Хук для программной навигации
+ *
+ * @returns Функция для навигации
+ *
+ * @example
+ * ```tsx
+ * const navigate = useNavigate()
+ * navigate('/about')
+ * navigate('/users', { replace: true })
+ * navigate(-1) // назад
+ * ```
+ */
+declare function useNavigate(): react_router_dom.NavigateFunction;
+
+type Params = Record<string, string | undefined>;
+/**
+ * Хук для получения параметров маршрута
+ *
+ * @returns Объект с параметрами текущего маршрута
+ *
+ * @example
+ * ```tsx
+ * // Для маршрута /users/:id
+ * const { id } = useParams()
+ * ```
+ */
+declare function useParams<T extends Params = Params>(): T;
+
+/**
+ * Хук для работы с query параметрами URL
+ *
+ * @returns Кортеж из [searchParams, setSearchParams]
+ *
+ * @example
+ * ```tsx
+ * const [searchParams, setSearchParams] = useSearchParams()
+ * const id = searchParams.get('id')
+ * setSearchParams({ id: '123' })
+ * ```
+ */
+declare function useSearchParams(): [URLSearchParams, react_router_dom.SetURLSearchParams];
 
-export { Link, RouterProvider, type RouterProviderProps, useLink };
+export { Link, type Location, NavLink, Navigate, type Params, RouteTransition, type RouteTransitionProps, RouterProvider, type RouterProviderProps, useLink, useLocation, useNavigate, useParams, useSearchParams };

package/dist/react.d.ts

@@ -1,7 +1,8 @@
 import * as React from 'react';
 import React__default from 'react';
-import { LinkProps } from 'react-router-dom';
-export { LinkProps, Location, NavLink, NavLinkProps, Navigate, NavigateOptions, NavigateProps, Params, To, useLocation, useNavigate, useParams, useSearchParams } from 'react-router-dom';
+import * as react_router_dom from 'react-router-dom';
+import { LinkProps, NavLinkProps, Navigate as Navigate$1, Location as Location$1 } from 'react-router-dom';
+export { LinkProps, NavLinkProps, NavigateOptions, NavigateProps, To } from 'react-router-dom';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 declare function useLink(props: {
@@ -11,8 +12,84 @@ declare function useLink(props: {
     isActive: boolean;
 };
 
+/**
+ * Компонент для навигационных ссылок
+ *
+ * Используется для клиентской навигации без перезагрузки страницы
+ *
+ * @example
+ * ```tsx
+ * <Link to="/about">About</Link>
+ * <Link to="/users/123" state={{ from: 'home' }}>User Profile</Link>
+ * ```
+ */
 declare const Link: React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLAnchorElement>>;
 
+/**
+ * Компонент для навигационных ссылок с поддержкой активного состояния
+ *
+ * Автоматически добавляет класс 'active' когда маршрут активен
+ *
+ * @example
+ * ```tsx
+ * <NavLink to="/about">About</NavLink>
+ * <NavLink to="/users" className={({ isActive }) => isActive ? 'active' : ''}>
+ *   Users
+ * </NavLink>
+ * ```
+ */
+declare const NavLink: React.ForwardRefExoticComponent<NavLinkProps & React.RefAttributes<HTMLAnchorElement>>;
+
+/**
+ * Компонент для программного редиректа
+ *
+ * @example
+ * ```tsx
+ * <Navigate to="/login" replace />
+ * <Navigate to="/dashboard" state={{ from: location }} />
+ * ```
+ */
+declare const Navigate: typeof Navigate$1;
+
+interface RouteTransitionProps {
+    children: React__default.ReactNode;
+    /**
+     * CSS класс для анимации входа
+     * @default 'route-enter'
+     */
+    enterClass?: string;
+    /**
+     * CSS класс для активного состояния (после входа)
+     * @default 'route-enter-active'
+     */
+    enterActiveClass?: string;
+    /**
+     * CSS класс для анимации выхода
+     * @default 'route-exit'
+     */
+    exitClass?: string;
+    /**
+     * CSS класс для активного состояния выхода
+     * @default 'route-exit-active'
+     */
+    exitActiveClass?: string;
+    /**
+     * Длительность анимации в миллисекундах
+     * @default 300
+     */
+    duration?: number;
+    /**
+     * Кастомная функция для анимации
+     */
+    onTransition?: (direction: 'enter' | 'exit') => void;
+    /**
+     * Режим анимации: 'fade', 'slide', 'custom'
+     * @default 'fade'
+     */
+    mode?: 'fade' | 'slide' | 'custom';
+}
+declare function RouteTransition({ children, enterClass, enterActiveClass, exitClass, exitActiveClass, duration, onTransition, mode, }: RouteTransitionProps): react_jsx_runtime.JSX.Element;
+
 type RouterProviderProps = {
     /**
      * ⏳ Кастомный индикатор загрузки
@@ -39,9 +116,96 @@ type RouterProviderProps = {
      * @default '/'
      */
     basePath?: string;
+    /**
+     * 🎬 Включить анимации переходов между страницами
+     *
+     * ▸ Если true, страницы будут анимироваться при переключении
+     *
+     * ▸ Можно настроить через transitionConfig
+     *
+     * @default false
+     */
+    enableTransitions?: boolean;
+    /**
+     * ⚙️ Конфигурация анимаций переходов
+     *
+     * ▸ Настройка CSS классов и параметров анимации
+     *
+     * ▸ Если не указано, используются значения по умолчанию
+     */
+    transitionConfig?: {
+        enterClass?: string;
+        enterActiveClass?: string;
+        exitClass?: string;
+        exitActiveClass?: string;
+        duration?: number;
+        mode?: 'fade' | 'slide' | 'custom';
+        onTransition?: (direction: 'enter' | 'exit') => void;
+    };
     children?: React__default.ReactNode;
 };
 
-declare function RouterProvider({ children, preloader, basePath, }: Readonly<RouterProviderProps>): react_jsx_runtime.JSX.Element;
+declare function RouterProvider({ children, preloader, basePath, enableTransitions, transitionConfig, }: Readonly<RouterProviderProps>): react_jsx_runtime.JSX.Element;
+
+/**
+ * Тип локации с информацией о текущем маршруте
+ */
+type Location = Location$1;
+/**
+ * Хук для получения текущей локации
+ *
+ * @returns Объект с информацией о текущем маршруте
+ *
+ * @example
+ * ```tsx
+ * const location = useLocation()
+ * console.log(location.pathname) // '/about'
+ * console.log(location.search) // '?id=123'
+ * ```
+ */
+declare function useLocation(): Location;
+
+/**
+ * Хук для программной навигации
+ *
+ * @returns Функция для навигации
+ *
+ * @example
+ * ```tsx
+ * const navigate = useNavigate()
+ * navigate('/about')
+ * navigate('/users', { replace: true })
+ * navigate(-1) // назад
+ * ```
+ */
+declare function useNavigate(): react_router_dom.NavigateFunction;
+
+type Params = Record<string, string | undefined>;
+/**
+ * Хук для получения параметров маршрута
+ *
+ * @returns Объект с параметрами текущего маршрута
+ *
+ * @example
+ * ```tsx
+ * // Для маршрута /users/:id
+ * const { id } = useParams()
+ * ```
+ */
+declare function useParams<T extends Params = Params>(): T;
+
+/**
+ * Хук для работы с query параметрами URL
+ *
+ * @returns Кортеж из [searchParams, setSearchParams]
+ *
+ * @example
+ * ```tsx
+ * const [searchParams, setSearchParams] = useSearchParams()
+ * const id = searchParams.get('id')
+ * setSearchParams({ id: '123' })
+ * ```
+ */
+declare function useSearchParams(): [URLSearchParams, react_router_dom.SetURLSearchParams];
 
-export { Link, RouterProvider, type RouterProviderProps, useLink };
+export { Link, type Location, NavLink, Navigate, type Params, RouteTransition, type RouteTransitionProps, RouterProvider, type RouterProviderProps, useLink, useLocation, useNavigate, useParams, useSearchParams };