antd-overlay 0.3.0 → 0.4.0

package/dist/index.d.cts

@@ -1,10 +1,11 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ModalProps, DrawerProps } from 'antd';
+import { ModalProps, DrawerProps, TourProps } from 'antd';
 import * as React$1 from 'react';
 import React__default from 'react';
 
 type DefaultModalProps = Partial<ModalProps>;
 type DefaultDrawerProps = Partial<DrawerProps>;
+type DefaultTourProps = Partial<TourProps>;
 /**
  * AntdOverlay Context 的值类型
  *
@@ -23,12 +24,14 @@ interface AntdOverlayContextValue {
     defaultModalProps?: DefaultModalProps;
     /** 默认 Drawer 属性 */
     defaultDrawerProps?: DefaultDrawerProps;
+    /** 默认 Tour 属性 */
+    defaultTourProps?: DefaultTourProps;
 }
 /**
  * AntdOverlay 容器提供者组件
  *
  * 用于管理全局覆盖层的挂载点。所有通过 useGlobalOverlay、useGlobalModal、
- * useGlobalDrawer 等 Hook 创建的覆盖层都会被挂载到这个 Provider 下。
+ * useGlobalDrawer、useGlobalTour 等 Hook 创建的覆盖层都会被挂载到这个 Provider 下。
  *
  * 渲染结构：
  * ```
@@ -73,15 +76,18 @@ interface AntdOverlayProviderProps {
     defaultModalProps?: DefaultModalProps;
     /** 默认 Drawer 属性 */
     defaultDrawerProps?: DefaultDrawerProps;
+    /** 默认 Tour 属性 */
+    defaultTourProps?: DefaultTourProps;
 }
 /**
  * AntdOverlayProvider 组件
  * @param children - 子节点
  * @param defaultModalProps - 默认 Modal 属性
  * @param defaultDrawerProps - 默认 Drawer 属性
+ * @param defaultTourProps - 默认 Tour 属性
  * @returns React.ReactNode
  */
