vant/packages/sku/en-US.md

Sku

Install

import { Sku } from 'vant';

Vue.use(Sku);

Usage

Basic Usage

<van-sku
  v-model="showBase"
  :sku="sku"
  :goods="goods"
  :goods-id="goodsId"
  :hide-stock="sku.hide_stock"
  :quota="quota"
  :quota-used="quotaUsed"
  :reset-stepper-on-hide="resetStepperOnHide"
  :reset-selected-sku-on-hide="resetSelectedSkuOnHide"
  :close-on-click-overlay="closeOnClickOverlay"
  :disable-stepper-input="disableStepperInput"
  :message-config="messageConfig"
  @buy-clicked="onBuyClicked"
  @add-cart="onAddCartClicked"
/>

Custom Stepper Config

<van-sku
  v-model="showBase"
  :sku="sku"
  :goods="goods"
  :goods-id="goodsId"
  :hide-stock="sku.hide_stock"
  :quota="quota"
  :quota-used="quotaUsed"
  :custom-stepper-config="customStepperConfig"
  @buy-clicked="onBuyClicked"
  @add-cart="onAddCartClicked"
/>

Advanced Usage

<van-sku
  v-model="showCustomAction"
  stepper-title="Stepper title"
  :sku="sku"
  :goods="goods"
  :goods-id="goodsId"
  :hide-stock="sku.hide_stock"
  :quota="quota"
  :quota-used="quotaUsed"
  show-add-cart-btn
  reset-stepper-on-hide
  :initial-sku="initialSku"
  @buy-clicked="onBuyClicked"
  @add-cart="onAddCartClicked"
>
  <!-- custom sku-header-price -->
  <template slot="sku-header-price" slot-scope="props">
    <div class="van-sku__goods-price">
      <span class="van-sku__price-symbol">￥</span><span class="van-sku__price-num">{{ props.price }}</span>
    </div>
  </template>
  <!-- custom sku actions -->
  <template slot="sku-actions" slot-scope="props">
    <div class="van-sku-actions">
      <van-button bottom-action @click="onPointClicked">Button</van-button>
      <!-- trigger sku inner event -->
      <van-button type="primary" bottom-action @click="props.skuEventBus.$emit('sku:buy')">Button</van-button>
    </div>
  </template>
</van-sku>

API

Attribute	Description	Type	Default
v-model	Whether to show sku	Boolean	false
sku	Sku data	Object	-
goods	Goods info	Object	-
goods-id	Goods id	`String	Number`
hide-stock	Whether to hide stock	Boolean	false
hide-quota-text	Whether to hide quota text	Boolean	false
show-add-cart-btn	Whether to show cart button	Boolean	true
quota	Quota (0 as no limit)	Number	0
quota-used	Used quota	Number	0
reset-stepper-on-hide	Whether to reset stepper when hide	Boolean	false
reset-selected-sku-on-hide	Whether to reset selected sku when hide	Boolean	false
disable-stepper-input	Whether to disable stepper input	Boolean	false
close-on-click-overlay	Whether to close sku popup when click overlay	Boolean	false
stepper-title	Quantity title	String	Quantity
custom-stepper-config	Custom stepper related config	Object	{}
message-config	Message related config	Object	{}
get-container	Return the mount node for sku	`String	() => HTMLElement`

Event

Event	Description	Arguments
add-cart	Triggered when click cart button	data: Object
buy-clicked	Triggered when click buy button	data: Object
stepper-change	Triggered when stepper value changed	value: number
sku-selected	Triggered when select sku	{ skuValue, selectedSku, selectedSkuComb }

Methods

Use ref to get sku instance and call instance methods

Name	Attribute	Return value	Description
getSkuData	-	skuData	Get current skuData

Slot

Name	Description
sku-header	Custom header
sku-header-price	Custom header price area
sku-body-top	Custom content before sku-group
sku-group	Custom sku
extra-sku-group	Extra custom content
sku-stepper	Custom stepper
sku-messages	Custom messages
sku-actions	Custom button actions

Data Structure

Sku Data Structure

sku: {
  tree: [
    {
      k: 'Color',
      v: [
        {
          id: '30349',
          name: 'Red',
          imgUrl: 'https://img.yzcdn.cn/1.jpg'
        },
        {
          id: '1215',
          name: 'Blue',
          imgUrl: 'https://img.yzcdn.cn/2.jpg'
        }
      ],
      k_s: 's1'
    }
  ],
  list: [
    {
      id: 2259,
      price: 100,
      s1: '1215',
      s2: '1193',
      s3: '0',
      stock_num: 110
    }
  ],
  price: '1.00',
  stock_num: 227,
  collection_id: 2261,
  none_sku: false,
  messages: [
    {
      datetime: '0',
      multiple: '0',
      name: 'Message',
      type: 'text',
      required: '1'
    }
  ],
  hide_stock: false
}

initialSku Data Structure

{
  // Key：skuKeyStr
  // Value：skuValueId
  s1: '30349',
  s2: '1193',
  selectedNum: 3
}

Goods Data Structure

goods: {
  title: 'Title',
  picture: 'https://img.yzcdn.cn/1.jpg'
}

customStepperConfig Data Structure

customStepperConfig: {
  // custom quota text
  quotaText: 'only 5 can buy',
  // custom callback when over limit
  handleOverLimit: (data) => {
    const { action, limitType, quota, quotaUsed } = data;

    if (action === 'minus') {
      Toast('at least select one');
    } else if (action === 'plus') {
      // const { LIMIT_TYPE } = Sku.skuConstants;
      if (limitType === LIMIT_TYPE.QUOTA_LIMIT) {
        let msg = `Buy up to ${quota}`;
        if (quotaUsed > 0) msg += `，you already buy ${quotaUsed}`;
        Toast(msg);
      } else {
        Toast('not enough stock');
      }
    }
  }
}

messageConfig Data Structure

messageConfig: {
  // the upload image callback
  uploadImg: () => {
    return new Promise((resolve) => {
      setTimeout(() => resolve('https://img.yzcdn.cn/upload_files/2017/02/21/FjKTOxjVgnUuPmHJRdunvYky9OHP.jpg!100x100.jpg'), 1000);
    });
  },
  // max file size (MB)
  uploadMaxSize: 3,
  // placehold config
  placeholderMap: {
    text: 'xxx',
    tel: 'xxx',
    ...
  }
}

Event Params Data Structure

skuData: {
  goodsId: '946755',
  messages: {
    message_0: '12',
    message_1: ''
  },
  cartMessages: {
    'Message 1': 'xxxx'
  },
  selectedNum: 1,
  selectedSkuComb: {
    id: 2257,
    price: 100,
    s1: '30349',
    s2: '1193',
    s3: '0',
    stock_num: 111
  }
}