mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
Docs: 新增使用文档 (#56)
* 新增 toptips readme * add toptips readme * add readme
This commit is contained in:
parent
86db7387c8
commit
99c5e20dd4
66
packages/tab/README.md
Normal file
66
packages/tab/README.md
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
## Toast 轻提示
|
||||||
|
|
||||||
|
### 使用指南
|
||||||
|
在 app.wxss 中引入组件库所有样式
|
||||||
|
```css
|
||||||
|
@import "path/to/zanui-weapp/dist/index.wxss";
|
||||||
|
```
|
||||||
|
|
||||||
|
在需要使用的页面里引入组件库模板和脚本
|
||||||
|
```html
|
||||||
|
<import src="path/to/zanui-weapp/dist/tab/index.wxml" />
|
||||||
|
```
|
||||||
|
```js
|
||||||
|
const Tab = require('path/to/zanui-weapp/dist/tab/index');
|
||||||
|
|
||||||
|
// 在 Page 中混入 Toast 里面声明的方法
|
||||||
|
Page(Object.assign({}, Tab, {
|
||||||
|
// ...
|
||||||
|
}));
|
||||||
|
```
|
||||||
|
|
||||||
|
### 代码演示
|
||||||
|
在模板中使用 zan-tab 模板,并传入相应数据
|
||||||
|
```html
|
||||||
|
<template is="zan-tab" data="{{ tab: tab1, componentId: 'tab1' }}"></template>
|
||||||
|
```
|
||||||
|
tab 的数据格式如下
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
// tab 数据列表
|
||||||
|
list: [{
|
||||||
|
// tab 项 id
|
||||||
|
id: 'all',
|
||||||
|
// tab 项展示文案
|
||||||
|
title: '全部'
|
||||||
|
}, {
|
||||||
|
id: 'topay',
|
||||||
|
title: '待付款'
|
||||||
|
}, {
|
||||||
|
id: 'tosend',
|
||||||
|
title: '待发货'
|
||||||
|
}, {
|
||||||
|
id: 'send',
|
||||||
|
title: '待收货'
|
||||||
|
}, {
|
||||||
|
id: 'sign',
|
||||||
|
title: '已完成'
|
||||||
|
}],
|
||||||
|
// 当前选中的 tab 项,以 tab 的 id 进行匹配
|
||||||
|
selectedId: 'all',
|
||||||
|
// 是否开启左右滑动类型的 tab
|
||||||
|
scroll: false
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
当 tab 被点击时,可以在页面中注册 handleZanTabChange 方法来监听
|
||||||
|
```js
|
||||||
|
Page(Object.assign({}, Tab, {
|
||||||
|
handleZanTabChange({ componentId, selectedId }) {
|
||||||
|
// componentId 即为在模板中传入的 componentId
|
||||||
|
// 用于在一个页面上使用多个 tab 时,进行区分
|
||||||
|
// selectId 表示被选中 tab 项的 id
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
```
|
29
packages/toast/README.md
Normal file
29
packages/toast/README.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
## Toast 轻提示
|
||||||
|
|
||||||
|
### 使用指南
|
||||||
|
在 app.wxss 中引入组件库所有样式
|
||||||
|
```css
|
||||||
|
@import "path/to/zanui-weapp/dist/index.wxss";
|
||||||
|
```
|
||||||
|
|
||||||
|
在需要使用的页面里引入组件库模板和脚本
|
||||||
|
```html
|
||||||
|
<import src="path/to/zanui-weapp/dist/toast/index.wxml" />
|
||||||
|
|
||||||
|
<!-- 直接使用 zan-toast 模板,并且直接传入 zanToast -->
|
||||||
|
<template is="zan-toast" data="{{ zanToast }}"></template>
|
||||||
|
```
|
||||||
|
```js
|
||||||
|
const Toast = require('path/to/zanui-weapp/dist/toast/index');
|
||||||
|
|
||||||
|
// 在 Page 中混入 Toast 里面声明的方法
|
||||||
|
Page(Object.assign({}, Toast, {
|
||||||
|
// ...
|
||||||
|
}));
|
||||||
|
```
|
||||||
|
|
||||||
|
### 代码演示
|
||||||
|
在 js 中直接调用 this.showZanToast 即可
|
||||||
|
```js
|
||||||
|
this.showZanToast('toptips的内容');
|
||||||
|
```
|
29
packages/toptips/README.md
Normal file
29
packages/toptips/README.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
## Toptips 顶部提示
|
||||||
|
|
||||||
|
### 使用指南
|
||||||
|
在 app.wxss 中引入组件库所有样式
|
||||||
|
```css
|
||||||
|
@import "path/to/zanui-weapp/dist/index.wxss";
|
||||||
|
```
|
||||||
|
|
||||||
|
在需要使用的页面里引入组件库模板和脚本
|
||||||
|
```html
|
||||||
|
<import src="path/to/zanui-weapp/dist/toptips/index.wxml" />
|
||||||
|
|
||||||
|
<!-- 直接使用 zan-toptips 模板,并且直接传入 zanTopTips -->
|
||||||
|
<template is="zan-toptips" data="{{ zanTopTips }}"></template>
|
||||||
|
```
|
||||||
|
```js
|
||||||
|
const Toptips = require('path/to/zanui-weapp/dist/toptips/index');
|
||||||
|
|
||||||
|
// 在 Page 中混入 Toptips 里面声明的方法
|
||||||
|
Page(Object.assign({}, Toptips, {
|
||||||
|
// ...
|
||||||
|
}));
|
||||||
|
```
|
||||||
|
|
||||||
|
### 代码演示
|
||||||
|
在 js 中直接调用 this.showZanTopTips 即可
|
||||||
|
```js
|
||||||
|
this.showZanTopTips('toptips的内容');
|
||||||
|
```
|
Loading…
x
Reference in New Issue
Block a user