TypeScript definitions (#458)

* Created 1st version of TypeScript definitions * Added reference to types file Co-authored-by: Julien Mariller <[email protected]>
mkoryak · May 23, 2020 · 72b5cdc · 72b5cdc
1 parent ec2519f
commit 72b5cdc
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/dist/jquery.floatThead.d.ts b/dist/jquery.floatThead.d.ts
@@ -0,0 +1,24 @@
+interface floatTheadOptions {
+    position?: string;
+    scrollContainer?: ($container: JQuery) => void | boolean;
+    responsiveContainer?: ($container: JQuery) => void;
+    ariaLabel: ($table: JQuery, $headerCell: JQuery, columnIndex: number) => void;
+    headerCellSelector?: string;
+    floatTableClass?: string;
+    floatContainerClass?: string;
+    top?: number;
+    bottom?: number;
+    zIndex?: number;
+    debug?: boolean;
+    getSizingRow?: () => void;
+    copyTableClass?: boolean;
+    autoReflow?: boolean;
+}
+
+interface JQuery {
+    floatThead(floatTheadOptions?: floatTheadOptions): void;
+    floatThead(action: string): void;
+    trigger(action: string): void;
+    on(events: string, handler: (event: Event, $floatContainer: JQuery) => void): void;
+    on(events: string, handler: (event: Event, isFloated: boolean, $floatContainer: JQuery) => void): void;
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -3,6 +3,7 @@
   "version": "2.1.4",
   "description": "fixed table header plugin that works",
   "main": "dist/jquery.floatThead.min.js",
+  "type": "dist/jquery.floatThead.d.ts",
   "scripts": {
     "build": "cp src/jquery.floatThead.js dist/jquery.floatThead.js && uglifyjs  dist/jquery.floatThead.js --compress --mangle  --comments  -o dist/jquery.floatThead.min.js"
   },
@@ -21,7 +22,7 @@
     "fixed table header",
     "table",
     "thead",
-    "the cat is cute",	
+    "the cat is cute",
     "floatThead",
     "scrolling table",
     "jQuery plugin"