react-toolkits 2.27.10 → 2.27.12

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { ButtonProps, FormInstance, SelectProps, MenuProps, DrawerProps, Button, FormProps, ModalProps } from 'antd';
+import { ButtonProps, FormInstance, SelectProps, DrawerProps, Button, FormProps, ModalProps } from 'antd';
 import { Options } from 'ky';
 import { FC, PropsWithChildren, Key, ReactNode, ReactElement, Ref, DetailedHTMLProps, ImgHTMLAttributes, ComponentProps } from 'react';
 import { ParagraphProps } from 'antd/es/typography/Paragraph';
@@ -272,6 +272,12 @@ declare const useInfiniteListStore: zustand.UseBoundStore<Omit<Omit<zustand.Stor
     };
 }>;
 
+type Prettify<Type> = Type extends Function ? Type : Extract<{
+    [Key in keyof Type]: Type[Key];
+}, Type>;
+
+type Merge<Object1, Object2> = Prettify<Omit<Object1, keyof Object2> & Object2>;
+
 type Area = 'all' | 'cn' | 'global';
 type ScreenOrientation = 0 | 1;
 interface Game {
@@ -289,36 +295,45 @@ interface Game {
     is_new_game: 0 | 1;
     server_type: string;
 }
-
-interface GameSelectProps<T extends Game = Game> {
-    filter?: (game: T) => boolean;
-    options?: (data?: T[]) => SelectProps['options'];
-}
-declare const GameSelect: <T extends Game = Game>(props: GameSelectProps<T>) => react_jsx_runtime.JSX.Element;
-
-type Prettify<Type> = Type extends Function ? Type : Extract<{
-    [Key in keyof Type]: Type[Key];
-}, Type>;
-
-type Merge<Object1, Object2> = Prettify<Omit<Object1, keyof Object2> & Object2>;
-
+/**
+ * 导航菜单项类型
+ * 扩展 antd MenuItemType，添加路由支持
+ */
 type NavMenuItemType = Merge<MenuItemType, {
+    /** react-router-dom 路由地址，用于菜单项点击时跳转 */
     route?: string;
 }>;
+/**
+ * 导航子菜单类型
+ * 使用接口来支持递归类型定义，允许嵌套子菜单
+ */
 interface NavSubMenuType extends Omit<SubMenuType, 'children'> {
+    /** 子菜单项数组，支持嵌套结构 */
     children?: NavItem[];
 }
+/**
+ * 导航菜单组类型
+ * 用于将多个菜单项分组显示，菜单组本身不计入路径
+ */
 interface NavMenuItemGroupType extends Omit<MenuItemGroupType, 'children'> {
+    /** 菜单组内的菜单项数组 */
     children?: NavItem[];
 }
+/**
+ * 导航项联合类型
+ * 包含所有支持的导航项类型：
+ * - 特殊项（如分割线）
+ * - 普通菜单项（NavMenuItemType）
+ * - 子菜单（NavSubMenuType）
+ * - 菜单组（NavMenuItemGroupType）
+ */
 type NavItem = Exclude<ItemType, SubMenuType | MenuItemGroupType | MenuItemType> | NavMenuItemType | NavSubMenuType | NavMenuItemGroupType;
 
-interface NavProps {
-    items?: NavItem[];
-    theme?: MenuProps['theme'];
-    loading?: boolean;
+interface GameSelectProps<T extends Game = Game> {
+    filter?: (game: T) => boolean;
+    options?: (data?: T[]) => SelectProps['options'];
 }
-declare const Nav: (props: NavProps) => react_jsx_runtime.JSX.Element;
+declare const GameSelect: <T extends Game = Game>(props: GameSelectProps<T>) => react_jsx_runtime.JSX.Element;
 
 /** Header 扩展项配置 */
 type HeaderExtra = {
@@ -626,6 +641,20 @@ interface LayoutSlice {
     toggleCollapsed: () => void;
 }
 
+/**
+ * 导航菜单状态接口
+ */
+interface NavSlice {
+    /** 当前展开的菜单项 key 数组 */
+    openKeys: string[];
+    /** 当前选中的菜单项 key 数组 */
+    selectedKeys: string[];
+    /** 设置展开的菜单项 */
+    setOpenKeys: (keys: string[]) => void;
+    /** 设置选中的菜单项 */
+    setSelectedKeys: (keys: string[]) => void;
+}
+
 /**
  * JWT Token 解码后的用户信息
  */
@@ -646,6 +675,7 @@ type ToolkitsState = {
     token: TokenSlice;
     game: GameSlice;
     layout: LayoutSlice;
+    nav: NavSlice;
     clear: () => void;
 };
 
@@ -1008,4 +1038,4 @@ declare function useAuth(code?: string | string[], config?: Options): {
 declare function useMenuList(): _tanstack_react_query.UseQueryResult<MenuListItem[], Error>;
 declare const useGames: () => _tanstack_react_query.UseQueryResult<Game[], Error>;
 
-export { APP_ID_HEADER, AuthButton, type AuthButtonProps, type CacheConfig$1 as CacheConfig, DynamicTags, type DynamicTagsProps, ExpandableParagraph, type ExpandableParagraphProps, FRONTEND_ROUTE_PREFIX, FilterFormWrapper, type FilterFormWrapperProps, type Game, GameSelect, type GameSelectConfig, type GameSelectProps, type HeaderExtra, type HeaderExtraConfig, Highlight, type HighlightProps, type HttpMethod$1 as HttpMethod, InfiniteList, type InfiniteListDataAdapter, type InfiniteListPayload, type InfiniteListProps, type InfiniteListRef, type InfiniteListRequestConfig, type InfiniteListRequestConfigType, type JsonResponse, Layout, type LayoutProps, Logo, type LogoProps, type MenuListItem, Nav, type NavItem, type NavigationConfig, NotFound, OperationLogList, type Permission, PermissionMode, QueryList, QueryListAction, type QueryListPayload, type QueryListProps, type QueryListRef, type RecursivePartial, RequireAuth, type RequireAuthProps, RequireGame, type RouteMatchRule, SSO_URL, SignIn, ToolkitsProvider, type ToolkitsProviderProps, type UseFormDrawerProps, type UseFormModalProps, UserDropdown, type VisibilityState, WILDCARD, createVisibilityStoreConfig, generateId, _default$1 as menu, mixedStorage, _default as permission, useAuth, useDrawer, useDrawerStore, useFormDrawer, useFormModal, useGames, useInfiniteListStore, useMenuList, useModal, useModalStore, useQueryListStore, useToolkitsStore };
+export { APP_ID_HEADER, AuthButton, type AuthButtonProps, type CacheConfig$1 as CacheConfig, DynamicTags, type DynamicTagsProps, ExpandableParagraph, type ExpandableParagraphProps, FRONTEND_ROUTE_PREFIX, FilterFormWrapper, type FilterFormWrapperProps, type Game, GameSelect, type GameSelectConfig, type GameSelectProps, type HeaderExtra, type HeaderExtraConfig, Highlight, type HighlightProps, type HttpMethod$1 as HttpMethod, InfiniteList, type InfiniteListDataAdapter, type InfiniteListPayload, type InfiniteListProps, type InfiniteListRef, type InfiniteListRequestConfig, type InfiniteListRequestConfigType, type JsonResponse, Layout, type LayoutProps, Logo, type LogoProps, type MenuListItem, type NavItem, type NavMenuItemGroupType, type NavMenuItemType, type NavSubMenuType, type NavigationConfig, NotFound, OperationLogList, type Permission, PermissionMode, QueryList, QueryListAction, type QueryListPayload, type QueryListProps, type QueryListRef, type RecursivePartial, RequireAuth, type RequireAuthProps, RequireGame, type RouteMatchRule, SSO_URL, SignIn, ToolkitsProvider, type ToolkitsProviderProps, type UseFormDrawerProps, type UseFormModalProps, UserDropdown, type VisibilityState, WILDCARD, createVisibilityStoreConfig, generateId, _default$1 as menu, mixedStorage, _default as permission, useAuth, useDrawer, useDrawerStore, useFormDrawer, useFormModal, useGames, useInfiniteListStore, useMenuList, useModal, useModalStore, useQueryListStore, useToolkitsStore };