@v-miniapp/router 1.0.5

package/README.md

@@ -0,0 +1,63 @@
+# @v-miniapp/router
+
+**@v-miniapp/router** là bộ thư viện component React mạnh mẽ được thiết kế đặc biệt cho việc phát triển Router V-MiniApp.
+
+## Cài đặt
+
+```bash
+npm install @v-miniapp/router
+# hoặc
+pnpm add @v-miniapp/router
+# hoặc
+yarn add @v-miniapp/router
+```
+
+## Import Styles
+
+Đảm bảo bạn import CSS từ phía component để UI hoạt động tốt nhất:
+
+```tsx
+import '@v-miniapp/router/styles.css'
+```
+
+## Ví dụ bắt đầu sử dụng
+
+```tsx
+import { Router, type IRouterConfig } from '@v-miniapp/router'
+
+// Tạo các page components
+const HomePage = () => {
+  return <div>Trang chủ</div>
+}
+
+const SettingsPage = () => {
+  return <div>Cài đặt</div>
+}
+
+const routerConfig: IRouterConfig = {
+  // Animation giữa các pages: 'none', 'slide_up', 'slide_left', 'fade_in'
+  animation: {
+    type: 'slide_left',
+  },
+
+  // Keep-alive: giữ state của pages khi navigate
+  keepAlive: {
+    enable: true,
+  },
+
+  pages: [
+    {
+      pathname: '/home',
+      Component: HomePage,
+    },
+    {
+      pathname: '/settings',
+      Component: SettingsPage,
+    },
+  ],
+}
+
+export const MiniApp = () => {
+  return <Router config={appConfig} />
+}
+```

package/dist/components/error/error-boundary.d.ts

@@ -0,0 +1,15 @@
+import { default as React, ComponentType } from 'react';
+type IErrorBoundaryProps = {
+    children: React.ReactNode;
+    Component?: ComponentType;
+};
+type IErrorBoundaryState = {
+    hasError: boolean;
+    error: Error | null;
+};
+export declare class ErrorBoundary extends React.Component<IErrorBoundaryProps, IErrorBoundaryState> {
+    constructor(props: IErrorBoundaryProps);
+    static getDerivedStateFromError(error: Error): Partial<IErrorBoundaryState>;
+    render(): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | null | undefined;
+}
+export {};

package/dist/components/error/index.d.ts

@@ -0,0 +1 @@
+export * from './error-boundary';

package/dist/components/freeze/index.d.ts

@@ -0,0 +1,11 @@
+import { default as React } from 'react';
+type ISuspenderProps = {
+    freeze: boolean;
+    children: React.ReactNode;
+};
+type IFreezeProps = ISuspenderProps & {
+    placeholder?: React.ReactNode;
+    delay?: number;
+};
+export declare function Freeze({ freeze, delay, children, placeholder, }: IFreezeProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/layout/index.d.ts

@@ -0,0 +1 @@
+export * from './page-loading';

package/dist/components/layout/page-loading.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const PageLoading: React.FC;

package/dist/components/link/index.d.ts

@@ -0,0 +1,8 @@
+import { ComponentProps, FC } from 'react';
+import { INavigateDeltaOptions, INavigatePathnameOptions } from '../../types';
+export type ILinkProps = Omit<ComponentProps<'a'>, 'href' | 'onClick'> & (({
+    to: number;
+} & INavigateDeltaOptions) | ({
+    to: string;
+} & INavigatePathnameOptions));
+export declare const Link: FC<ILinkProps>;

package/dist/components/router/index.d.ts

@@ -0,0 +1 @@
+export * from './router';

package/dist/components/router/pages-render.d.ts

@@ -0,0 +1,2 @@
+import { FC } from 'react';
+export declare const PagesRender: FC;

package/dist/components/router/render-layout.d.ts

@@ -0,0 +1,5 @@
+import { ILayout } from '../../types';
+import { FC, PropsWithChildren } from 'react';
+export declare const LayoutsRender: FC<PropsWithChildren & {
+    Layouts: ILayout[];
+}>;

package/dist/components/router/router.d.ts

@@ -0,0 +1,6 @@
+import { IRouterConfig } from '../../types/router';
+export type IRouterConfigFunction = () => IRouterConfig;
+export type IRouterProps = {
+    config: IRouterConfig | IRouterConfigFunction;
+};
+export declare const Router: ({ config }: IRouterProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/router/style-pages-render.d.ts

@@ -0,0 +1,2 @@
+import { FC } from 'react';
+export declare const StylePagesRender: FC;

package/dist/context/location-key.d.ts

@@ -0,0 +1,4 @@
+export type ILocationKeyState = {
+    locationKey: string | null;
+};
+export declare const LocationKeyContext: import('react').Context<ILocationKeyState>;

package/dist/hooks/index.d.ts

@@ -0,0 +1,10 @@
+export * from './use-app-pause';
+export * from './use-app-resume';
+export * from './use-app-state';
+export * from './use-did-hide';
+export * from './use-did-show';
+export * from './use-history';
+export * from './use-location';
+export * from './use-navigate';
+export * from './use-navigation-type';
+export * from './use-swipe-navigation';

package/dist/hooks/use-app-pause.d.ts

@@ -0,0 +1 @@
+export declare const useAppPause: (onPause: () => void) => void;

package/dist/hooks/use-app-resume.d.ts

@@ -0,0 +1 @@
+export declare const useAppResume: (onResume: () => void) => void;

package/dist/hooks/use-app-state.d.ts

@@ -0,0 +1,7 @@
+import { IRouterAppState } from '../types/router';
+import { Dispatch, SetStateAction } from 'react';
+export declare const useAppState: () => {
+    config: import('../types/router').IRouterConfig;
+    appState: IRouterAppState;
+    setAppState: Dispatch<SetStateAction<IRouterAppState>>;
+};

package/dist/hooks/use-did-hide.d.ts

@@ -0,0 +1 @@
+export declare const useDidHide: (func?: () => void) => boolean;

package/dist/hooks/use-did-show.d.ts

@@ -0,0 +1 @@
+export declare const useDidShow: (func?: () => void) => boolean;

package/dist/hooks/use-history.d.ts

@@ -0,0 +1,2 @@
+export declare const useHistory: () => import('..').IHistory;
+export declare const useHistories: () => import('..').IHistory[];

package/dist/hooks/use-location.d.ts

@@ -0,0 +1 @@
+export declare const useLocation: () => import('..').ILocation;

package/dist/hooks/use-navigate.d.ts

@@ -0,0 +1 @@
+export declare const useNavigate: () => import('..').INavigate;

package/dist/hooks/use-navigation-type.d.ts

@@ -0,0 +1 @@
+export declare const useNavigationType: () => import('..').IHistoryAction;

package/dist/hooks/use-swipe-navigation.d.ts

@@ -0,0 +1,2 @@
+export declare const useSwipeNavigation: () => import('react').RefObject<boolean>;
+export declare const onSwipeNavigation: (callback: (isSwipeNavigation: boolean) => void) => () => void;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './components/router';
+export * from './components/link';
+export * from './hooks';
+export { PAGE_PATH_NAME } from './utils/history';
+export type * from './types';
+export { routerEvents } from './stores/router';