Sku 商品规格

引入

  1. import Vue from 'vue';
  2. import { Sku } from 'vant';
  3. Vue.use(Sku);

代码演示

基础用法

  1. <van-sku
  2. v-model="show"
  3. :sku="sku"
  4. :goods="goods"
  5. :goods-id="goodsId"
  6. :quota="quota"
  7. :quota-used="quotaUsed"
  8. :hide-stock="sku.hide_stock"
  9. :message-config="messageConfig"
  10. @buy-clicked="onBuyClicked"
  11. @add-cart="onAddCartClicked"
  12. />
  1. export default {
  2. data() {
  3. return {
  4. show: false,
  5. sku: {
  6. // 数据结构见下方文档
  7. },
  8. goods: {
  9. // 数据结构见下方文档
  10. },
  11. messageConfig: {
  12. // 数据结构见下方文档
  13. },
  14. };
  15. },
  16. };

自定义步进器

  1. <van-sku
  2. v-model="show"
  3. :sku="sku"
  4. :goods="goods"
  5. :goods-id="goodsId"
  6. :quota="quota"
  7. :quota-used="quotaUsed"
  8. :hide-stock="sku.hide_stock"
  9. :custom-stepper-config="customStepperConfig"
  10. @buy-clicked="onBuyClicked"
  11. @add-cart="onAddCartClicked"
  12. />

通过插槽定制

  1. <van-sku
  2. v-model="show"
  3. stepper-title="我要买"
  4. :sku="sku"
  5. :goods="goods"
  6. :goods-id="goodsId"
  7. :quota="quota"
  8. :quota-used="quotaUsed"
  9. :hide-stock="sku.hide_stock"
  10. show-add-cart-btn
  11. reset-stepper-on-hide
  12. :initial-sku="initialSku"
  13. @buy-clicked="onBuyClicked"
  14. @add-cart="onAddCartClicked"
  15. >
  16. <!-- 自定义 sku-header-price -->
  17. <template #sku-header-price="props">
  18. <div class="van-sku__goods-price">
  19. <span class="van-sku__price-symbol"></span
  20. ><span class="van-sku__price-num">{{ props.price }}</span>
  21. </div>
  22. </template>
  23. <!-- 自定义 sku actions -->
  24. <template #sku-actions="props">
  25. <div class="van-sku-actions">
  26. <van-button square size="large" type="warning" @click="onPointClicked">
  27. 积分兑换
  28. </van-button>
  29. <!-- 直接触发 sku 内部事件,通过内部事件执行 onBuyClicked 回调 -->
  30. <van-button
  31. square
  32. size="large"
  33. type="danger"
  34. @click="props.skuEventBus.$emit('sku:buy')"
  35. >
  36. 买买买
  37. </van-button>
  38. </div>
  39. </template>
  40. </van-sku>

API

Props

参数说明类型默认值
v-model是否显示商品规格弹窗booleanfalse
sku商品 sku 数据object-
goods商品信息object-
goods-id商品 idnumber | string-
price-tag显示在价格后面的标签string-
hide-stock是否显示商品剩余库存booleanfalse
hide-quota-text是否显示限购提示booleanfalse
hide-selected-text是否隐藏已选提示booleanfalse
stock-threshold库存阈值。低于这个值会把库存数高亮显示boolean50
show-add-cart-btn是否显示加入购物车按钮booleantrue
buy-text购买按钮文字string立即购买
add-cart-text加入购物车按钮文字string加入购物车
quota限购数,0 表示不限购number0
quota-used已经购买过的数量number0
reset-stepper-on-hide隐藏时重置选择的商品数量booleanfalse
reset-selected-sku-on-hide隐藏时重置已选择的 skubooleanfalse
disable-stepper-input是否禁用步进器输入booleanfalse
close-on-click-overlay是否在点击遮罩层后关闭booleantrue
stepper-title数量选择组件左侧文案string购买数量
custom-stepper-config步进器相关自定义配置object{}
message-config留言相关配置object{}
get-container指定挂载的节点,用法示例string | () => Element-
initial-sku默认选中的 sku,具体参考高级用法object{}
show-soldout-sku是否展示售罄的 sku,默认展示并置灰booleantrue
safe-area-inset-bottom是否开启底部安全区适配booleantrue
start-sale-num v2.3.0起售数量number1
properties v2.4.2商品属性array-
preview-on-click-image v2.5.2是否在点击商品图片时自动预览booleantrue
show-header-image v2.9.0是否展示头部图片booleantrue
lazy-load v2.9.0是否开启图片懒加载,须配合 Lazyload 组件使用booleanfalse

