1 | import { IonicNativePlugin } from '@ionic-native/core';
|
2 | import { Observable } from 'rxjs';
|
3 | export declare enum KeyboardStyle {
|
4 | Light = "light",
|
5 | Dark = "dark"
|
6 | }
|
7 | export declare enum KeyboardResizeMode {
|
8 | Native = "native",
|
9 | Ionic = "ionic",
|
10 | Body = "body",
|
11 | None = "none"
|
12 | }
|
13 | /**
|
14 | * @name Keyboard
|
15 | * @premier keyboard
|
16 | * @capacitorincompatible true
|
17 | * @description
|
18 | * Keyboard plugin for Cordova.
|
19 | *
|
20 | * Requires Cordova plugin: `cordova-plugin-ionic-keyboard`. For more info, please see the [Keyboard plugin docs](https://github.com/ionic-team/cordova-plugin-ionic-keyboard).
|
21 | *
|
22 | * @usage
|
23 | * ```typescript
|
24 | * import { Keyboard } from '@ionic-native/keyboard/ngx';
|
25 | *
|
26 | * constructor(private keyboard: Keyboard) { }
|
27 | *
|
28 | * ...
|
29 | *
|
30 | * this.keyboard.show();
|
31 | *
|
32 | * this.keyboard.hide();
|
33 | *
|
34 | * ```
|
35 | */
|
36 | export declare class KeyboardOriginal extends IonicNativePlugin {
|
37 | /**
|
38 | * Check keyboard status visible or not.
|
39 | * @returns {boolean}
|
40 | */
|
41 | isVisible: boolean;
|
42 | /**
|
43 | * Hide the keyboard accessory bar with the next, previous and done buttons.
|
44 | * @param hide {boolean}
|
45 | */
|
46 | hideFormAccessoryBar(hide: boolean): void;
|
47 | /**
|
48 | * Hide the keyboard if shown.
|
49 | */
|
50 | hide(): void;
|
51 | /**
|
52 | * Force keyboard to be shown.
|
53 | */
|
54 | show(): void;
|
55 | /**
|
56 | * Programatically set the resize mode
|
57 | * @param mode {string}
|
58 | */
|
59 | setResizeMode(mode: KeyboardResizeMode): void;
|
60 | /**
|
61 | * Programatically set Keyboard style
|
62 | * @param mode {string}
|
63 | */
|
64 | setKeyboardStyle(style: KeyboardStyle): void;
|
65 | /**
|
66 | * Programatically enable or disable the WebView scroll
|
67 | * @param mode {string}
|
68 | */
|
69 | disableScroll(disable: boolean): void;
|
70 | /**
|
71 | * Creates an observable that notifies you when the keyboard is shown. Unsubscribe to observable to cancel event watch.
|
72 | * @returns {Observable<any>}
|
73 | */
|
74 | onKeyboardShow(): Observable<any>;
|
75 | /**
|
76 | * Creates an observable that notifies you when the keyboard will show. Unsubscribe to observable to cancel event watch.
|
77 | * @returns {Observable<any>}
|
78 | */
|
79 | onKeyboardWillShow(): Observable<any>;
|
80 | /**
|
81 | * Creates an observable that notifies you when the keyboard did show. Unsubscribe to observable to cancel event watch.
|
82 | * @returns {Observable<any>}
|
83 | */
|
84 | onKeyboardDidShow(): Observable<any>;
|
85 | /**
|
86 | * Creates an observable that notifies you when the keyboard is hidden. Unsubscribe to observable to cancel event watch.
|
87 | * @returns {Observable<any>}
|
88 | */
|
89 | onKeyboardHide(): Observable<any>;
|
90 | /**
|
91 | * Creates an observable that notifies you when the keyboard will hide. Unsubscribe to observable to cancel event watch.
|
92 | * @returns {Observable<any>}
|
93 | */
|
94 | onKeyboardWillHide(): Observable<any>;
|
95 | /**
|
96 | * Creates an observable that notifies you when the keyboard did hide. Unsubscribe to observable to cancel event watch.
|
97 | * @returns {Observable<any>}
|
98 | */
|
99 | onKeyboardDidHide(): Observable<any>;
|
100 | }
|
101 |
|
102 | export declare const Keyboard: KeyboardOriginal; |
\ | No newline at end of file |