vant/src/sku

Sku

Install

import Vue from 'vue';
import { Sku } from 'vant';

Vue.use(Sku);

Usage

Basic Usage

<van-sku
  v-model="show"
  :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"
  :disable-stepper-input="disableStepperInput"
  :message-config="messageConfig"
  @buy-clicked="onBuyClicked"
  @add-cart="onAddCartClicked"
/>

export default {
  data() {
    return {
      show: false,
      sku: {},
      goods: {},
      messageConfig: {},
    };
  },
};

Custom Stepper

<van-sku
  v-model="show"
  :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"
/>

Custom By Slot

<van-sku
  v-model="show"
  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 #sku-header-price="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 #sku-actions="props">
    <div class="van-sku-actions">
      <van-button square size="large" type="warning" @click="onPointClicked">
        Button
      </van-button>
      <!-- trigger sku inner event -->
      <van-button
        square
        size="large"
        type="danger"
        @click="props.skuEventBus.$emit('sku:buy')"
      >
        Button
      </van-button>
    </div>
  </template>
</van-sku>

API

Props

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
price-tag	Tag behind the price	string	-
hide-stock	Whether to hide stock	boolean	false
hide-quota-text	Whether to hide quota text	boolean	false
hide-selected-text	Whether to hide selected text	boolean	false
stock-threshold	stock threshold	boolean	50
show-add-cart-btn	Whether to show cart button	boolean	true
buy-text	Buy button text	string	-
add-cart-text	Add cart button text	string	-
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 overlay is clicked	boolean	true
stepper-title	Quantity title	string	Quantity
custom-stepper-config	Custom stepper related config	object	{}
message-config	Message related config	object	{}
disable-soldout-sku v2.11.3	Whether to disable soldout sku	boolean	true
get-container	Return the mount node for sku	string | () => Element	-
safe-area-inset-bottom	Whether to enable bottom safe area adaptation	boolean	true
start-sale-num	Minimum quantity	number	1
properties	Goods properties	array	-
preview-on-click-image v2.5.2	Whether to preview image when click goods image	boolean	true
show-header-image v2.9.0	Whether to display header image	boolean	true
lazy-load	Whether to enable lazy load，should register Lazyload component	boolean	false

Events

Event	Description	Arguments
add-cart	Emitted when click cart button	data: object
buy-clicked	Emitted when click buy button	data: object
stepper-change	Emitted when stepper value changed	value: number
sku-selected	Emitted when select sku	{ skuValue, selectedSku, selectedSkuComb }
sku-prop-selected	Emitted when select property	{ propValue, selectedProp, selectedSkuComb }
open-preview	Emitted when open image preview	data: object
close-preview	Emitted when close image preview	data: object
sku-reset v2.8.1	Emitted when reset sku and property	{ selectedSku, selectedProp, selectedSkuComb }

Methods

Use ref to get Sku instance and call instance methods.

Name	Description	Attribute	Return value
getSkuData	Get current skuData	-	skuData
resetSelectedSku	Reset selected sku to initial sku	-	-

Slots

Name	Description
sku-header	Custom header
sku-header-price	Custom header price area
sku-header-origin-price	Custom header origin price area
sku-header-extra	Extra header area
sku-header-image-extra v2.5.2	Custom header image extra 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-top	Custom content before sku-actions
sku-actions	Custom button actions

Sku Data Structure

sku: {
  tree: [
    {
      k: 'Color',
      k_s: 's1',
      v: [
        {
          id: '1',
          name: 'Red',
          imgUrl: 'https://img01.yzcdn.cn/1.jpg',
          previewImgUrl: 'https://img01.yzcdn.cn/1p.jpg',
        },
        {
          id: '1',
          name: 'Blue',
          imgUrl: 'https://img01.yzcdn.cn/2.jpg',
          previewImgUrl: 'https://img01.yzcdn.cn/2p.jpg',
        }
      ],
      largeImageMode: true, //  whether to enable large image mode
    }
  ],
  list: [
    {
      id: 2259,
      s1: '1',
      s2: '1',
      price: 100,
      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'，
      placeholder: ''
    }
  ],
  hide_stock: false,
  properties: [
    {
      k_id: 123,
      k: 'More',
      is_multiple: true,
      v: [
        {
          id: 1222,
          name: 'Tea',
          price: 1,
        },
        {
          id: 1223,
          name: 'Water',
          price: 1,
        }
      ],
    }
  ]
}

properties Data Structure

[
  {
    k_id: 123,
    k: 'More',
    is_multiple: true,
    v: [
      {
        id: 1222,
        name: 'Tea',
        price: 1,
      },
      {
        id: 1223,
        name: 'Water',
        price: 1,
      },
    ],
  },
];

initialSku Data Structure

{
  // Key：skuKeyStr
  // Value：skuValueId
  s1: '30349',
  s2: '1193',
  selectedNum: 3,
  selectedProp: {
    123: [1222]
  }
}

Goods Data Structure

goods: {
  picture: 'https://img01.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, startSaleNum } = data;

    if (action === 'minus') {
      Toast(`at least select ${startSaleNum > 1 ? startSaleNum : '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');
      }
    }
  },
  // custom callback when stepper value change
  handleStepperChange: currentValue => {},
  // stock
  stockNum: 1999,
  // stock fomatter
  stockFormatter: stockNum => {},
}

messageConfig Data Structure

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

Events 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,
    properties: [
      {
        k_id: 123,
        k: 'More',
        is_multiple: true,
        v: [
          {
            id: 1223,
            name: 'Water',
            price: 1
          }
        ]
      }
    ],
    property_price: 1
  }
}

Less Variables

How to use: Custom Theme.

Name	Default Value	Description
@sku-item-background-color	@background-color	-
@sku-icon-gray-color	@gray-4	-
@sku-upload-mask-color	rgba(50, 50, 51, 0.8)	-