Events

事件名说明回调参数
add-cart点击添加购物车回调skuData: object
buy-clicked点击购买回调skuData: object
stepper-change购买数量变化时触发value: number
sku-selected切换规格类目时触发{ skuValue, selectedSku, selectedSkuComb }
sku-prop-selected切换商品属性时触发{ propValue, selectedProp, selectedSkuComb }
open-preview打开商品图片预览时触发data: object
close-preview关闭商品图片预览时触发data: object
sku-reset v2.8.1规格和属性被重置时触发{ selectedSku, selectedProp, selectedSkuComb }

方法

通过 ref 可以获取到 Sku 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
getSkuData获取当前 skuData-skuData
resetSelectedSku v2.3.0重置选中规格到初始状态--

Slots

Sku 组件默认划分好了若干区块,这些区块都定义成了插槽,可以按需进行替换。区块顺序见下表:

名称说明
sku-header商品信息展示区,包含商品图片、名称、价格等信息
sku-header-price自定义 sku 头部价格展示
sku-header-origin-price自定义 sku 头部原价展示
sku-header-extra额外 sku 头部区域
sku-header-image-extra v2.5.2自定义 sku 头部图片额外的展示
sku-body-topsku 展示区上方的内容,无默认展示内容,按需使用
sku-group商品 sku 展示区
extra-sku-group额外商品 sku 展示区,一般用不到
sku-stepper商品数量选择区
sku-messages商品留言区
sku-actions-top v2.4.7操作按钮区顶部内容,无默认展示内容,按需使用
sku-actions操作按钮区

sku 对象结构

  1. sku: {
  2. // 所有sku规格类目与其值的从属关系,比如商品有颜色和尺码两大类规格,颜色下面又有红色和蓝色两个规格值。
  3. // 可以理解为一个商品可以有多个规格类目,一个规格类目下可以有多个规格值。
  4. tree: [
  5. {
  6. k: '颜色', // skuKeyName:规格类目名称
  7. k_s: 's1', // skuKeyStr:sku 组合列表(下方 list)中当前类目对应的 key 值,value 值会是从属于当前类目的一个规格值 id
  8. v: [
  9. {
  10. id: '1', // skuValueId:规格值 id
  11. name: '红色', // skuValueName:规格值名称
  12. imgUrl: 'https://img.yzcdn.cn/1.jpg', // 规格类目图片,只有第一个规格类目可以定义图片
  13. previewImgUrl: 'https://img.yzcdn.cn/1p.jpg', // 用于预览显示的规格类目图片
  14. },
  15. {
  16. id: '1',
  17. name: '蓝色',
  18. imgUrl: 'https://img.yzcdn.cn/2.jpg',
  19. previewImgUrl: 'https://img.yzcdn.cn/2p.jpg',
  20. }
  21. ],
  22. largeImageMode: true, // 是否展示大图模式
  23. }
  24. ],
  25. // 所有 sku 的组合列表,比如红色、M 码为一个 sku 组合,红色、S 码为另一个组合
  26. list: [
  27. {
  28. id: 2259, // skuId
  29. s1: '1', // 规格类目 k_s 为 s1 的对应规格值 id
  30. s2: '1', // 规格类目 k_s 为 s2 的对应规格值 id
  31. price: 100, // 价格(单位分)
  32. stock_num: 110 // 当前 sku 组合对应的库存
  33. }
  34. ],
  35. price: '1.00', // 默认价格(单位元)
  36. stock_num: 227, // 商品总库存
  37. collection_id: 2261, // 无规格商品 skuId 取 collection_id,否则取所选 sku 组合对应的 id
  38. none_sku: false, // 是否无规格商品
  39. messages: [
  40. {
  41. // 商品留言
  42. datetime: '0', // 留言类型为 time 时,是否含日期。'1' 表示包含
  43. multiple: '0', // 留言类型为 text 时,是否多行文本。'1' 表示多行
  44. name: '留言', // 留言名称
  45. type: 'text', // 留言类型,可选: id_no(身份证), text, tel, date, time, email
  46. required: '1', // 是否必填 '1' 表示必填
  47. placeholder: '' // 可选值,占位文本
  48. }
  49. ],
  50. hide_stock: false // 是否隐藏剩余库存
  51. }

