1Introduction
- description：DOM 选择器
- author：zcl
- create：未明确
- update：未明确
- github：
https://github.com/blearjs/blear.core.selector
2Example
var selector = require('blear.core.selector');
3Static
静态属性、方法
3.1.query(sel, [context]): array
在上下文中查找DOM元素，永远返回一个数组
selector.query('body');
// => [HTMLBODYElement]
selector.query('div');
// => [div, div, ...]
3.1.1sel
- 类型：
String | Object - 说明：selector 选择器
3.1.2context
- 类型：
String | Object - 说明：[context=document] 上下文
3.1.3array
- 类型：
Array - 说明：nodeList 数组
3.2.contains(childEl, parentEl): boolean
判断元素是否包含关系
selector.contains(selector.query('div')[0], document);
// => true
selector.contains(document,selector.query('div')[0]);
// => false
3.2.1childEl
- 类型：
Object - 说明：selector 子元素
3.2.2parentEl
- 类型：
Object - 说明：父元素
3.2.3boolean
- 类型：
Boolean - 说明：布尔值
3.3.siblings(el): array
获取当前元素的其他兄弟元素
selector.siblings(el);
// => [div, div, ...];
3.3.1el
- 类型：
Object - 说明：el 元素
3.3.2array
- 类型：
Array - 说明：nodeList 数组
3.4.index(el): number
获取当前元素的索引值
selector.index(el);
// find => [0,+∞)
// unfind => -1
3.4.1el
- 类型：
Object - 说明：el 元素
3.4.2number
- 类型：
Number - 说明：未匹配到为-1，匹配到为[0,+∞)
3.5.prev(el): array
获取元素的上一个兄弟元素
selector.prev(el);
// => [div];
3.5.1el
- 类型：
Object - 说明：el 元素
3.5.2array
- 类型：
Array - 说明：nodeList 数组
3.6.next(el): array
获取元素的下一个兄弟元素
selector.next(el);
// => [div];
3.6.1el
- 类型：
Object - 说明：el 元素
3.6.2array
- 类型：
Array - 说明：nodeList 数组
3.7.prevAll(el): array
获取元素的上面全部兄弟元素
selector.prevAll(el);
// => [div, div, ...];
3.7.1el
- 类型：
Object - 说明：el 元素
3.7.2array
- 类型：
Array - 说明：nodeList 数组
3.8.nextAll(el): array
获取元素的下面全部兄弟元素
selector.nextAll(el);
// => [div, div, ...];
3.8.1el
- 类型：
Object - 说明：el 元素
3.8.2array
- 类型：
Array - 说明：nodeList 数组
3.9.parent(el): array
获得父级元素
selector.parent(el);
// => [div];
3.9.1el
- 类型：
Object - 说明：el 元素
3.9.2array
- 类型：
Array - 说明：nodeList 数组
3.10.children(el): array
获得子元素
selector.children(el);
// => [div, div, ...];
3.10.1el
- 类型：
Object - 说明：el 元素
3.10.2array
- 类型：
Array - 说明：nodeList 数组
3.11.contents(el): array
获取子节点
selector.contents(el);
// => [div, div, ...];
3.11.1el
- 类型：
Object - 说明：el 元素
3.11.2array
- 类型：
Array - 说明：nodeList 数组
3.12.matches(el, sel): boolean
元素与选择器是否匹配
selector.matches(ele, 'div');
// => true OR false
3.12.1el
- 类型：
Object - 说明：el 元素
3.12.2sel
- 类型：
String - 说明：sel 选择器
3.12.3boolean
- 类型：
Boolean - 说明：布尔值
3.13.closest(el, sel, [rootEl]): array
从元素本身开始获得最近匹配的祖先元素
selector.closest(el, 'div');
// => [div];
3.13.1el
- 类型：
Object - 说明：el 元素
3.13.2sel
- 类型：
Object | String - 说明：sel 选择器
3.13.3rootEl
- 类型：
HTMLElement - 说明：[rootEl] 根元素，默认是 document
3.13.4array
- 类型：
Array - 说明：nodeList 数组
3.14.filter(nodeList, filter): array
过滤节点集合
selector.filter(ele, function(){
return this.nodeName === 'DIV';
});
// => [div, div, ...]
3.14.1nodeList
- 类型：
array | NodeList - 说明：nodeList 节点集合
3.14.2filter
- 类型：
Function - 说明：filter 过滤方法，返回true选择该节点
3.14.3array
- 类型：
Array - 说明：nodeList 数组
4Dependencies
5Reference
这里写更多的额外内容，可以不写。