• Sku 商品规格
    • 引入
  • 代码演示
    • 基础用法
    • 自定义步进器
    • 高级用法
  • API
    • Props
    • Events
    • 方法
    • Slots
    • sku 对象结构
    • initialSku 对象结构
    • goods 对象结构
    • customStepperConfig 对象结构
    • messageConfig Data Structure
    • 添加购物车和点击购买回调函数接收的 skuData 对象结构

    Sku 商品规格

    引入

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

    代码演示

    基础用法

    1. <van-sku
    2. v-model="showBase"
    3. :sku="sku"
    4. :goods="goods"
    5. :goods-id="goodsId"
    6. :hide-stock="sku.hide_stock"
    7. :quota="quota"
    8. :quota-used="quotaUsed"
    9. :reset-stepper-on-hide="resetStepperOnHide"
    10. :reset-selected-sku-on-hide="resetSelectedSkuOnHide"
    11. :close-on-click-overlay="closeOnClickOverlay"
    12. :disable-stepper-input="disableStepperInput"
    13. :message-config="messageConfig"
    14. @buy-clicked="onBuyClicked"
    15. @add-cart="onAddCartClicked"
    16. />

    自定义步进器

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

    高级用法

    1. <van-sku
    2. v-model="showCustomAction"
    3. stepper-title="我要买"
    4. :sku="sku"
    5. :goods="goods"
    6. :goods-id="goodsId"
    7. :hide-stock="sku.hide_stock"
    8. :quota="quota"
    9. :quota-used="quotaUsed"
    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 slot="sku-header-price" slot-scope="props">
    18. <div class="van-sku__goods-price">
    19. <span class="van-sku__price-symbol"></span><span class="van-sku__price-num">{{ props.price }}</span>
    20. </div>
    21. </template>
    22. <!-- 自定义 sku actions -->
    23. <template slot="sku-actions" slot-scope="props">
    24. <div class="van-sku-actions">
    25. <van-button
    26. square
    27. size="large"
    28. type="warning"
    29. @click="onPointClicked"
    30. >
    31. 积分兑换
    32. </van-button>
    33. <!-- 直接触发 sku 内部事件,通过内部事件执行 onBuyClicked 回调 -->
    34. <van-button
    35. square
    36. size="large"
    37. type="danger"
    38. @click="props.skuEventBus.$emit('sku:buy')"
    39. >
    40. 买买买
    41. </van-button>
    42. </div>
    43. </template>
    44. </van-sku>

    API

    Props

    参数说明类型默认值版本
    v-model是否显示skuBooleanfalse-
    sku商品sku数据Object--
    goods商品信息Object--
    goods-id商品 idString | Number--
    hide-stock是否显示商品剩余库存Booleanfalse-
    hide-quota-text是否显示限购提示Booleanfalse1.4.8
    show-add-cart-btn是否显示加入购物车按钮Booleantrue-
    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是否在点击遮罩层后关闭Booleanfalse-
    stepper-title数量选择组件左侧文案String购买数量-
    custom-stepper-config步进器相关自定义配置Object{}-
    message-config留言相关配置Object{}-
    get-container指定挂载的节点,可以传入选择器,或一个返回节点的函数String | () => HTMLElement--
    initial-sku默认选中的sku,具体参考高级用法Object{}-
    show-soldout-sku是否展示售罄的sku,如果展示,则为置灰不可选状态,不展示则直接隐藏Booleantrue-

    Events

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

    方法

    通过 ref 可以获取到 sku 实例并调用实例方法

    方法名参数返回值介绍
    getSkuData-skuData获取当前 skuData

    Slots

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

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

    sku 对象结构

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

    initialSku 对象结构

    1. {
    2. // 键:skuKeyStr(sku 组合列表中当前类目对应的 key 值)
    3. // 值:skuValueId(规格值 id)
    4. s1: '30349',
    5. s2: '1193',
    6. // 初始选中数量
    7. selectedNum: 3
    8. }

    goods 对象结构

    1. goods: {
    2. // 商品标题
    3. title: '测试商品',
    4. // 默认商品 sku 缩略图
    5. picture: 'https://img.yzcdn.cn/1.jpg'
    6. }

    customStepperConfig 对象结构

    1. customStepperConfig: {
    2. // 自定义限购文案
    3. quotaText: '每次限购xxx件',
    4. // 自定义步进器超过限制时的回调
    5. handleOverLimit: (data) => {
    6. const { action, limitType, quota, quotaUsed } = data;
    7. if (action === 'minus') {
    8. Toast('至少选择一件商品');
    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. }

    messageConfig Data Structure

    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. // placehold配置
    11. placeholderMap: {
    12. text: 'xxx',
    13. tel: 'xxx',
    14. ...
    15. }
    16. }

    添加购物车和点击购买回调函数接收的 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. }
    24. }

    Sku 商品规格 - 图1