1 | import BaseComponent, { GetInstanceFactory, GetOrCreateInstanceFactory } from './base-component';
|
2 |
|
3 | declare class Offcanvas extends BaseComponent {
|
4 | |
5 |
|
6 |
|
7 | static getInstance: GetInstanceFactory<Offcanvas>;
|
8 |
|
9 | |
10 |
|
11 |
|
12 |
|
13 | static getOrCreateInstance: GetOrCreateInstanceFactory<Offcanvas, Partial<Offcanvas.Options>>;
|
14 |
|
15 | static jQueryInterface: Offcanvas.jQueryInterface;
|
16 |
|
17 | constructor(element: string | Element, options?: Partial<Offcanvas.Options>);
|
18 |
|
19 | /**
|
20 | * Toggles an offcanvas element to shown or hidden. Returns to the caller before the offcanvas element has actually
|
21 | * been shown or hidden (i.e. before the shown.bs.offcanvas or hidden.bs.offcanvas event occurs).
|
22 | */
|
23 | toggle(relatedTarget?: HTMLElement): void;
|
24 |
|
25 | /**
|
26 | * Shows an offcanvas element. Returns to the caller before the offcanvas element has actually been shown
|
27 | * (i.e. before the shown.bs.offcanvas event occurs).
|
28 | */
|
29 | show(relatedTarget?: HTMLElement): void;
|
30 |
|
31 | /**
|
32 | * Hides an offcanvas element. Returns to the caller before the offcanvas element has actually been hidden
|
33 | * (i.e. before the hidden.bs.offcanvas event occurs).
|
34 | */
|
35 | hide(): void;
|
36 | }
|
37 |
|
38 | declare namespace Offcanvas {
|
39 | interface Options {
|
40 | |
41 |
|
42 |
|
43 |
|
44 |
|
45 | backdrop: boolean;
|
46 |
|
47 | |
48 |
|
49 |
|
50 |
|
51 |
|
52 | keyboard: boolean;
|
53 |
|
54 | |
55 |
|
56 |
|
57 |
|
58 |
|
59 | scroll: boolean;
|
60 | }
|
61 |
|
62 | enum Events {
|
63 | |
64 |
|
65 |
|
66 | show = 'show.bs.offcanvas',
|
67 |
|
68 | |
69 |
|
70 |
|
71 | shown = 'shown.bs.offcanvas',
|
72 |
|
73 | |
74 |
|
75 |
|
76 | hide = 'hide.bs.offcanvas',
|
77 |
|
78 | |
79 |
|
80 |
|
81 | hidden = 'hidden.bs.offcanvas',
|
82 | }
|
83 |
|
84 | type jQueryInterface = (config?: 'toggle' | 'show' | 'hide') => void;
|
85 | }
|
86 |
|
87 | export default Offcanvas;
|