vue-popup-plus-plugin-preset 1.4.0 → 1.5.0

package/dist/vue-popup-plus-plugin-preset.d.ts

@@ -1,6 +1,8 @@
 import { Component } from 'vue';
+import { ExtractComponentPropTypes } from 'vue-popup-plus';
+import { Placement } from 'vue-popup-plus';
 import { PopupPlugin } from 'vue-popup-plus';
-import { version } from '../package.json';
+import { Version } from 'vue-popup-plus';
 
 export declare const album: PopupPlugin<GlobalOption>;
 
@@ -154,7 +156,7 @@ declare type ConfirmOption = {
 
 export declare const dialog: PopupPlugin<GlobalOption>;
 
-declare type DialogOption = {
+declare type DialogOption<TComponent extends Component = Component> = {
     /**
      * 对话框标题
      *
@@ -164,11 +166,11 @@ declare type DialogOption = {
     /**
      * 对话框内容组件
      */
-    component: Component;
+    component: TComponent;
     /**
      * 对话框内容组件props
      */
-    componentProps?: Record<string, any>;
+    componentProps?: ExtractComponentPropTypes<TComponent>;
     /**
      * 对话框渲染完成时调用的回调函数
      */
@@ -227,6 +229,13 @@ declare type DialogOption = {
      * - 支持 `string` 或 `number` 类型
      */
     minHeight?: string | number;
+    /**
+     * 对话框位置
+     *
+     * - 默认值为 `center`
+     * @since 1.5.0
+     */
+    placement?: Placement;
     /**
      * 是否显示对话框遮罩层
      *
@@ -262,10 +271,10 @@ declare type DialogOption = {
 declare type GlobalOption = {
     /**
      * 插件弹出层皮肤
-     * - 默认为 `classic` 经典皮肤
+     * - 默认为 `modern` 现代皮肤
      * - 可选值包括：
+     *   - `modern` 现代皮肤
      *   - `classic` 经典皮肤
-     *   - `modern` 现代皮肤（实验性）
      */
     skin?: Skin;
 };
@@ -341,29 +350,58 @@ export declare interface IDialog {
     /**
      * 显示对话框
      *
-     * - 对话框内部组件可通过调用 `this.$emit('close', payload)`
+     * - 对话框内部组件可通过调用 `dialog.close(payload)`
      *   关闭对话框，payload 为关闭时传递的参数
      * - 如需获取对话框关闭时传递的参数，可在调用 `dialog` 方法时使用 `await` 关键字等待
      *   Promise resolve 后获取
      * - 对话框关闭时，无论是否传递了参数，Promise 都将 resolve，因此需要在调用时判断是否有返回参数
      */
-    <T extends any = any>(options: DialogOption): Promise<T | void>;
+    <T extends any = any, TComponent extends Component = Component>(options: DialogOption<TComponent>): Promise<T | void>;
+    /**
+     * 关闭对话框
+     *
+     * - 将会关闭最后一个创建的对话框
+     * - 如果当前没有对话框正在显示，则不会有任何效果，调试模式下会抛出警告
+     * - 可传递任意类型的参数，该参数将会被传递给打开对话框时的 Promise resolve 函数
+     * @param payload 关闭时传递的参数
+     */
+    close<T extends any = any>(payload?: T): Promise<void>;
 }
 
 export declare interface ILoading {
     /**
      * 显示加载遮罩
      *
-     * - 返回关闭加载遮罩的方法，调用后关闭加载遮罩
+     * - 全局只会显示一个加载遮罩，每次调用时会先进行判断是否有已存在的加载遮罩
+     * 如果有，则会先关闭已存在的加载遮罩，再显示新的加载遮罩
+     *
+     * - 使用示例：
+     *
+     * ```ts
+     * // 显示加载遮罩
+     * popup.loading()
+     * // 关闭加载遮罩
+     * popup.loading.close()
+     *
+     * // 如果需要等待关闭动画结束，可通过 await 调用
+     * await popup.loading.close()
+     * ```
+     */
+    (option?: LoadingOption): void;
+    /**
+     * 关闭加载遮罩
+     *
      * - 使用示例：
      *
      * ```ts
-     * const stopLoading = popup.loading()
      * // 关闭加载遮罩
-     * stopLoading()
+     * popup.loading.close()
+     *
+     * // 如果需要等待关闭动画结束，可通过 await 调用
+     * await popup.loading.close()
      * ```
      */
-    (option?: LoadingOption): () => void;
+    close(): Promise<void>;
 }
 
 export declare interface IPrompt {
@@ -395,8 +433,10 @@ export declare interface IToast {
      * 显示消息
      *
      * - 第一个参数为消息内容
-     * - 第二个参数为消息选项，可自定义消息显示时间，默认值为 2000 毫秒
-     * - 如果需要等待消息消失后继续执行后续代码，需要通过 `await` 调用， 等待执行结束后继续执行后续代码
+     * - 第二个参数为消息选项，可自定义消息显示时间，默认值为 `2000` 毫秒
+     *   ，如果设置为 `0` ，则消息不会自动关闭
+     * - 如果需要等待消息消失后继续执行后续代码，需要通过 `await` 调用，
+     *   等待执行结束后继续执行后续代码
      * - 使用示例：
      *
      * ```ts
@@ -408,6 +448,22 @@ export declare interface IToast {
      * ```
      */
     (content: string, options?: ToastOption): Promise<void>;
+    /**
+     * 显示成功消息
+     */
+    success(content: string, options?: ToastOptionWithoutTheme): Promise<void>;
+    /**
+     * 显示信息消息
+     */
+    info(content: string, options?: ToastOptionWithoutTheme): Promise<void>;
+    /**
+     * 显示警告消息
+     */
+    warning(content: string, options?: ToastOptionWithoutTheme): Promise<void>;
+    /**
+     * 显示错误消息
+     */
+    danger(content: string, options?: ToastOptionWithoutTheme): Promise<void>;
 }
 
 export declare const loading: PopupPlugin<GlobalOption>;
@@ -424,6 +480,7 @@ declare type LoadingOption = {
      * 加载遮罩标题文本
      *
      * - 默认值：''
+     * @since 1.3.3
      */
     title?: string;
     /**
@@ -432,15 +489,23 @@ declare type LoadingOption = {
      * - 默认值：60
      */
     iconSize?: number;
+    /**
+     * 是否显示遮罩层
+     *
+     * - 默认值：`true`
+     * @since 1.5.0
+     */
+    mask?: boolean;
     /**
      * 遮罩层是否模糊
      *
      * - 默认值：`true`
+     * @since 1.3.3
      */
     maskBlur?: boolean;
 };
 
-export declare const presetPlugin: PopupPlugin<GlobalOption>;
+export declare const plugin: PopupPlugin<GlobalOption>;
 
 declare const prompt_2: PopupPlugin<GlobalOption>;
 export { prompt_2 as prompt }
@@ -521,7 +586,7 @@ declare type PromptType = 'input' | 'textarea';
 
 declare type Skin = 'classic' | 'modern';
 
-declare type Theme = 'default' | 'primary' | 'info' | 'success' | 'warning' | 'danger';
+declare type Theme = 'primary' | 'info' | 'success' | 'warning' | 'danger';
 
 export declare const toast: PopupPlugin<GlobalOption>;
 
@@ -539,9 +604,34 @@ declare type ToastOption = {
      * - 默认值： 2000 毫秒
      */
     duration?: number;
+    /**
+     * 消息位置
+     *
+     * - 默认值为 `center`
+     * @since 1.5.0
+     */
+    placement?: Placement;
+    /**
+     * 是否显示关闭按钮
+     *
+     * - 默认值： `false`
+     * - 当持续时间为 `0` 时，关闭按钮将会强制显示
+     * @since 1.5.0
+     */
+    showClose?: boolean;
+    /**
+     * 是否开启鼠标悬停持续显示
+     *
+     * - 默认值： `true`
+     * - 当持续时间为 `0` 时，该参数无效
+     * @since 1.5.0
+     */
+    hoverWait?: boolean;
 };
 
-export { version }
+declare type ToastOptionWithoutTheme = Omit<ToastOption, 'theme'>;
+
+export declare const version: Version;
 
 export { }
 
@@ -555,41 +645,41 @@ declare module 'vue-popup-plus' {
 
 declare module 'vue-popup-plus' {
     interface PopupCustomProperties {
-        dialog: IDialog;
+        alert: IAlert;
     }
 }
 
 
 declare module 'vue-popup-plus' {
     interface PopupCustomProperties {
-        alert: IAlert;
+        confirm: IConfirm;
     }
 }
 
 
 declare module 'vue-popup-plus' {
     interface PopupCustomProperties {
-        toast: IToast;
+        dialog: IDialog;
     }
 }
 
 
 declare module 'vue-popup-plus' {
     interface PopupCustomProperties {
-        loading: ILoading;
+        prompt: IPrompt;
     }
 }
 
 
 declare module 'vue-popup-plus' {
     interface PopupCustomProperties {
-        confirm: IConfirm;
+        loading: ILoading;
     }
 }
 
 
 declare module 'vue-popup-plus' {
     interface PopupCustomProperties {
-        prompt: IPrompt;
+        toast: IToast;
     }
 }