Nothing Precedes Matter

    captain-weapp

    0.0.1 • Public • Published

    有赞logo

    项目logo

    高颜值、好用、易扩展的小程序 UI 库

    概述

    ZanUI-WeApp是有赞移动 Web UI 规范 ZanUI 的小程序现实版本,结合了微信的视觉规范,为用户提供更加统一的使用感受。

    现已包含 badge、btn、card、cell、dialog、icon、label、noticebar、panel、popup、switch、tab、toast、toptips 等组件或元素。具体可以扫描下方小程序二维码,体验组件库示例 Demo

    ZanUI-WeApp 演示

    更多背景介绍,请移步 我们写的介绍文章

    下载

    git clone https://github.com/youzan/zanui-weapp.git

    预览

    1. 在 zanui-weapp 根目录下运行
    # 安装项目依赖
    npm install
    # 执行组件编译
    npm run dev
    1. 打开微信web开发者工具,'本地小程序项目 - 添加项目',把 zanui-weapp/example 目录添加进去就可以预览示例demo了。

    使用

    1. 使用 ZanUI-WeApp 前请确保已经学习过微信官方的 小程序简易教程小程序框架介绍
    2. 然后用 BowerZanUI-WeApp 添加到你的项目中使用。
    3. 你也可以 fork 出一份你自己的 ZanUI-WeApp,这样可以获得更稳定的代码和更方便的进行个性定制。

    我们推荐在你的app.wxss直接引入zanui-weapp/dist/index.wxss

    详细使用文档,请参考 快速上手

    组件分类介绍

    根据功能的不同,可以将组件大致的分为2类:

    1. 正常引用

    如按钮组件,只需要在页面中引入按钮自定义组件即可

    {
        "usingComponents": {
            "zan-button": "/path/to/zanui-weapp/dist/btn/index"
        }
    }
    <!-- example/btn/index.html -->
     
    <zan-button>按钮</zan-button>

    2. API类组件

    如 Toast 组件,需要先在页面上引入自定义组件。之后在逻辑运行时,直接调用方法即可展示

    {
        "usingComponents": {
            "zan-toast": "/path/to/zanui-weapp/dist/toast/index"
        }
    }
    <zan-toast id="zan-toast-test"></zan-toast>

    将对应的 Toast 的函数引入页面,就可以直接调用来展示 Toast 了

    // example/toast/index.js
     
    const Toast = require('/path/to/zanui-weapp/dist/toast/toast');
     
    Page({
      showToast() {
        Toast({
            selector: '#zan-toast-test',
            message: 'toast内容'
        });
      }
    });
     

    更多示例可以在项目的example目录中查看

    旧版组件库

    组件库现在已经全部升级至自定义组件,如果项目暂时无法切换到自定义组件的形式,可以将使用的版本号设置为低于 3.0.0。同时,旧的代码会在分支 old_code 上保留一段时间。

    建议新使用的用户,直接以自定义组件形式接入

    开源协议

    本项目基于 MIT协议,请自由地享受和参与开源。

    贡献

    如果你有好的意见或建议,欢迎给我们提 issuePR,为优化 ZanUI-Weapp 贡献力量

    Keywords

    none

    Install

    npm i captain-weapp

    DownloadsWeekly Downloads

    1

    Version

    0.0.1

    License

    ISC

    Unpacked Size

    110 kB

    Total Files

    65

    Last publish

    Collaborators

    • cookfront