omi/packages/omi-mp
张磊 b3726a5e89 omi-mp - supports wx.navigateBack & remove gulp-watch 2018-12-10 14:38:02 +08:00
..
config Directory changes 2018-11-09 07:55:38 +08:00
public Directory changes 2018-11-09 07:55:38 +08:00
scripts omi-mp - fix parse error 2018-12-05 10:10:59 +08:00
src omi-mp - supports wx.navigateBack & remove gulp-watch 2018-12-10 14:38:02 +08:00
src-mp omi-mp - update example 2018-12-05 19:13:20 +08:00
test omi-mp - fix build error 2018-11-19 15:46:23 +08:00
.eslintrc Directory changes 2018-11-09 07:55:38 +08:00
.gitignore Directory changes 2018-11-09 07:55:38 +08:00
gulpfile.js fix gulp-watch no effect 2018-12-09 18:31:58 +08:00
package.json fix gulp-watch no effect 2018-12-09 18:31:58 +08:00
readme.md update readme of omi-mp 2018-12-05 17:33:18 +08:00

readme.md

omi-mp - 微信小程序开发和生成 Web

通过微信小程序开发和一键生成 Web 的 H5 SPA (基于 omi + omi-router)

看下官方模板的转换例子:

Index Logs

因为 Web 里拉取不到用户登录态,更换了用户头像和名称。

再看下豆瓣 DEMO 转换的例子:

小程序 Web SPA

你可以在这里找到这个豆瓣小程序。

快速体验

$ npm i omi-cli -g              
$ omi init-mp my-app    
$ cd my-app        
$ npm start                  
$ npm run build             

特别注意,由于 concurrently 不明原因起不来导致 npm start 报错,可以试着分两个命令行执行,和 npm start 同样的效果:

gulp
node scripts/start.js

把小程序项目拷贝到 src-mp 目录,如果是新的小程序,可以在 src-mp 目录创建小程序,目录要求:

目录说明:

├─ components     //存放所有组件,每个组件一个文件夹,暂不支持乱放
├─ pages          //存放所有页面,每个页面一个文件夹,暂不支持乱放
│  ├─ index    
│  └─ logs   
├─ utils
├─ app.js
├─ app.json
├─ app.wxss
├─ project.config.json

请严格按照上面目录约定,然后就可以使用小程序开发或生产 Web 了:

npm start  //开发
npm build  //发布

原理

WXML 编译

举个99乘法表的例子:

compile(`
<view wx:for="{{[1, 2, 3, 4, 5, 6, 7, 8, 9]}}" wx:for-item="i">
  <view wx:for="{{[1, 2, 3, 4, 5, 6, 7, 8, 9]}}" wx:for-item="j">
    <view wx:if="{{i <= j}}">
      {{i}} * {{j}} = {{i * j}}
    </view>
  </view>
</view>`)

编译之后:

function render() {
  return (
    h('div', {}, [1, 2, 3, 4, 5, 6, 7, 8, 9].map((i, index) => {
      h('div', {}, [1, 2, 3, 4, 5, 6, 7, 8, 9].map((j, index) => {
        i <= j && h('div', {}, [`${i} * ${j} = ${i * j}`])
      }))
    }))
  )
}

WXML 会被编译成 hyperscript并且对应的标签会被转换成 HTML 标签

WXSS 编译

编译前:

view image .image{
  color: red;
}

编译后:

div img .image{
  color: red;
}

不仅仅标签会进行替换rpx 也会在运行时替换成 px。

小程序生命周期

页面生命周期函数

名称 描述 Omi 是否支持
onLoad 监听页面加载 支持
onShow 监听页面显示 支持
onReady 监听页面初次渲染完成 支持
onHide 监听页面隐藏 支持
onUnload 监听页面卸载 支持
onReachBottom 监听页面滚到底部 支持

组件生命周期函数

名称 描述 Omi 是否支持
created 在组件实例进入页面节点树时执行,注意此时不能调用 setData 支持
attached 在组件实例进入页面节点树时执行 支持
ready 在组件布局完成后执行,此时可以获取节点信息(使用 SelectorQuery 支持
moved 在组件实例被移动到节点树另一个位置时执行 支持
detached 在组件实例被从页面节点树移除时执行 支持

支持的 API

  • wx.request

  • wx.navigateTo

  • wx.getSystemInfo

  • wx.getSystemInfoSync

  • wx.setNavigationBarTitle

  • this.setData

  • this.triggerEvent

支持事件绑定,自定义事件绑定,支持 props、data 属性等等。

注意

目前不支持导入 template 标签和一些原生组件标签,需要一些时间翻译成对应的 HTML 自定义元素,欢迎试用反馈或 PR。

bindtap 的时候在js里通过 evt.currentTarget.dataset.id 一定需要字符串,所以如果是字数需要转成字符串:

<view bindtap="tapHandler" data-id="{{item.id+''}}"></view>

License

MIT @dntzhang