miniprogram custom component framework
npm install j-component



仿小程序组件系统,可以让小程序自定义组件跑在 web 端。
* 此框架的性能比不上小程序的实现。
* 此框架的功能会比小程序略微弱一点。
* 此框架不是小程序的子集,是完全独立的实现,请勿将此等价于小程序内的实现。
```
npm install --save j-component
`js`
const jComponent = require('j-component')
注册 behavior。
`js`
let behavior = jComponent.behavior({
/ 小程序 behavior 支持的定义段 /
})
注册自定义组件,返回自定组件 id。
#### definition
| 属性名 | 类型 | 描述 |
|---|---|---|
| id | String | 可选字段,如果传了此字段,则表明注册为全局组件,其他组件可直接在 template 中使用而无需在 usingComponents 里引入 |
| tagName | String | 可选字段,指定组件对应的 dom 节点的 tagName,默认取 usingComponents 里的定义或组件自身的 id |
| path | String | 可选字段,该组件在文件系统中的绝对路径,用于需要涉及到组件路径的方法中,如 getRelationNodes 方法 |
| template | String | 组件模板,即组件对应的 wxml 内容 |
| usingComponents | Object | 使用到的自定义组件映射表 |
| behaviors | Array
| options | Object | 配置对象,支持小程序自定义组件 options 定义段支持的所有字段 |
| options.classPrefix | String | 组件样式的私有化前缀,默认是空串,即没有前缀 |
` js
jComponent.register({
id: 'view',
tagName: 'wx-view',
template: ''
})
let childId = jComponent.register({
tagName: 'xxx',
template: '
})
let id = jComponent.register({
template: '
usingComponents: {
'child': childId, // 声明要使用的组件,传入组件 id
},
behaviors: [behavior],
options: {
classPrefix: 'xxx',
/ 其他小程序自定义组件支持的 option,比如 addGlobalClass 等 /
},
/ 其他小程序自定义组件支持的定义段,比如 methods 定义段等 /
})
`
创建自定义组件实例,返回 RootComponent。
#### componentId
调用 register 接口返回的 id。
#### properties
创建组件实例时,由组件接收的初始 properties 对象。
`js`
let rootComp = jComponent.create(id)
组件。
#### 属性
| 属性名 | 类型 | 描述 |
|---|---|---|
| dom | Object | 组件实例对应的 dom 节点 |
| data | Object | 组件实例对应的 data 对象 |
| instance | Object | 组件实例中的 this,通过此字段可以访问组件实例的 methods 等定义段 |
#### 方法
##### querySelector(selector)
获取符合给定匹配串的第一个节点,返回 Component 实例。
> PS:支持 selector 同小程序自定义组件的 selectComponent 接口
`js`
let childComp = comp.querySelector('#a')
##### querySelectorAll(selector)
获取符合给定匹配串的所有节点,返回 Component 实例列表
> PS:支持 selector 同小程序自定义组件的 selectAllComponents 接口
`js`
let childComps = comp.querySelectorAll('.a')
##### setData(data, callback)
调用组件实例的 setData 方法.
`js`
comp.setData({ text: 'a' }, () => {})
##### dispatchEvent(eventName, options)
用于模拟触发该组件实例节点上的事件。
`js
// 触发组件树中的节点事件
comp.dispatchEvent('touchstart', {
touches: [{ x: 0, y: 0 }],
changedTouches: [{ x: 0, y: 0 }],
})
// 触发组件树中的节点自定义事件
comp.dispatchEvent('customevent', {
touches: [{ x: 0, y: 0 }],
changedTouches: [{ x: 0, y: 0 }],
/ 其他 CustomEvent 构造器支持的 option /
})
`
##### addEventListener(eventName, handler, useCapture)
用于外部监听组件触发的事件。
`js`
comp.addEventListener('customevent', evt => {
console.log(evt)
})
##### removeEventListener(eventName, handler, useCapture)
用于外部取消监听组件触发的事件。
`js`
const handler = evt => {
console.log(evt)
comp.removeEventListener('customevent', handler)
}
comp.addEventListener('customevent', handler)
##### triggerLifeTime(lifeTime, args)
触发组件实例的生命周期钩子。
`js`
comp.triggerLifeTime('moved', {test: 'xxx'})
##### triggerPageLifeTime(lifeTime, args)
触发组件实例中配置的页面的生命周期钩子。
`js`
comp.triggerPageLifeTime('show', {test: 'xxx'})
##### toJSON()
将节点组件下的节点树生成一个 JSON 树
`js`
comp.toJSON()
根组件,继承自 Component。亦即是说,所有 Component 支持的属性/接口,RootComponent 都支持。
#### 方法
##### attach
将根组件实例挂载在传入的 dom 节点上。
`js`
const parent = document.createElement('div')
rootComp.attach(parent)
##### detach
将根组件实例从父亲 dom 节点上移除。
`js``
rootComp.detach()
* 内置 wxml 解析器的 template 支持
* 内置 wxml 解析器的 include 支持
* 内置 wxml 解析器的 import 支持
* 内置 wxml 解析器的 外部 wxs
* generics 支持
* moved 生命周期
* ......