Merge pull request #15 from Mini-ghost/master

feat(types): add typescript support

Author: hunterliu1003

.eslintignore

@@ -1 +1,2 @@
-dist
+dist
+types/**/*.d.ts

package.json

@@ -8,9 +8,11 @@
   "jsnext:main": "dist/VueFinalModal.esm.js",
   "unpkg": "dist/VueFinalModal.umd.js",
   "jsdelivr": "dist/VueFinalModal.umd.js",
+  "types": "types/index.d.ts",
   "files": [
     "lib",
-    "dist"
+    "dist",
+    "types/index.d.ts"
   ],
   "scripts": {
     "build": "rollup -c --environment BUILD:production",

types/index.d.ts

@@ -0,0 +1,25 @@
+import Vue, { PluginFunction } from 'vue'
+
+export class VueFinalModalComponant extends Vue {
+  $refs: {
+    vfmContainer: HTMLDivElement,
+    vfmContent: HTMLDivElement
+  }
+}
+
+declare module 'vue/types/vue' {
+  interface Vue {
+    readonly $vfm: {
+      readonly openedModals: VueFinalModalComponant[]
+      readonly modals: VueFinalModalComponant[]
+      show(name: string): void
+      hide(name: string): void
+      hideAll(): void
+      toggle(name: string, show: boolean): void
+    }
+  }
+}
+
+export default class VueFinalModal {
+  static install(vue: typeof Vue): PluginFunction<never>
+}