message.d.ts
1.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
// Type definitions for iview 3.1.0
// Project: https://github.com/iview/iview
// Definitions by: yangdan
// Definitions: https://github.com/yangdan8/iview.git
import Vue, { VNode, CreateElement } from "vue";
export declare interface Message {
/**
* 消息
* @param config MessageConfig为相关配置,string为待显示的内容
*/
info(config?: MessageConfig | string): void;
/**
* 成功
* @param config MessageConfig为相关配置,string为待显示的内容
*/
success(config?: MessageConfig | string): void;
/**
* 警告
* @param config MessageConfig为相关配置,string为待显示的内容
*/
warning(config?: MessageConfig | string): void;
/**
* 错误
* @param config MessageConfig为相关配置,string为待显示的内容
*/
error(config?: MessageConfig | string): void;
/**
* 配置
* @param config MessageConfig为相关配置,string为待显示的内容
*/
loading(options?: MessageConfig | string): void;
/**
* 配置
* @param config MessageConfig为相关配置,string为待显示的内容
*/
config(options?: MessageConfig): void;
/**
* 销毁
*/
destroy(): void;
}
export declare interface MessageConfig {
/**
* 提示内容
*/
content?: string;
/**
* 自定义描述内容，使用 Vue 的 Render 函数
*/
render?: (h: CreateElement) => VNode;
/**
* 关闭时的回调
*/
onClose?: () => void;
/**
* 页面是否可以滚动
* @default false
*/
closable?: boolean;
/**
* 提示组件距离顶端的距离，单位像素
* @default 24
*/
top?: number;
/**
* 默认自动关闭的延时，单位秒
* @default 1.5
*/
duration?: number;
}
declare module 'vue/types/vue' {
interface Vue {
/**
* 全局提示
*/
$Message: Message;
}
}