vant/packages/coupon-list/en-US.md

Coupon

Install

import { CouponCell, CouponList } from 'vant';

Vue.use(CouponCell).use(CouponList);

Usage

Basic Usage

<!-- Coupon Cell -->
<van-coupon-cell
  :coupons="coupons"
  :chosen-coupon="chosenCoupon"
  @click="showList = true"
/>

<!-- Coupon List -->
<van-popup v-model="showList" position="bottom">
  <van-coupon-list
    :coupons="coupons"
    :chosen-coupon="chosenCoupon"
    :disabled-coupons="disabledCoupons"
    @change="onChange"
    @exchange="onExchange"
  />
</van-popup>

const coupon = {
  available: 1,
  originCondition: 0,
  reason: '',
  value: 150,
  name: 'Coupon name',
  startAt: 1489104000,
  endAt: 1514592000,
  valueDesc: '1.5',
  unitDesc: '元'
};

export default {
  data() {
    return {
      chosenCoupon: -1,
      coupons: [coupon],
      disabledCoupons: [coupon]
    }
  },

  methods: {
    onChange(index) {
      this.showList = false;
      this.chosenCoupon = index;
    },
    onExchange(code) {
      this.coupons.push(coupon);
    }
  }
}

CouponCell API

Attribute	Description	Type	Default
title	Cell title	String	Coupon
chosen-coupon	Index of chosen coupon	Number	-1
coupons	Coupon list	Array	[]
editable	Cell editable	Boolean	true
border	Whether to show innner border	Boolean	true
currency	Currency symbol	String	¥

CouponList API

Attribute	Description	Type	Default
v-model	Current exchange code	String	-
chosen-coupon	Index of chosen coupon	Number	-1
coupons	Coupon list	Array	[]
disabled-coupons	Disabled voupon list	Array	[]
exchange-button-text	Exchange button text	String	Exchange
exchange-button-loading	Whether to show loading in exchange button	Boolean	false
exchange-button-disabled	Whether to disable exchange button	Boolean	false
exchange-min-length	Min length to enable exchange button	Number	1
displayed-coupon-index	Index of displayed coupon	Number	-
close-button-text	Close button text	String	Close
input-placeholder	Input placeholder	String	Coupon code
currency	Currency symbol	String	¥

CouponList Event

Event	Description	Arguments
change	Triggered when change chosen coupon	index: index of chosen coupon
exchange	Triggered when exchange coupon	code: exchange code

Coupon Item Data Structure

key	Description	Type
id	Id	String
name	Name	String
condition	Condition	String
startAt	Start time (Timestmap, unit second)	Number
endAt	End time (Timestmap, unit second)	Number
description	Description	String
reason	Unavailable reason	String
value	Value	Number
valueDesc	Value Text	String
unitDesc	Unit Text	String