-declare function AntdOverlayProvider({ children, defaultModalProps, defaultDrawerProps, }: AntdOverlayProviderProps): react_jsx_runtime.JSX.Element;
+declare function AntdOverlayProvider({ children, defaultModalProps, defaultDrawerProps, defaultTourProps, }: AntdOverlayProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * 获取 AntdOverlay Context 的 Hook
  *
@@ -678,6 +684,41 @@ declare function generateUseDrawerHook<T extends CustomDrawerProps>(DrawerCompon
     useGlobalDrawer: (options?: UseDrawerOptions<T>) => OverlayOpener<T>;
 };
 
+/**
+ * 自定义 Tour 组件的属性接口
+ * 继承 Ant Design TourProps 并添加自定义属性
+ *
+ * @template T - customOk 回调的参数类型
+ * @template R - customOk 回调的返回类型
+ */
+interface CustomTourProps<T = any, R = void> extends TourProps, CustomOverlayProps<T, R> {
+}
+/**
+ * useTour Hook 的配置选项
+ * 排除了 propsAdapter 和 keyPrefix，这些由内部自动处理。
+ * 与 {@link UseOverlayOptions} 一致：可在顶层或 defaultProps 中传入默认 Tour 属性。
+ */
+type UseTourOptions<T extends CustomTourProps = CustomTourProps> = Omit<UseOverlayOptions<T>, 'propsAdapter' | 'keyPrefix'>;
+/**
+ * Tour 管理 Hook
+ *
+ * @returns 元组 [openTour, contextHolder]
+ */
+declare function useTour<T extends CustomTourProps>(TourComponent: React.FC<T>, options?: UseTourOptions<T>): [OverlayOpener<T>, React.ReactNode];
+/**
+ * 全局 Tour 管理 Hook
+ *
+ * 与 useTour 的区别：无需手动渲染 contextHolder，Tour 会自动挂载到全局容器。
+ */
+declare function useGlobalTour<T extends CustomTourProps>(TourComponent: React.FC<T>, options?: UseTourOptions<T>): OverlayOpener<T>;
+/**
+ * 生成绑定了特定 Tour 组件的 Hook 工厂函数
+ */
+declare function generateUseTourHook<T extends CustomTourProps>(TourComponent: React.FC<T>): {
+    useTour: (options?: UseTourOptions<T>) => [OverlayOpener<T>, React$1.ReactNode];
+    useGlobalTour: (options?: UseTourOptions<T>) => OverlayOpener<T>;
+};
+
 /**
  * @file usePromiseOverlay - 命令式 Promise 风格的覆盖层管理 Hook
  * @description
@@ -796,4 +837,4 @@ declare function generateUsePromiseDrawerHook<T extends CustomDrawerProps>(Drawe
     useGlobalPromiseDrawer: (options?: UsePromiseDrawerOptions<T>) => PromiseOverlayOpener<T>;
 };
 
-export { AntdOverlayProvider, type AntdOverlayProviderProps, type CustomDrawerProps, type CustomModalProps, type CustomOkValue, type CustomOverlayProps, type DefaultDrawerProps, type DefaultModalProps, type InternalOverlayProps, type OverlayController, type OverlayOpener, type PromiseOverlayOpener, type UseDrawerOptions, type UseModalOptions, type UseOverlayOptions, type UsePromiseDrawerOptions, type UsePromiseModalOptions, type UsePromiseOverlayOptions, generateUseDrawerHook, generateUseModalHook, generateUseOverlayHook, generateUsePromiseDrawerHook, generateUsePromiseModalHook, generateUsePromiseOverlayHook, useAntdOverlayContext, useDrawer, useGlobalDrawer, useGlobalModal, useGlobalOverlay, useGlobalPromiseDrawer, useGlobalPromiseModal, useGlobalPromiseOverlay, useModal, useOverlay, usePromiseDrawer, usePromiseModal, usePromiseOverlay };
+export { AntdOverlayProvider, type AntdOverlayProviderProps, type CustomDrawerProps, type CustomModalProps, type CustomOkValue, type CustomOverlayProps, type CustomTourProps, type DefaultDrawerProps, type DefaultModalProps, type DefaultTourProps, type InternalOverlayProps, type OverlayController, type OverlayOpener, type PromiseOverlayOpener, type UseDrawerOptions, type UseModalOptions, type UseOverlayOptions, type UsePromiseDrawerOptions, type UsePromiseModalOptions, type UsePromiseOverlayOptions, type UseTourOptions, generateUseDrawerHook, generateUseModalHook, generateUseOverlayHook, generateUsePromiseDrawerHook, generateUsePromiseModalHook, generateUsePromiseOverlayHook, generateUseTourHook, useAntdOverlayContext, useDrawer, useGlobalDrawer, useGlobalModal, useGlobalOverlay, useGlobalPromiseDrawer, useGlobalPromiseModal, useGlobalPromiseOverlay, useGlobalTour, useModal, useOverlay, usePromiseDrawer, usePromiseModal, usePromiseOverlay, useTour };

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ModalProps, DrawerProps } from 'antd';
+import { ModalProps, DrawerProps, TourProps } from 'antd';
 import * as React$1 from 'react';
 import React__default from 'react';
 
 type DefaultModalProps = Partial<ModalProps>;
 type DefaultDrawerProps = Partial<DrawerProps>;
+type DefaultTourProps = Partial<TourProps>;
 /**
  * AntdOverlay Context 的值类型
  *
@@ -23,12 +24,14 @@ interface AntdOverlayContextValue {
     defaultModalProps?: DefaultModalProps;
     /** 默认 Drawer 属性 */
     defaultDrawerProps?: DefaultDrawerProps;
+    /** 默认 Tour 属性 */
+    defaultTourProps?: DefaultTourProps;
 }
 /**
  * AntdOverlay 容器提供者组件
  *
  * 用于管理全局覆盖层的挂载点。所有通过 useGlobalOverlay、useGlobalModal、
- * useGlobalDrawer 等 Hook 创建的覆盖层都会被挂载到这个 Provider 下。
+ * useGlobalDrawer、useGlobalTour 等 Hook 创建的覆盖层都会被挂载到这个 Provider 下。
  *
  * 渲染结构：
  * ```
@@ -73,15 +76,18 @@ interface AntdOverlayProviderProps {
     defaultModalProps?: DefaultModalProps;
     /** 默认 Drawer 属性 */
     defaultDrawerProps?: DefaultDrawerProps;
+    /** 默认 Tour 属性 */
+    defaultTourProps?: DefaultTourProps;
 }
 /**
  * AntdOverlayProvider 组件
  * @param children - 子节点
  * @param defaultModalProps - 默认 Modal 属性
  * @param defaultDrawerProps - 默认 Drawer 属性
+ * @param defaultTourProps - 默认 Tour 属性
  * @returns React.ReactNode
  */
