Merge pull request #16 from Mini-ghost/next

feat(types): add typescript support for vue 3

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",

types/index.d.ts

@@ -0,0 +1,50 @@
+import {
+  App,
+  Ref,
+  SetupContext,
+  EmitsOptions,
+  ComponentPublicInstance
+} from 'vue'
+
+interface VueFinalModal {
+  install(app: App): void
+}
+
+interface VueFinalModalInfo {
+  uid: symbol
+  name: string
+  emit: SetupContext<EmitsOptions>
+  vfmContent: Ref<HTMLDivElement>
+  getAttachElement(): false | HTMLElement
+  modalStackIndex: Ref<number | null>
+  visibility: {
+    modal: boolean
+    overlay: boolean
+  }
+  handleLockScroll(): void
+  hideOverlay: boolean
+  focusTrap: boolean
+}
+
+export type VueFinalModalComponent = ComponentPublicInstance & {
+  vfmContainer: HTMLDivElement,
+  vfmContent: HTMLDivElement
+}
+
+export type VusFinalModalProperty = {
+  openedModals: VueFinalModalInfo[]
+  modals: VueFinalModalInfo[]
+  show(name: string): void
+  hide(name: string): void
+  hideAll(): void
+  toggle(name: string, show: boolean): void
+}
+
+declare module '@vue/runtime-core' {
+  interface ComponentCustomProperties {
+    readonly $vfm: VusFinalModalProperty
+  }
+}
+
+declare const VueFinalModal: VueFinalModal
+export default VueFinalModal