[Doc] Sku: add sku-selected event document (#2386)

This commit is contained in:
neverland 2018-12-26 20:17:48 +08:00 committed by GitHub
parent 5a7f1ad411
commit 007319d9b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 5 deletions

View File

@ -110,7 +110,7 @@ Vue.use(Sku);
| add-cart | Triggered when click cart button | data: Object | | add-cart | Triggered when click cart button | data: Object |
| buy-clicked | Triggered when click buy button | data: Object | | buy-clicked | Triggered when click buy button | data: Object |
| stepper-change | Triggered when stepper value changed | value: number | | stepper-change | Triggered when stepper value changed | value: number |
| sku-selected | Triggered when select sku | { skuValue, selectedSku, selectedSkuComb } |
### Methods ### Methods
@ -134,7 +134,9 @@ Use ref to get sku instance and call instance methods
| sku-actions | Custom button actions | | sku-actions | Custom button actions |
#### Data Structure #### Data Structure
#### Sku Data Structure #### Sku Data Structure
```javascript ```javascript
sku: { sku: {
tree: [ tree: [
@ -193,6 +195,7 @@ goods: {
#### customStepperConfig Data Structure #### customStepperConfig Data Structure
```javascript ```javascript
customStepperConfig: { customStepperConfig: {
// custom quota text // custom quota text
@ -218,6 +221,7 @@ customStepperConfig: {
``` ```
#### messageConfig Data Structure #### messageConfig Data Structure
```javascript ```javascript
messageConfig: { messageConfig: {
// the upload image callback // the upload image callback

View File

@ -110,6 +110,7 @@ Vue.use(Sku);
| add-cart | 点击添加购物车回调 | skuData: Object | | add-cart | 点击添加购物车回调 | skuData: Object |
| buy-clicked | 点击购买回调 | skuData: Object | | buy-clicked | 点击购买回调 | skuData: Object |
| stepper-change | 购买数量变化时触发 | value: number | | stepper-change | 购买数量变化时触发 | value: number |
| sku-selected | 切换规格类目时触发 | { skuValue, selectedSku, selectedSkuComb } |
### 方法 ### 方法
@ -126,16 +127,18 @@ Sku 组件默认划分好了若干区块,这些区块都定义成了插槽,
| 名称 | 说明 | | 名称 | 说明 |
|------|------| |------|------|
| sku-header | 商品信息展示区,包含商品图片、名称、价格等信息 | | sku-header | 商品信息展示区,包含商品图片、名称、价格等信息 |
| sku-header-price | 自定义sku头部价格展示 | | sku-header-price | 自定义 sku 头部价格展示 |
| sku-body-top | sku展示区上方的slot,无默认展示内容,按需使用 | | sku-body-top | sku 展示区上方的内容,无默认展示内容,按需使用 |
| sku-group | 商品sku展示区 | | sku-group | 商品 sku 展示区 |
| extra-sku-group | 额外商品sku展示区一般用不到 | | extra-sku-group | 额外商品 sku 展示区,一般用不到 |
| sku-stepper | 商品数量选择区 | | sku-stepper | 商品数量选择区 |
| sku-messages | 商品留言区 | | sku-messages | 商品留言区 |
| sku-actions | 操作按钮区 | | sku-actions | 操作按钮区 |
### 数据结构 ### 数据结构
#### sku对象结构 #### sku对象结构
```javascript ```javascript
sku: { sku: {
// 所有sku规格类目与其值的从属关系比如商品有颜色和尺码两大类规格颜色下面又有红色和蓝色两个规格值。 // 所有sku规格类目与其值的从属关系比如商品有颜色和尺码两大类规格颜色下面又有红色和蓝色两个规格值。
@ -188,6 +191,7 @@ sku: {
``` ```
#### goods 对象结构 #### goods 对象结构
```javascript ```javascript
goods: { goods: {
// 商品标题 // 商品标题
@ -198,6 +202,7 @@ goods: {
``` ```
#### customStepperConfig 对象结构 #### customStepperConfig 对象结构
```javascript ```javascript
customStepperConfig: { customStepperConfig: {
// 自定义限购文案 // 自定义限购文案
@ -223,6 +228,7 @@ customStepperConfig: {
``` ```
#### messageConfig Data Structure #### messageConfig Data Structure
```javascript ```javascript
messageConfig: { messageConfig: {
// 图片上传回调需要返回一个promisepromise正确执行的结果需要是一个图片url // 图片上传回调需要返回一个promisepromise正确执行的结果需要是一个图片url
@ -243,6 +249,7 @@ messageConfig: {
``` ```
#### 添加购物车和点击购买回调函数接收的 skuData 对象结构 #### 添加购物车和点击购买回调函数接收的 skuData 对象结构
```javascript ```javascript
skuData: { skuData: {
// 商品 id // 商品 id