diff --git a/README.md b/README.md index f92c6582..27122c65 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,147 @@

+ 高颜值、好用、易扩展的小程序 UI 库,Powered by 有赞 ==== ## 概述 -[ZanUI-WeApp](https://github.com/youzan/zanui-weapp) 是有赞移动 Web UI 规范 `ZanUI` 的小程序现实版本, -结合了微信的视觉规范,为用户提供更加统一的使用感知。 -包含 badge、btn、card、cell、color、dialog、form、helper、icon、label、loadmore、panel、quantity、 -steps、tab、toast、toptip 共计 17 类组件或元素。 +[ZanUI-WeApp]是有赞移动 Web UI 规范 `ZanUI` 的小程序现实版本,结合了微信的视觉规范,为用户提供更加统一的使用感知。 + +包含 badge、btn、card、cell、color、dialog、form、helper、icon、label、loadmore、panel、quantity、steps、tab、toast、toptip 共计 17 类组件或元素。 更多背景介绍,可以移步到 [我们专门写的的介绍文章](http://tech.youzan.com/zanui-weapp/)。 -## Demo -1. 下载源码 +## 下载 ``` bash git clone https://github.com/youzan/zanui-weapp.git ``` -2. 打开 `微信Web开发者工具`,'本地小程序项目 - 添加项目',把 zanui-weapp 添加进去就可以查看组件源码、预览示例demo了。 +## 预览 +打开[微信web开发者工具](https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/download.html),'本地小程序项目 - 添加项目',把 zanui-weapp 添加进去就可以查看组件源码、预览示例demo了。 + +![](https://img.yzcdn.cn/public_files/2017/02/08/a5e6445075826183659742cc6946c477.png) ## 使用 -1. 使用 [ZanUI-WeApp](https://github.com/youzan/zanui-weapp) 前 -请确保已经学习过微信官方的 [小程序简易教程](https://mp.weixin.qq.com/debug/wxadoc/dev/) -和 [小程序框架介绍](https://mp.weixin.qq.com/debug/wxadoc/dev/framework/MINA.html) -1. 然后用 [Bower](https://bower.io/) 将 [ZanUI-WeApp](https://github.com/youzan/zanui-weapp) 添加到你的项目中使用。 +1. 使用 [ZanUI-WeApp] 前请确保已经学习过微信官方的 [小程序简易教程] 和 [小程序框架介绍]。 +2. 然后用 [Bower] 将 [ZanUI-WeApp] 添加到你的项目中使用。 +3. 你也可以 fork 出一份你自己的 [ZanUI-WeApp],这样更利于代码稳定和个性定制。 -1. 你也可以 fork 出一份你自己的 [ZanUI-WeApp](https://github.com/youzan/zanui-weapp),这样更利于代码稳定和个性定制。 +我们推荐在你的`app.wxss`直接引入`zanui-weapp/dist/index.wxss`。 + +根据功能的不同,可以将组件大致的分为4类: + +### 一、简单组件 + +如按钮组件,只要按照wxml结构写就好了 + +~~~html + + +按钮 +~~~ + +![](https://img.yzcdn.cn/public_files/2017/02/08/1b1e39ed3dc6b63519a68ba1e2650cfc.png) + +### 二、复杂组件 + +如加载更多组件,需要先引入定义好的模版,然后给模版传递数据 + +~~~html + + + + + + +