feat(keyboard): add types for config files (#115)

ionic-team · Dec 7, 2020 · 09bba16 · 09bba16
1 parent 3f90758
commit 09bba16
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/keyboard/package.json b/keyboard/package.json
@@ -45,6 +45,7 @@
   "devDependencies": {
     "@capacitor/android": "^3.0.0-alpha.7",
     "@capacitor/core": "^3.0.0-alpha.7",
+    "@capacitor/cli": "^3.0.0-alpha.7",
     "@capacitor/docgen": "^0.0.10",
     "@capacitor/ios": "^3.0.0-alpha.7",
     "@ionic/eslint-config": "^0.3.0",

diff --git a/keyboard/src/definitions.ts b/keyboard/src/definitions.ts
@@ -1,5 +1,32 @@
+/// <reference types="@capacitor/cli" />
+
 import type { PluginListenerHandle } from '@capacitor/core';
 
+declare module '@capacitor/cli' {
+  export interface PluginsConfig {
+    Keyboard?: {
+      /**
+       * Configure the way the app is resized when the Keyboard appears.
+       *
+       * Only available on iOS.
+       *
+       * @since 1.0.0
+       * @default native
+       */
+      resize?: 'none' | 'native' | 'body' | 'ionic';
+
+      /**
+       * Use the dark style keyboard instead of the regular one.
+       *
+       * Only available on iOS.
+       *
+       * @since 1.0.0
+       */
+      style?: 'dark';
+    };
+  }
+}
+
 export interface KeyboardInfo {
   /**
    * Height of the heyboard.