@qy_better_lib/core 0.2.6 → 0.2.7

package/lib/utils/dom.d.ts

@@ -1,10 +1,18 @@
+/**
+ * 可能为null或undefined的Element
+ */
+type MaybeElement = Element | null | undefined;
+/**
+ * 可能为null或undefined的EventTarget（包括Element、Window、Document）
+ */
+type MaybeEventTarget = (Element | Window | Document) | null | undefined;
 /**
  * 根据类名获取父元素
  * @param dom DOM元素
  * @param class_name CSS类名
  * @returns DOM元素或null
  */
-export declare function get_parent_by_class(dom: Element | null, class_name: string): Element | null;
+export declare function get_parent_by_class(dom: MaybeElement, class_name: string): MaybeElement;
 /**
  * 滚动到底部
  * @param dom_id 元素ID
@@ -17,7 +25,7 @@ export declare function scroll_footer(dom_id: string, behavior?: boolean): void;
  * @param context 上下文元素，默认为document
  * @returns DOM元素或null
  */
-export declare function get_element(selector: string, context?: Element | Document): Element | null;
+export declare function get_element(selector: string, context?: Element | Document): MaybeElement;
 /**
  * 根据选择器获取多个元素
  * @param selector 选择器
@@ -30,67 +38,67 @@ export declare function get_elements(selector: string, context?: Element | Docum
  * @param element DOM元素
  * @param class_name 类名
  */
-export declare function add_class(element: Element | null, class_name: string): void;
+export declare function add_class(element: MaybeElement, class_name: string): void;
 /**
  * 移除类名
  * @param element DOM元素
  * @param class_name 类名
  */
-export declare function remove_class(element: Element | null, class_name: string): void;
+export declare function remove_class(element: MaybeElement, class_name: string): void;
 /**
  * 切换类名
  * @param element DOM元素
  * @param class_name 类名
  * @returns 是否添加了类名
  */
-export declare function toggle_class(element: Element | null, class_name: string): boolean;
+export declare function toggle_class(element: MaybeElement, class_name: string): boolean;
 /**
  * 检查是否包含类名
  * @param element DOM元素
  * @param class_name 类名
  * @returns 是否包含类名
  */
-export declare function has_class(element: Element | null, class_name: string): boolean;
+export declare function has_class(element: MaybeElement, class_name: string): boolean;
 /**
  * 获取元素样式
  * @param element DOM元素
  * @param property CSS属性名
  * @returns CSS属性值
  */
-export declare function get_style(element: Element | null, property: string): string;
+export declare function get_style(element: MaybeElement, property: string): string;
 /**
  * 设置元素样式
  * @param element DOM元素
  * @param property CSS属性名
  * @param value CSS属性值
  */
-export declare function set_style(element: Element | null, property: string, value: string): void;
+export declare function set_style(element: MaybeElement, property: string, value: string): void;
 /**
  * 设置元素多个样式
  * @param element DOM元素
  * @param styles 样式对象
  */
-export declare function set_styles(element: Element | null, styles: Record<string, string>): void;
+export declare function set_styles(element: MaybeElement, styles: Record<string, string>): void;
 /**
  * 获取元素属性
  * @param element DOM元素
  * @param attribute 属性名
  * @returns 属性值
  */
-export declare function get_attribute(element: Element | null, attribute: string): string;
+export declare function get_attribute(element: MaybeElement, attribute: string): string;
 /**
  * 设置元素属性
  * @param element DOM元素
  * @param attribute 属性名
  * @param value 属性值
  */
-export declare function set_attribute(element: Element | null, attribute: string, value: string): void;
+export declare function set_attribute(element: MaybeElement, attribute: string, value: string): void;
 /**
  * 移除元素属性
  * @param element DOM元素
  * @param attribute 属性名
  */
-export declare function remove_attribute(element: Element | null, attribute: string): void;
+export declare function remove_attribute(element: MaybeElement, attribute: string): void;
 /**
  * 绑定事件
  * @param element DOM元素
@@ -98,7 +106,7 @@ export declare function remove_attribute(element: Element | null, attribute: str
  * @param handler 事件处理函数
  * @param options 事件选项
  */
-export declare function on(element: Element | Window | Document | null, event: string, handler: EventListener, options?: AddEventListenerOptions): void;
+export declare function on(element: MaybeEventTarget, event: string, handler: EventListener, options?: AddEventListenerOptions): void;
 /**
  * 解绑事件
  * @param element DOM元素
@@ -106,7 +114,7 @@ export declare function on(element: Element | Window | Document | null, event: s
  * @param handler 事件处理函数
  * @param options 事件选项
  */
-export declare function off(element: Element | Window | Document | null, event: string, handler: EventListener, options?: EventListenerOptions): void;
+export declare function off(element: MaybeEventTarget, event: string, handler: EventListener, options?: EventListenerOptions): void;
 /**
  * 创建元素
  * @param tag_name 标签名
@@ -124,13 +132,13 @@ export declare function create_element(tag_name: string, options?: {
  * @param element DOM元素
  * @returns 元素位置和尺寸信息
  */
-export declare function get_element_rect(element: Element | null): DOMRect | null;
+export declare function get_element_rect(element: MaybeElement): DOMRect | null;
 /**
  * 获取元素相对于文档的位置
  * @param element DOM元素
  * @returns 元素位置信息
  */
-export declare function get_element_position(element: Element | null): {
+export declare function get_element_position(element: MaybeElement): {
     top: number;
     left: number;
 } | null;
@@ -139,7 +147,7 @@ export declare function get_element_position(element: Element | null): {
  * @param element DOM元素
  * @returns 元素尺寸信息
  */
-export declare function get_element_size(element: Element | null): {
+export declare function get_element_size(element: MaybeElement): {
     width: number;
     height: number;
 } | null;
@@ -148,7 +156,7 @@ export declare function get_element_size(element: Element | null): {
  * @param element DOM元素
  * @param options 滚动选项
  */
-export declare function scroll_to_element(element: Element | null, options?: {
+export declare function scroll_to_element(element: MaybeElement, options?: {
     behavior?: 'smooth' | 'auto';
     offsetTop?: number;
     offsetLeft?: number;
@@ -158,13 +166,13 @@ export declare function scroll_to_element(element: Element | null, options?: {
  * @param element DOM元素
  * @returns 是否在视口中
  */
-export declare function is_in_viewport(element: Element | null): boolean;
+export declare function is_in_viewport(element: MaybeElement): boolean;
 /**
  * 检查元素是否完全在视口中
  * @param element DOM元素
  * @returns 是否完全在视口中
  */
-export declare function is_completely_in_viewport(element: Element | null): boolean;
+export declare function is_completely_in_viewport(element: MaybeElement): boolean;
 /**
  * 获取窗口尺寸
  * @returns 窗口尺寸信息
@@ -188,3 +196,4 @@ export declare function get_document_size(): {
  * @returns 自适应后的尺寸
  */
 export declare function auto_size(size: number, deflate_width?: number): number;
+export {};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@qy_better_lib/core",
   "type": "module",
   "private": false,
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "qy better lib core",
   "author": "luhuiming",
   "license": "MIT",