-
参考jQuery的API设计
-
支持链式调用
-
只兼容高版本浏览器
-
未经完整测试
Kind: global class
- hQuery
- new hQuery(selector, [context])
- instance
- .find(selector) ⇒
hQuery - .first() ⇒
hQuery - .last() ⇒
hQuery - .eq(num) ⇒
hQuery - .parent() ⇒
hQuery - .children([num]) ⇒
hQuery - .next() ⇒
hQuery - .prev() ⇒
hQuery - .slice(start, end) ⇒
hQuery - .filter(fn) ⇒
hQuery - .end() ⇒
hQuery - .html([html]) ⇒
string|hQuery - .text([text]) ⇒
string|hQuery - .val([value]) ⇒
string|hQuery - .attr(attr, [value]) ⇒
string|hQuery - .append(html) ⇒
hQuery - .prepend(html) ⇒
hQuery - .remove() ⇒
hQuery - .replaceWith(html) ⇒
hQuery - .hide() ⇒
hQuery - .show() ⇒
hQuery - .toggle() ⇒
hQuery - .css(attr, [value]) ⇒
string|hQuery - .hasClass(className) ⇒
boolean - .addClass(className) ⇒
hQuery - .removeClass(className) ⇒
hQuery - .toggleClass(className, [force]) ⇒
hQuery - .on(event, handler) ⇒
hQuery - .off(event, handler) ⇒
hQuery - .one(event, handler) ⇒
hQuery - .each(fn) ⇒
hQuery
- .find(selector) ⇒
- static
hQuery构造函数,可以直接h()调用
Returns: hQuery - - hQuery对象
| Param | Type | Default | Description |
|---|---|---|---|
| selector | String | DOM |
querySelectAll的选择器 | |
| [context] | DOM |
document |
选择器的根节点 |
hQuery.find(selector) ⇒ hQuery
以当前对象的第一个节点为根节点,返回符合选择器的子节点
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuey对象
| Param | Type | Description |
|---|---|---|
| selector | string |
选择器 |
hQuery.first() ⇒ hQuery
返回hQuery对象中的第一个节点
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuey对象
hQuery.last() ⇒ hQuery
返回hQuery对象中的最后一个节点
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuery对象
hQuery.eq(num) ⇒ hQuery
返回hQuery对象中的第n个节点
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuery对象
| Param | Type | Description |
|---|---|---|
| num | number |
从0开始指定第num个节点,可接受负数 |
hQuery.parent() ⇒ hQuery
返回hQuery对象中每一个节点的父节点集合
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuery对象
hQuery.children([num]) ⇒ hQuery
返回hQuery对象中第一个节点的直接子节点
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuery对象
| Param | Type | Description |
|---|---|---|
| [num] | number |
指定第几个子节点 |
hQuery.next() ⇒ hQuery
返回hQuery对象中所有节点的下一个兄弟节点的集合
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuery对象
hQuery.prev() ⇒ hQuery
返回hQuery对象中所有节点的上一个兄弟节点的集合
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuery对象
hQuery.slice(start, end) ⇒ hQuery
返回[start, end)的节点集合
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuery对象
| Param | Type | Description |
|---|---|---|
| start | number |
起点 |
| end | number |
终点 |
hQuery.filter(fn) ⇒ hQuery
返回满足筛选函数的节点
Kind: instance method of hQuery
Returns: hQuery - - 全新的hQuery对象
| Param | Type | Description |
|---|---|---|
| fn | function |
用作筛选的函数,应返回boolean值 |
hQuery.end() ⇒ hQuery
回溯到链上的上一个hQuery对象
Kind: instance method of hQuery
Returns: hQuery - 全新的hQuery对象
Example
h('#id').find('.class').end() // 会被回溯到h('#id')hQuery.html([html]) ⇒ string | hQuery
返回或者设置节点的html
Kind: instance method of hQuery
Returns: string | hQuery - - 返回html内容或者自身
| Param | Type | Description |
|---|---|---|
| [html] | string |
要设置的html |
hQuery.text([text]) ⇒ string | hQuery
返回或者设置节点的text
Kind: instance method of hQuery
Returns: string | hQuery - - 返回text内容或者自身
| Param | Type | Description |
|---|---|---|
| [text] | string |
将要设置的text值 |
hQuery.val([value]) ⇒ string | hQuery
返回或者设置节点的value
Kind: instance method of hQuery
Returns: string | hQuery - - 返回value内容或者自身
| Param | Type | Description |
|---|---|---|
| [value] | string |
要设置的value |
hQuery.attr(attr, [value]) ⇒ string | hQuery
返回或者设置节点的属性
Kind: instance method of hQuery
Returns: string | hQuery - - 返回属性值或者自身
| Param | Type | Description |
|---|---|---|
| attr | string | object |
想取得或者将要设置的attr值,可传入{ attr: value }的对象 |
| [value] | string |
要设置的attr值 |
hQuery.append(html) ⇒ hQuery
在节点的子节点末尾添加html
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| html | string | DOM |
要添加的html或者节点,DOM可传入多个 |
hQuery.prepend(html) ⇒ hQuery
在节点的子节点开头添加html
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| html | string | DOM |
要添加的html或者节点,DOM可传入多个 |
hQuery.remove() ⇒ hQuery
删除所有节点
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
hQuery.replaceWith(html) ⇒ hQuery
替代当前节点
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| html | string | DOM |
用以替换的html或者DOM,DOM可传入多个 |
hQuery.hide() ⇒ hQuery
隐藏节点
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
hQuery.show() ⇒ hQuery
显示节点
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
hQuery.toggle() ⇒ hQuery
切换隐藏和显示的状态
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
hQuery.css(attr, [value]) ⇒ string | hQuery
返回或者设置节点的css
Kind: instance method of hQuery
Returns: string | hQuery - - 返回属性值或者自身
| Param | Type | Description |
|---|---|---|
| attr | string | object |
取得或者将要设置的css值,可传入{ attr: value }的对象 |
| [value] | string |
要设置的css值 |
检测节点是否有该class
Kind: instance method of hQuery
| Param | Type | Description |
|---|---|---|
| className | string |
检测的类名 |
hQuery.addClass(className) ⇒ hQuery
为节点添加class
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| className | string |
增加的类名 |
hQuery.removeClass(className) ⇒ hQuery
为节点去除class
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| className | string |
去除的类名 |
hQuery.toggleClass(className, [force]) ⇒ hQuery
切换class
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| className | string |
切换的类名 |
| [force] | boolen |
可选切换方式,true表示增加,false表示去除 |
hQuery.on(event, handler) ⇒ hQuery
增加绑定事件
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| event | string |
事件名 |
| handler | function |
回调函数,记得处理this绑定 |
hQuery.off(event, handler) ⇒ hQuery
去除绑定事件
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| event | string |
事件名 |
| handler | function |
回调函数 |
hQuery.one(event, handler) ⇒ hQuery
增加绑定事件,该事件在触发一次后会被移除
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| event | string |
事件名 |
| handler | function |
回调函数,记得处理this绑定 |
hQuery.each(fn) ⇒ hQuery
对每一个节点调用处理函数
Kind: instance method of hQuery
Returns: hQuery - - 返回自身
| Param | Type | Description |
|---|---|---|
| fn | function |
处理函数,如果返回false会中断后续执行 |
在hQuery的原型链上扩展新的方法
Kind: static method of hQuery
| Param | Type | Description |
|---|---|---|
| name | name |
新增的方法名 |
| fn | function |
新增的方法 |
Ajax的GET方法
Kind: static method of hQuery
| Param | Type | Description |
|---|---|---|
| url | string |
请求资源的地址 |
| callback | function |
回调函数 |
Ajax的POST方法
Kind: static method of hQuery
| Param | Type | Description |
|---|---|---|
| url | string |
请求资源的地址 |
| data | form |
POST的数据 |
| callback | function |
回调函数 |