properties 对象结构

  1. [
  2. // 商品属性
  3. {
  4. k_id: 123, // 属性id
  5. k: '加料', // 属性名
  6. is_multiple: true, // 是否可多选
  7. v: [
  8. {
  9. id: 1222, // 属性值id
  10. name: '珍珠', // 属性值名
  11. price: 1, // 属性值加价
  12. },
  13. {
  14. id: 1223,
  15. name: '椰果',
  16. price: 1,
  17. },
  18. ],
  19. },
  20. ];

initialSku 对象结构

  1. {
  2. // 键:skuKeyStr(sku 组合列表中当前类目对应的 key 值)
  3. // 值:skuValueId(规格值 id)
  4. s1: '1',
  5. s2: '1',
  6. // 初始选中数量
  7. selectedNum: 3,
  8. // 初始选中的商品属性
  9. // 键:属性id
  10. // 值:属性值id列表
  11. selectedProp: {
  12. 123: [1222]
  13. }
  14. }

goods 对象结构

  1. goods: {
  2. // 默认商品 sku 缩略图
  3. picture: 'https://img.yzcdn.cn/1.jpg';
  4. }

customStepperConfig 对象结构

  1. customStepperConfig: {
  2. // 自定义限购文案
  3. quotaText: '每次限购xxx件',
  4. // 自定义步进器超过限制时的回调
  5. handleOverLimit: (data) => {
  6. const { action, limitType, quota, quotaUsed, startSaleNum } = data;
  7. if (action === 'minus') {
  8. Toast(startSaleNum > 1 ? `${startSaleNum}件起售` : '至少选择一件商品');
  9. } else if (action === 'plus') {
  10. // const { LIMIT_TYPE } = Sku.skuConstants;
  11. if (limitType === LIMIT_TYPE.QUOTA_LIMIT) {
  12. let msg = `单次限购${quota}件`;
  13. if (quotaUsed > 0) msg += `,你已购买${quotaUsed}`;
  14. Toast(msg);
  15. } else {
  16. Toast('库存不够了');
  17. }
  18. }
  19. },
  20. // 步进器变化的回调
  21. handleStepperChange: currentValue => {},
  22. // 库存
  23. stockNum: 1999,
  24. // 格式化库存
  25. stockFormatter: stockNum => {},
  26. }

messageConfig 对象结构

  1. messageConfig: {
  2. // 图片上传回调,需要返回一个promise,promise正确执行的结果需要是一个图片url
  3. uploadImg: () => {
  4. return new Promise((resolve) => {
  5. setTimeout(() => resolve('https://img.yzcdn.cn/upload_files/2017/02/21/FjKTOxjVgnUuPmHJRdunvYky9OHP.jpg!100x100.jpg'), 1000);
  6. });
  7. },
  8. // 最大上传体积 (MB)
  9. uploadMaxSize: 3,
  10. // placeholder 配置
  11. placeholderMap: {
  12. text: 'xxx',
  13. tel: 'xxx',
  14. ...
  15. },
  16. // 初始留言信息
  17. // 键:留言 name
  18. // 值:留言内容
  19. initialMessages: {
  20. 留言: '留言信息'
  21. }
  22. }

添加购物车和点击购买回调函数接收的 skuData 对象结构

  1. skuData: {
  2. // 商品 id
  3. goodsId: '946755',
  4. // 留言信息
  5. messages: {
  6. message_0: '12',
  7. message_1: ''
  8. },
  9. // 另一种格式的留言,key 不同
  10. cartMessages: {
  11. '留言1': 'xxxx'
  12. },
  13. // 选择的商品数量
  14. selectedNum: 1,
  15. // 选择的 sku 组合
  16. selectedSkuComb: {
  17. id: 2257,
  18. price: 100,
  19. s1: '30349',
  20. s2: '1193',
  21. s3: '0',
  22. stock_num: 111,
  23. properties: [
  24. {
  25. k_id: 123,
  26. k: '加料',
  27. is_multiple: true,
  28. v: [
  29. {
  30. id: 1223,
  31. name: '椰果',
  32. price: 1
  33. }
  34. ]
  35. }
  36. ],
  37. property_price: 1
  38. },
  39. }

样式变量

组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考主题定制

名称默认值描述
@sku-item-background-color@background-color-
@sku-icon-gray-color@gray-4-
@sku-upload-mask-colorrgba(50, 50, 51, 0.8)-

Sku 商品规格 - 图1