From 007319d9b26178cd042ba8ed944a3d7cb1c33775 Mon Sep 17 00:00:00 2001 From: neverland Date: Wed, 26 Dec 2018 20:17:48 +0800 Subject: [PATCH] [Doc] Sku: add sku-selected event document (#2386) --- packages/sku/en-US.md | 6 +++++- packages/sku/zh-CN.md | 15 +++++++++++---- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/packages/sku/en-US.md b/packages/sku/en-US.md index 3d47f5bd7..ab664a781 100644 --- a/packages/sku/en-US.md +++ b/packages/sku/en-US.md @@ -110,7 +110,7 @@ Vue.use(Sku); | 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 @@ -134,7 +134,9 @@ Use ref to get sku instance and call instance methods | sku-actions | Custom button actions | #### Data Structure + #### Sku Data Structure + ```javascript sku: { tree: [ @@ -193,6 +195,7 @@ goods: { #### customStepperConfig Data Structure + ```javascript customStepperConfig: { // custom quota text @@ -218,6 +221,7 @@ customStepperConfig: { ``` #### messageConfig Data Structure + ```javascript messageConfig: { // the upload image callback diff --git a/packages/sku/zh-CN.md b/packages/sku/zh-CN.md index 39fdfdc8f..2094ddb24 100644 --- a/packages/sku/zh-CN.md +++ b/packages/sku/zh-CN.md @@ -110,6 +110,7 @@ Vue.use(Sku); | add-cart | 点击添加购物车回调 | skuData: Object | | buy-clicked | 点击购买回调 | skuData: Object | | stepper-change | 购买数量变化时触发 | value: number | +| sku-selected | 切换规格类目时触发 | { skuValue, selectedSku, selectedSkuComb } | ### 方法 @@ -126,16 +127,18 @@ Sku 组件默认划分好了若干区块,这些区块都定义成了插槽, | 名称 | 说明 | |------|------| | sku-header | 商品信息展示区,包含商品图片、名称、价格等信息 | -| sku-header-price | 自定义sku头部价格展示 | -| sku-body-top | sku展示区上方的slot,无默认展示内容,按需使用 | -| sku-group | 商品sku展示区 | -| extra-sku-group | 额外商品sku展示区,一般用不到 | +| sku-header-price | 自定义 sku 头部价格展示 | +| sku-body-top | sku 展示区上方的内容,无默认展示内容,按需使用 | +| sku-group | 商品 sku 展示区 | +| extra-sku-group | 额外商品 sku 展示区,一般用不到 | | sku-stepper | 商品数量选择区 | | sku-messages | 商品留言区 | | sku-actions | 操作按钮区 | ### 数据结构 + #### sku对象结构 + ```javascript sku: { // 所有sku规格类目与其值的从属关系,比如商品有颜色和尺码两大类规格,颜色下面又有红色和蓝色两个规格值。 @@ -188,6 +191,7 @@ sku: { ``` #### goods 对象结构 + ```javascript goods: { // 商品标题 @@ -198,6 +202,7 @@ goods: { ``` #### customStepperConfig 对象结构 + ```javascript customStepperConfig: { // 自定义限购文案 @@ -223,6 +228,7 @@ customStepperConfig: { ``` #### messageConfig Data Structure + ```javascript messageConfig: { // 图片上传回调,需要返回一个promise,promise正确执行的结果需要是一个图片url @@ -243,6 +249,7 @@ messageConfig: { ``` #### 添加购物车和点击购买回调函数接收的 skuData 对象结构 + ```javascript skuData: { // 商品 id