@whitesev/domutils 1.2.0 → 1.3.1

package/dist/types/src/DOMUtils.d.ts

@@ -1,8 +1,8 @@
-import type { DOMUtilsCoreOption } from "./DOMUtilsCore";
 import { type DOMUtilsCreateElementAttributesMap, DOMUtilsEvent } from "./DOMUtilsEvent";
 import { ParseHTMLReturnType } from "./types/global";
+import { type UtilsWindowApiOption } from "./WindowApi";
 declare class DOMUtils extends DOMUtilsEvent {
-    constructor(option?: DOMUtilsCoreOption);
+    constructor(option?: UtilsWindowApiOption);
     /** 版本号 */
     version: string;
     /**
@@ -589,7 +589,7 @@ declare class DOMUtils extends DOMUtilsEvent {
      * @param option
      * @returns
      */
-    createDOMUtils(option?: DOMUtilsCoreOption): DOMUtils;
+    createDOMUtils(option?: UtilsWindowApiOption): DOMUtils;
     /**
      * 获取文字的位置信息
      * @param $input 输入框

package/dist/types/src/DOMUtilsCommonUtils.d.ts

@@ -1,5 +1,7 @@
+import { UtilsWindowApiOption } from "./WindowApi";
 /** 通用工具类 */
 declare const DOMUtilsCommonUtils: {
+    windowApi: UtilsWindowApiOption;
     /**
      * 判断元素是否已显示或已连接
      * @param element

package/dist/types/src/DOMUtilsEvent.d.ts

@@ -1,3 +1,4 @@
+import { UtilsWindowApiOption } from "./WindowApi";
 export type DOMUtilsEventObject<T extends Node> = Event & {
     target: T;
 };
@@ -199,7 +200,9 @@ export declare interface DOMUtilsEventListenerOptionsAttribute {
     selector?: string;
 }
 export declare type DOMUtilsElementEventType = HTMLElement | string | NodeList | (HTMLElement | Window | Document | Element | typeof globalThis)[] | Window | Document | Element | null | typeof globalThis | ShadowRoot | EventTarget | ChildNode | Node;
-declare class DOMUtilsEvent {
+export declare class DOMUtilsEvent {
+    windowApi: UtilsWindowApiOption;
+    constructor(windowApiOption?: UtilsWindowApiOption);
     /**
      * 绑定事件
      * @param element 需要绑定的元素|元素数组|window
@@ -505,5 +508,70 @@ declare class DOMUtilsEvent {
      * })
      */
     keypress(target: HTMLElement | Window | typeof globalThis | string, handler: (event: DOMUtils_Event["keypress"]) => void, option?: boolean | AddEventListenerOptions): void;
+    /**
+     * 监听某个元素键盘按键事件或window全局按键事件
+     * 按下有值的键时触发，按下Ctrl\Alt\Shift\Meta是无值键。按下先触发keydown事件，再触发keypress事件。
+     * @param target 需要监听的对象，可以是全局Window或者某个元素
+     * @param eventName 事件名，默认keypress
+     * @param callback 自己定义的回调事件，参数1为当前的key，参数2为组合按键，数组类型，包含ctrl、shift、alt和meta（win键或mac的cmd键）
+     * @param options 监听事件的配置
+     * @example
+        Utils.listenKeyboard(window,(keyName,keyValue,otherKey,event)=>{
+            if(keyName === "Enter"){
+                console.log("回车按键的值是："+keyValue)
+            }
+            if(otherKey.indexOf("ctrl") && keyName === "Enter" ){
+                console.log("Ctrl和回车键");
+          }
+        })
+     * @example
+    字母和数字键的键码值(keyCode)
+      按键	键码	按键	键码	按键	键码	按键	键码
+      A	65	J	74	S	83	1	49
+      B	66	K	75	T	84	2	50
+      C	67	L	76	U	85	3	51
+      D	68	M	77	V	86	4	52
+      E	69	N	78	W	87	5	53
+      F	70	O	79	X	88	6	54
+      G	71	P	80	Y	89	7	55
+      H	72	Q	81	Z	90	8	56
+      I	73	R	82	0	48	9	57
+  
+      数字键盘上的键的键码值(keyCode)
+      功能键键码值(keyCode)
+      按键	键码	按键  	键码	按键	键码	按键	键码
+      0	96	8	104	F1	112	F7	118
+      1	97	9	105	F2	113	F8	119
+      2	98	*	106	F3	114	F9	120
+      3	99	+	107	F4	115	F10	121
+      4	100	Enter	108	F5	116	F11	122
+      5	101	-	109	F6	117	F12	123
+      6	102	.	110
+      7	103	/	111
+      
+      控制键键码值(keyCode)
+      按键		键码	按键		键码	按键		键码	按键		键码
+      BackSpace	8	Esc		27	→		39	-_		189
+      Tab		9	Spacebar	32	↓		40	.>		190
+      Clear		12	Page Up		33	Insert		45	/?		191
+      Enter		13	Page Down	34	Delete		46	`~		192
+      Shift		16	End		35	Num Lock	144	[{		219
+      Control		17	Home		36	;:		186	\|		220
+      Alt		18	←		37	=+		187	]}		221
+      Cape Lock	20	↑		38	,<		188	'"		222
+  
+      多媒体键码值(keyCode)
+      按键		键码
+      音量加		175
+      音量减		174
+      停止		179
+      静音		173
+      浏览器		172
+      邮件		180
+      搜索		170
+      收藏		171
+     **/
+    listenKeyboard(target: Window | Node | HTMLElement | typeof globalThis, eventName: ("keyup" | "keypress" | "keydown") | undefined, callback: (keyName: string, keyValue: string, otherCodeList: string[], event: KeyboardEvent) => void, options?: AddEventListenerOptions | boolean): {
+        removeListen(): void;
+    };
 }
-export { DOMUtilsEvent };

package/dist/types/src/WindowApi.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 配置类型
+ */
+export type UtilsWindowApiOption = {
+    document: Document;
+    window: Window & typeof globalThis;
+    globalThis: typeof globalThis | Window;
+    self: Window & typeof globalThis;
+    top: Window;
+};
+export declare class WindowApi {
+    /** 默认的配置 */
+    private defaultApi;
+    /** 使用的配置 */
+    private api;
+    constructor(option?: UtilsWindowApiOption);
+    get document(): Document;
+    get window(): Window & typeof globalThis;
+    get globalThis(): typeof globalThis | Window;
+    get self(): Window & typeof globalThis;
+    get top(): Window;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whitesev/domutils",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "使用js重新对jQuery的部分函数进行了仿写",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",