Class DomQuery<T>

dom 的查询器

Type parameters

T: DomQuerySelector = DomQuerySelector

Hierarchy

DomQuery

Index

Constructors

constructor

new DomQuery<T>(selector: T): DomQuery<T>

Type parameters
- T: DomQuerySelector = DomQuerySelector
Parameters
- selector: T
Returns DomQuery<T>

Properties

elems

elems: HTMLElement[]

节点列表

selector

selector: T

选择器

Accessors

length

get length(): number

Returns number

Methods

addClass

addClass(className?: string | string[]): DomQuery<T>

添加 css 的 className

Parameters
- Optional className: string | string[]
  
  样式类名或列表
Returns DomQuery<T>

append

append(children: DomQuerySelector): DomQuery<T>

在末端插入子节点

Parameters
- children: DomQuerySelector
  
  子节点
Returns DomQuery<T>

attr

attr(key: string): null | string
attr(key: string, val: string): DomQuery<T>
attr(key: Record<string, string>): DomQuery<T>

设置 / 获取属性

Parameters
- key: string
  
  key
Returns null | string
Parameters
- key: string
- val: string
Returns DomQuery<T>
Parameters
- key: Record<string, string>
Returns DomQuery<T>

bindClickOutSide

bindClickOutSide(fn: () => unknown, context?: unknown): DomQuery<T>

绑定外部点击事件

Parameters
- fn: () => unknown
  
  回调函数
  - - (): unknown
    - Returns unknown
- Optional context: unknown
  
  this 上下文
Returns DomQuery<T>

children

children(): undefined | DomQuery<DomQuerySelector>

获取子元素

Returns undefined | DomQuery<DomQuerySelector>

childrens

childrens(): undefined | DomQuery<DomQuerySelector>

获取子元素列表

Returns undefined | DomQuery<DomQuerySelector>

clearClickOutSide

clearClickOutSide(): DomQuery<T>

取消所有外部点击事件

Returns DomQuery<T>

contains

contains($child: DomQuery<DomQuerySelector>): boolean

当前元素，是否包含某个子元素

Parameters
- $child: DomQuery<DomQuerySelector>
  
  子元素
Returns boolean

css

css(key: string, val: string | number): DomQuery<T>
css(key: Record<string, string | number>): DomQuery<T>

修改 css

Parameters
- key: string
  
  css key
- val: string | number
  
  css value
Returns DomQuery<T>
Parameters
- key: Record<string, string | number>
Returns DomQuery<T>

disableContextMenu

disableContextMenu(): DomQuery<T>

禁用节点的右键菜单栏

Returns DomQuery<T>

disableDrag

disableDrag(): DomQuery<T>

禁用节点的拖拽

Returns DomQuery<T>

disableSelect

disableSelect(): DomQuery<T>

禁用节点的选择

Returns DomQuery<T>

find

find(selector: string): DomQuery<DomQuerySelector>

根据选择器查询节点

Parameters
- selector: string
  
  选择器
Returns DomQuery<DomQuerySelector>

forEach

forEach(callback: (elem: HTMLElement, index?: number) => unknown): DomQuery<T>

遍历选择器中的元素，回调函数返回 false 时终止遍历

Parameters
- callback: (elem: HTMLElement, index?: number) => unknown
  
  回调函数
  - - (elem: HTMLElement, index?: number): unknown
    - Parameters
      - elem: HTMLElement
      - Optional index: number
      Returns unknown
Returns DomQuery<T>

getBoundingClientRect

getBoundingClientRect(): DOMRect

获取节点的 DOMRect

Returns DOMRect

hasClass

hasClass(className?: string): boolean

是否有传入的 css class

Parameters
- Optional className: string
  
  样式类名
Returns boolean

hide

hide(): DomQuery<T>

隐藏节点

Returns DomQuery<T>

html

html(): string
html(val: string | number): DomQuery<T>

设置 / 获取元素的 html

Returns string
Parameters
- val: string | number
Returns DomQuery<T>

insertAfter

insertAfter(target: DomQuerySelector): DomQuery<T>

在当前节点之后插入节点

Parameters
- target: DomQuerySelector
  
  节点
Returns DomQuery<T>

insertBefore

insertBefore(target: DomQuerySelector): DomQuery<T>

在当前元素之前插入节点

Parameters
- target: DomQuerySelector
  
  节点
Returns DomQuery<T>

off

off(event: string, callback?: any): DomQuery<T>

移除监听事件

Parameters
- event: string
  
  事件名称
- Optional callback: any
  
  回调事件，不传则为移除所有事件
Returns DomQuery<T>

on

on<K>(event: K, callback: EventCallback<K>, context?: unknown): DomQuery<T>

监听事件

Type parameters
- K: keyof HTMLElementEventMap
Parameters
- event: K
  
  事件名称
- callback: EventCallback<K>
  
  回调事件
- Optional context: unknown
  
  this 指向
Returns DomQuery<T>

outerHTML

outerHTML(): string

获取 dom 的 html 字符串

Returns string

parent

parent(): undefined | DomQuery<DomQuerySelector>

获取父元素

Returns undefined | DomQuery<DomQuerySelector>

prepend

prepend(children: DomQuerySelector): DomQuery<T>

在开头插入子元素

Parameters
- children: DomQuerySelector
  
  子节点
Returns DomQuery<T>

remove

remove(): DomQuery<T>

移除当前节点

Returns DomQuery<T>

removeAttr

removeAttr(key: string): DomQuery<T>

删除属性

Parameters
- key: string
  
  key
Returns DomQuery<T>

removeClass

removeClass(className?: string | string[]): DomQuery<T>

移除 css 的 className

Parameters
- Optional className: string | string[]
  
  样式类名或列表
Returns DomQuery<T>

replace

replace(target: DomQuerySelector): DomQuery<T>

将当前节点替换成新的节点

Parameters
- target: DomQuerySelector
  
  替换的内容
Returns DomQuery<T>

scrollLeft

scrollLeft(): number

获取节点的 scrollLeft

Returns number

scrollTop

scrollTop(): number

获取节点的 scrollTop

Returns number

show

show(style?: string): DomQuery<T>

显示节点

Parameters
- style: string = 'block'
  
  显示的样式
Returns DomQuery<T>

text

text(): string
text(val: string): DomQuery<T>

获取/设置元素 text

Returns string
Parameters
- val: string
Returns DomQuery<T>

triggerBlur

triggerBlur(): DomQuery<T>

触发失焦

Returns DomQuery<T>

triggerFocus

triggerFocus(): DomQuery<T>

触发聚焦

Returns DomQuery<T>

value

value(): string

Returns string