-declare function AntdOverlayProvider({ children, defaultModalProps, defaultDrawerProps, }: AntdOverlayProviderProps): react_jsx_runtime.JSX.Element;
+declare function AntdOverlayProvider({ children, defaultModalProps, defaultDrawerProps, defaultTourProps, }: AntdOverlayProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * 获取 AntdOverlay Context 的 Hook
  *
@@ -678,6 +684,41 @@ declare function generateUseDrawerHook<T extends CustomDrawerProps>(DrawerCompon
     useGlobalDrawer: (options?: UseDrawerOptions<T>) => OverlayOpener<T>;
 };
 
+/**
+ * 自定义 Tour 组件的属性接口
+ * 继承 Ant Design TourProps 并添加自定义属性
+ *
+ * @template T - customOk 回调的参数类型
+ * @template R - customOk 回调的返回类型
+ */
+interface CustomTourProps<T = any, R = void> extends TourProps, CustomOverlayProps<T, R> {
+}
+/**
+ * useTour Hook 的配置选项
+ * 排除了 propsAdapter 和 keyPrefix，这些由内部自动处理。
+ * 与 {@link UseOverlayOptions} 一致：可在顶层或 defaultProps 中传入默认 Tour 属性。
+ */
+type UseTourOptions<T extends CustomTourProps = CustomTourProps> = Omit<UseOverlayOptions<T>, 'propsAdapter' | 'keyPrefix'>;
+/**
+ * Tour 管理 Hook
+ *
+ * @returns 元组 [openTour, contextHolder]
+ */
+declare function useTour<T extends CustomTourProps>(TourComponent: React.FC<T>, options?: UseTourOptions<T>): [OverlayOpener<T>, React.ReactNode];
+/**
+ * 全局 Tour 管理 Hook
+ *
+ * 与 useTour 的区别：无需手动渲染 contextHolder，Tour 会自动挂载到全局容器。
+ */
+declare function useGlobalTour<T extends CustomTourProps>(TourComponent: React.FC<T>, options?: UseTourOptions<T>): OverlayOpener<T>;
+/**
+ * 生成绑定了特定 Tour 组件的 Hook 工厂函数
+ */
+declare function generateUseTourHook<T extends CustomTourProps>(TourComponent: React.FC<T>): {
+    useTour: (options?: UseTourOptions<T>) => [OverlayOpener<T>, React$1.ReactNode];
+    useGlobalTour: (options?: UseTourOptions<T>) => OverlayOpener<T>;
+};
+
 /**
  * @file usePromiseOverlay - 命令式 Promise 风格的覆盖层管理 Hook
  * @description
@@ -796,4 +837,4 @@ declare function generateUsePromiseDrawerHook<T extends CustomDrawerProps>(Drawe
     useGlobalPromiseDrawer: (options?: UsePromiseDrawerOptions<T>) => PromiseOverlayOpener<T>;
 };
 
-export { AntdOverlayProvider, type AntdOverlayProviderProps, type CustomDrawerProps, type CustomModalProps, type CustomOkValue, type CustomOverlayProps, type DefaultDrawerProps, type DefaultModalProps, type InternalOverlayProps, type OverlayController, type OverlayOpener, type PromiseOverlayOpener, type UseDrawerOptions, type UseModalOptions, type UseOverlayOptions, type UsePromiseDrawerOptions, type UsePromiseModalOptions, type UsePromiseOverlayOptions, generateUseDrawerHook, generateUseModalHook, generateUseOverlayHook, generateUsePromiseDrawerHook, generateUsePromiseModalHook, generateUsePromiseOverlayHook, useAntdOverlayContext, useDrawer, useGlobalDrawer, useGlobalModal, useGlobalOverlay, useGlobalPromiseDrawer, useGlobalPromiseModal, useGlobalPromiseOverlay, useModal, useOverlay, usePromiseDrawer, usePromiseModal, usePromiseOverlay };
+export { AntdOverlayProvider, type AntdOverlayProviderProps, type CustomDrawerProps, type CustomModalProps, type CustomOkValue, type CustomOverlayProps, type CustomTourProps, type DefaultDrawerProps, type DefaultModalProps, type DefaultTourProps, type InternalOverlayProps, type OverlayController, type OverlayOpener, type PromiseOverlayOpener, type UseDrawerOptions, type UseModalOptions, type UseOverlayOptions, type UsePromiseDrawerOptions, type UsePromiseModalOptions, type UsePromiseOverlayOptions, type UseTourOptions, generateUseDrawerHook, generateUseModalHook, generateUseOverlayHook, generateUsePromiseDrawerHook, generateUsePromiseModalHook, generateUsePromiseOverlayHook, generateUseTourHook, useAntdOverlayContext, useDrawer, useGlobalDrawer, useGlobalModal, useGlobalOverlay, useGlobalPromiseDrawer, useGlobalPromiseModal, useGlobalPromiseOverlay, useGlobalTour, useModal, useOverlay, usePromiseDrawer, usePromiseModal, usePromiseOverlay, useTour };

package/dist/index.js

@@ -6,7 +6,8 @@ var AntdOverlayContext = createContext(null);
 function AntdOverlayProvider({
   children,
   defaultModalProps,
-  defaultDrawerProps
+  defaultDrawerProps,
+  defaultTourProps
 }) {
   const [holders, setHolders] = useState([]);
   const addHolder = useCallback((holder) => {
@@ -16,8 +17,15 @@ function AntdOverlayProvider({
     setHolders((prev) => prev.filter((h) => h !== holder));
   }, []);
   const value = useMemo(
-    () => ({ holders, addHolder, removeHolder, defaultModalProps, defaultDrawerProps }),
-    [holders, addHolder, removeHolder, defaultModalProps, defaultDrawerProps]
+    () => ({
+      holders,
+      addHolder,
+      removeHolder,
+      defaultModalProps,
+      defaultDrawerProps,
+      defaultTourProps
+    }),
+    [holders, addHolder, removeHolder, defaultModalProps, defaultDrawerProps, defaultTourProps]
   );
   return /* @__PURE__ */ jsxs(AntdOverlayContext.Provider, { value, children: [
     children,
@@ -260,6 +268,56 @@ function generateUseDrawerHook(DrawerComponent) {
     useGlobalDrawer: (options) => useGlobalDrawer(DrawerComponent, options)
   };
 }
+var createTourPropsAdapter = (defaultProps) => {
+  return (props, state) => {
+    const result = {
+      ...defaultProps,
+      ...props,
+      open: state.open,
+      customClose: state.onClose,
+      onClose: (current) => {
+        props?.onClose?.(current);
+        state.onClose();
+      }
+    };
+    if (result.customOk) {
+      result.customOk = wrapCustomOk(result.customOk, state.onClose);
+    }
+    return result;
+  };
+};
+function useTour(TourComponent, options) {
+  const context = useAntdOverlayContext();
+  const propsAdapter = useMemo(
+    () => createTourPropsAdapter(context?.defaultTourProps),
+    [context?.defaultTourProps]
+  );
+  return useOverlay(TourComponent, {
+    animation: false,
+    ...options,
+    keyPrefix: "use-tour",
+    propsAdapter
+  });
+}
+function useGlobalTour(TourComponent, options) {
+  const context = useAntdOverlayContext();
+  const propsAdapter = useMemo(
+    () => createTourPropsAdapter(context?.defaultTourProps),
+    [context?.defaultTourProps]
+  );
+  return useGlobalOverlay(TourComponent, {
+    animation: false,
+    ...options,
+    keyPrefix: "use-tour",
+    propsAdapter
+  });
+}
+function generateUseTourHook(TourComponent) {
+  return {
+    useTour: (options) => useTour(TourComponent, options),
+    useGlobalTour: (options) => useGlobalTour(TourComponent, options)
+  };
+}
 var createSettler = (rawResolve, rawReject) => {
   let settled = false;
   return {
@@ -457,6 +515,6 @@ function generateUsePromiseDrawerHook(DrawerComponent) {
   };
 }
 
-export { AntdOverlayProvider, generateUseDrawerHook, generateUseModalHook, generateUseOverlayHook, generateUsePromiseDrawerHook, generateUsePromiseModalHook, generateUsePromiseOverlayHook, useAntdOverlayContext, useDrawer, useGlobalDrawer, useGlobalModal, useGlobalOverlay, useGlobalPromiseDrawer, useGlobalPromiseModal, useGlobalPromiseOverlay, useModal, useOverlay, usePromiseDrawer, usePromiseModal, usePromiseOverlay };
+export { AntdOverlayProvider, generateUseDrawerHook, generateUseModalHook, generateUseOverlayHook, generateUsePromiseDrawerHook, generateUsePromiseModalHook, generateUsePromiseOverlayHook, generateUseTourHook, useAntdOverlayContext, useDrawer, useGlobalDrawer, useGlobalModal, useGlobalOverlay, useGlobalPromiseDrawer, useGlobalPromiseModal, useGlobalPromiseOverlay, useGlobalTour, useModal, useOverlay, usePromiseDrawer, usePromiseModal, usePromiseOverlay, useTour };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map