Skip to content

Latest commit

 

History

History
159 lines (120 loc) · 6.25 KB

README.md

File metadata and controls

159 lines (120 loc) · 6.25 KB
Raw

xing-weapp-component

xing-weapp-component是小程序基础组件的扩展，不定期更新

插入一条广告（from myself）

字节跳动 - EE内推专场，广州、深圳、上海，欢迎狂砸简历

点击进入

or 扫码 ⤵️

xing组件简介

组件名 目录 扩展组件 扩展内容
xing-scroll-view /xing-components/x-scroll-view scroll-view 增加scroll-view自身的下拉刷新功能等
xing-image /xing-components/x-image image 增加图片的占位图、破图等
  • xing-scroll-view下拉刷新效果：

使用方法

  1. 下载代码，若已经安装微信开发者工具（1.02.1803130及以上版本）可点击导入代码片段

  2. 复制文件夹 xing-components 到你自己的项目中

  3. 在需要使用相关组件的页面的 json 文件中进行引用声明。此时需要提供每个自定义组件的标签名和对应的自定义组件文件路径：

    {
  "usingComponents": {
    "x-tag-name": "path/to/xing-components/x-tag-name"
  }
}

  4. 在页面的 wxml 中就可以像使用基础组件一样使用自定义组件。节点名即自定义组件的标签名，节点属性即传递给组件的属性值。

    <view>
  <x-tag-name attr-name="attr-value"></x-tag-name>
</view>

    参考：自定义组件官方文档

组件文档

xing-scroll-view

属性名 类型 默认值 说明
pull-down-height Number 60 下拉到多少高度时可刷新，单位为 px
pull-text String 下拉可以刷新 下拉还不能刷新时显示的文字
release-text String 松开立即刷新 下拉至可刷新时显示的文字
loading-text String 正在刷新数据中 刷新时显示的文字，尾部会自动接 ...
finish-text String 刷新完成 刷新完成时显示的文字
loadmore-text String 正在加载更多数据 上拉加载更多时显示的文字
nomore-text String 已经全部加载完毕 上拉加载无数据后显示的文字
refreshing Boolean false 是否正在刷新
nomore Boolean false 是否没有更多数据（加载完毕）
bindpulldownrefresh HandleEvent 当下拉刷新时触发
bindloadmore HandleEvent 当滚动到底部时触发
bindscroll HandleEvent 同scroll-view

注意：

  1. 触发 pulldownrefresh 事件时，组件的 refreshing 属性会被设为 true ，刷新完成后将其设为 false 以完成刷新
  2. 当没有更多数据时，将组件的 nomore 属性设为 true
  3. 每页内容总高度应大于组件的高度，否则在底部加载时会出现问题，因此在当前页确定为最后一页时（如内容不足一页）就应该将 nomore 设为 true
  4. 使用微信开发者工具进行远程调试时，会出现奇怪的bug，应该是wxml调试监听的问题

示例

<view class="header">header</view>
<x-scroll-view refreshing="{{refreshing}}" nomore="{{nomore}}" bindpulldownrefresh="_onPullDownRefresh" bindloadmore="_onLoadmore" bindscroll="_onScroll">
  <block wx:for="{{colors}}" wx:for-index="index" wx:key="index">
    <view class="view" style="background: {{item}}">{{index + 1}}. {{item}}</view>
  </block>
</x-scroll-view>
Page({

  data: {
    colors: [],
  },

  _randomColor: function () {
    return `rgba(${Math.floor(Math.random() * 256)},${Math.floor(Math.random() * 256)},${Math.floor(Math.random() * 256)},${(Math.random() * 0.3 + 0.2).toFixed(1)})`;
  },

  _generateColors: function (length) {
    return new Array(length).fill(null).map(() => this._randomColor());
  },

  //下拉刷新监听函数
  _onPullDownRefresh: function () {
    setTimeout(() => {
      const colors = this._generateColors(20);
      this.setData({
        colors,
        refreshing: false,
      });
    }, 2000);
  },

  //加载更多监听函数
  _onLoadmore: function () {
    setTimeout(() => {
      if (this.data.colors.length == 80) {
        this.setData({ nomore: true })
      } else {
        const colors = this._generateColors(20);
        this.setData({ colors: [...this.data.colors, ...colors] });
      }
    }, 1000);
  },

  _onScroll: function (e) {
    console.log(e);
  },

  onLoad: function (options) {
    const colors = this._generateColors(20);
    this.setData({ colors });
  },
})

xing-image

属性名 类型 默认值 说明
src String 同image
mode String scaleToFill 同image
lazy-load Boolean false 同image
placeholder-image String data: image / png; base64, iVBOR... 占位图，支持url、base64、本地目录
broken-image String 图片加载失败时显示图片，支持url、base64、本地目录，若未设置则不显示

注意：

  1. xing-image 是 block 块级元素
  2. 在 scroll-view 下使用 xing-image 无法使用 lazy-load ，应该是小程序对 scroll-view 下的自定义组件内的 image 的 lazy-load 存在bug，会导致图片不加载

示例

<x-image class="x-image" src="https://images.unsplash.com/photo-1516203294340-5ba5f612dc6a?ixlib=rb-0.3.5&ixid=eyJhcHBfaWQiOjEyMDd9&s=1b79294f231ab4799218e82818a07de1&auto=format&fit=crop&w=500&q=60"></x-image>
<x-image class="x-image" src="https://images.unsplash.com/photo-1496134732667-ae8d2853a045?ixlib=rb-0.3.5&ixid=eyJhcHBfaWQiOjEyMDd9&s=e4dd1c9106a69065ccfa21a36cfb53b1&auto=format&fit=crop&w=500&q=60" placeholder-image="/sources/placeholder.png"></x-image>
<x-image class="x-image" src="http://www.fourzero.four" broken-image="/sources/broken-image.png"></x-image>