index.d.ts
2.57 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
85
86
87
88
89
90
91
92
93
94
95
// --- Modals ---
import Vue, { VNode } from 'vue'
import { BvPlugin, BvComponent, BvEvent } from '../../'
// Modal plugin
export declare const ModalPlugin: BvPlugin
// Component: <b-modal>
export declare class BModal extends BvComponent {
// Public methods
show: () => void
hide: (trigger?: string) => void
}
// --- Types ---
export type BvMsgBoxData = boolean | null | BvModalEvent | any
// --- Interfaces ---
export interface BvModalEvent extends BvEvent {
readonly trigger: string | null
// Future
// details: any | null
}
export interface BvMsgBoxOptions {
title?: string | VNode | Array<VNode>
titleTag?: string
size?: string
centered?: boolean
scrollable?: boolean
noFade?: boolean
noCloseOnBackdrop?: boolean
noCloseOnEsc?: boolean
headerBgVariant?: string
headerBorderVariant?: string
headerTextVariant?: string
headerCloseVariant?: string
headerClass?: string | string[] | Array<any>
bodyBgVariant?: string
bodyBorderVariant?: string
bodyTextVariant?: string
bodyClass?: string | string[] | Array<any>
footerBgVariant?: string
footerBorderVariant?: string
footerTextVariant?: string
footerClass?: string | string[] | Array<any>
headerCloseLabel?: string
buttonSize?: string
cancelTitle?: string
cancelVariant?: string
okTitle?: string
okVariant?: string
// Catch all
[key: string]: any
}
export interface BvModalMsgBoxResolver {
(event: BvModalEvent): any
}
export interface BvModalMsgBoxShortcutMethod {
(message: string | Array<VNode>, options?: BvMsgBoxOptions): Promise<BvMsgBoxData>
// Future
// (options?: BvMsgBoxOptions): Promise<BvMsgBoxData>
// (message: string | Array<VNode>, title: string | Array<VNode>, options?: BvMsgBoxOptions): Promise<BvMsgBoxData>
}
// Not yet documented or implemented (Future)
// export interface BvModalMsgBoxMethod {
// (options: BvMsgBoxOptions, resolver: BvModalMsgBoxResolver): Promise<BvMsgBoxData>
// (message: string | Array<VNode>, options: BvMsgBoxOptions, resolver: BvModalMsgBoxResolver): Promise<BvMsgBoxData>
// (message: string | Array<VNode>, title: string | Array<VNode>, options: BvMsgBoxOptions, resolver: BvModalMsgBoxResolver): Promise<BvMsgBoxData>
// }
export interface BvModal {
// Show OK MsgBox
msgBoxOk: BvModalMsgBoxShortcutMethod
// Show Confirm MsgBox
msgBoxConfirm: BvModalMsgBoxShortcutMethod
// Show a modal by id
show: (id: string) => void
// Hide a modal by id
hide: (id: string) => void
}
// --- Vue prototype injections ---
declare module 'vue/types/vue' {
interface Vue {
// Modal injection
readonly $bvModal: BvModal
}
}