Blame view

types/iview/loading-bar.d.ts 1.22 KB
454cdd17   yangd   完成新版本3.0.0的iview全...
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
  // Type definitions for iview 3.0.0
  // Project: https://github.com/iview/iview
  // Definitions by: yangdan
  // Definitions: https://github.com/yangdan8/iview.git
  import Vue, { VNode } from "vue";
  
  export interface LoadingBarInstance {
    /**
     * 开始从 0 显示进度条,并自动加载进度
     */
    start(): void;
    /**
     * 结束进度条,自动补全剩余进度
     */
    finish(): void;
    /**
     * 以错误的类型结束进度条,自动补全剩余进度
     */
    error(): void;
    /**
     * 精确加载到指定的进度
     * @param percent 指定的进度百分比
     */
    update(percent?: number): void;
    /**
     * 全局配置
     * @param options 配置对象
     */
    config(options?: LoadingBarConfig): void;
    /**
     * 全局销毁
     */
    destroy(): void;
  }
  
  export interface LoadingBarConfig {
    /**
     * 进度条的颜色,默认为 iView 主色 
     * @default primary
     */
    color?: string;
    /**
     * 失败时的进度条颜色,默认为 iView 主色 
     * @default error
     */
    failedColor?: string;
    /**
     * 进度条高度,单位 px 
     * @default 2
     */
    height?: number;
  }
  
  declare module "vue/types/vue" {
    interface Vue {
      /**
       * 加载进度条
       */
      $Loading?: LoadingBarInstance;
    }
  }