ui/vant
1
0
Fork 0
mirror of https://github.com/youzan/vant.git synced 2025-12-18 02:06:02 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[Improvement] Sku: support i18n (#439)

Browse Source
This commit is contained in:
neverland
2017-12-15 15:38:32 +08:00
committed by GitHub
parent 2db9b12816
commit f43b496333
13 changed files with 846 additions and 507 deletions
Download Patch File Download Diff File Expand all files Collapse all files

191
docs/markdown/en-US/sku.md
View File

@@ -26,12 +26,12 @@ Vue.use(Sku);
/>
```
#### 自定义 sku slot 区块
#### Advanced Usage
```html
<van-sku
v-model="showCustomAction"
stepperTitle="我要买"
stepperTitle="Stepper title"
:sku="sku"
:goods="goods"
:goodsId="goodsId"
@@ -44,14 +44,14 @@ Vue.use(Sku);
@buy-clicked="handleBuyClicked"
@add-cart="handleAddCartClicked"
>
<!-- 隐藏sku messages -->
<!-- hide sku messages -->
<template slot="sku-messages"></template>
<!-- 自定义sku actions -->
<!-- custom sku actions -->
<template slot="sku-actions" slot-scope="props">
<div class="van-sku-actions">
<van-button bottomAction @click="handlePointClicked">积分兑换</van-button>
<!-- 直接触发sku内部事件，通过内部事件执行handleBuyClicked回调 -->
<van-button type="primary" bottomAction @click="props.skuEventBus.$emit('sku:buy')">买买买</van-button>
<van-button bottomAction @click="handlePointClicked">Button</van-button>
<!-- trigger sku inner event -->
<van-button type="primary" bottomAction @click="props.skuEventBus.$emit('sku:buy')">Button</van-button>
</div>
</template>
</van-sku>
@@ -59,113 +59,116 @@ Vue.use(Sku);
### API
| Attribute | Description | Type | Default | 必须 |
| Attribute | Description | Type | Default | Accepted Values |
|-----------|-----------|-----------|-------------|-------------|
| v-model | 是否显示sku | Boolean | false | 是 |
| sku | 商品sku数据 | Object | - | 是 |
| goods | 商品信息 | Object | - | 是 |
| goodsId | 商品id | String/Number | - | 是 |
| hideStock | 是否显示商品剩余库存 | Boolean | false | 否 |
| showAddCartBtn | 是否显示加入购物车按钮 | Boolean | true | 否 |
| quota | 限购数(0表示不限购) | Number | 0 | 否 |
| quotaUsed | 已经购买过的数量 | Number | 0 | 否 |
| resetStepperOnHide | 窗口隐藏时重置选择的商品数量 | Boolean | false | 否 |
| disableStepperInput | 是否禁用sku中stepper的input框 | Boolean | false | 否 |
| stepperTitle | 数量选择组件左侧文案 | String | '购买数量' | 否 |
| add-cart | 点击添加购物车回调 | Function(skuData: Object) | - | 否 |
| buy-clicked | 点击购买回调 | Function(skuData: Object) | - | 否 |
| v-model | Whether to show sku | `Boolean` | `false` | - |
| sku | Sku data | `Object` | - | - |
| goods | Goods info | `Object` | - | - |
| goodsId | Goods id | `String | Number` | - | - |
| hideStock | Whether to hide stock | `Boolean` | `false` | - |
| showAddCartBtn | Whether to show cart button | `Boolean` | `true` | - |
| quota | Quota (0 as no limit) | `Number` | `0` | - |
| quotaUsed | Used quota | `Number` | `0` | - |
| resetStepperOnHide | Whether to reset stepper when hide | `Boolean` | `false` | - |
| disableStepperInput | Whether to disable stepper input | `Boolean` | `false` | - |
| stepperTitle | Quantity title | `String` | `Quantity` | - |
### slots
sku组件默认划分好了若干区块，这些区块都定义成了slot，可以按需进行替换。区块顺序见下表：
### Event
| Event | Description | Attribute |
|-----------|-----------|-----------|
| add-cart | Triggered when click cart button | data: Object |
| buy-clicked | Triggered when click buy button | data: Object |
### Slot
| Name | Description |
|-----------|-----------|
| sku-header | 商品信息展示区，包含商品图片、名称、价格等信息 |
| sku-group | 商品sku展示区 |
| extra-sku-group | 额外商品sku展示区，一般用不到 |
| sku-stepper | 商品数量选择区 |
| sku-messages | 商品留言区 |
| sku-actions | 操作按钮区 |
| sku-header | Custom header |
| sku-group | Custom sku |
| extra-sku-group | Extra custom content |
| sku-stepper | Custom stepper |
| sku-messages | Custom messages |
| sku-actions | Custom button actions |
#### Data Structure
#### sku对象结构
#### Sku Data Structure
```javascript
"sku": {
// 所有sku规格类目与其值的从属关系，比如商品有颜色和尺码两大类规格，颜色下面又有红色和蓝色两个规格值。
// 可以理解为一个商品可以有多个规格类目，一个规格类目下可以有多个规格值。
"tree": [{
"k": "颜色", // skuKeyName：规格类目名称
"v": [{
"id": "30349", // skuValueId：规格值id
"name": "红色", // skuValueName：规格值名称
"imgUrl": "https:\/\/img.yzcdn.cn\/upload_files\/2017\/02\/21\/FjKTOxjVgnUuPmHJRdunvYky9OHP.jpg" // 规格类目图片，只有第一个规格类目可以定义图片
}, {
"id": "1215",
"name": "蓝色",
"imgUrl": "https:\/\/img.yzcdn.cn\/upload_files\/2017\/03\/16\/Fs_OMbSFPa183sBwvG_94llUYiLa.jpeg"
}],
"k_s": "s1" // skuKeyStr：sku组合列表（下方list）中当前类目对应的key值，value值会是从属于当前类目的一个规格值id
}, ...],
// 所有sku的组合列表，比如红色、M码为一个sku组合，红色、S码为另一个组合
"list": [{
"id": 2259, // skuId，下单时后端需要
"price": 100, // 价格（单位分）
"s1": "1215", // 规格类目k_s为s1的对应规格值id
"s2": "1193", // 规格类目k_s为s2的对应规格值id
"s3": "0", // 最多包含3个规格值，为0表示不存在该规格
"stock_num": 110 // 当前sku组合对应的库存
}, ...],
"price": "1.00", // 默认价格（单位元）后端单位暂时有点不统一
"stock_num": 227, // 商品总库存
"collection_id": 2261, // 无规格商品skuId取collection_id，否则取所选sku组合对应的id
"none_sku": false, // 是否无规格商品
"messages": [{ // 商品留言
"datetime": "0", // 留言类型为time时，是否含日期。“1”表示包含
"multiple": "0", // 留言类型为text时，是否多行文本。“1”表示多行
"name": "留言", // 留言名称
"type": "text", // 留言类型，可选id_no（身份证）, text, tel, date, time, email
"required": "1" // 是否必填 “1”表示必填
}, ...],
"hide_stock": false // 是否隐藏剩余库存
},
sku: {
tree: [
{
k: 'Color',
v: [
{
id: '30349',
name: 'Red',
imgUrl: 'https://img.yzcdn.cn/1.jpg'
},
{
id: '1215',
name: 'Blue',
imgUrl: 'https://img.yzcdn.cn/2.jpg'
}
],
k_s: 's1'
}
],
list: [
{
id: 2259,
price: 100,
s1: '1215',
s2: '1193',
s3: '0',
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'
}
],
hide_stock: false
}
```
#### goods对象结构
#### Goods Data Structure
```javascript
"goods": {
// 商品标题
"title": "测试商品",
// 默认商品sku缩略图
"picture": "https:\/\/img.yzcdn.cn\/upload_files\/2017\/03\/16\/Fs_OMbSFPa183sBwvG_94llUYiLa.jpeg?imageView2\/2\/w\/100\/h\/100\/q\/75\/format\/webp"
},
goods: {
title: 'Title',
picture: 'https://img.yzcdn.cn/1.jpg'
}
```
#### 添加购物车和点击购买回调函数接收的skuData对象结构
#### Event Params Data Structure
```javascript
skuData: {
// 商品id
goodsId:"946755",
// 留言信息
goodsId: '946755',
messages: {
message_0:"12",
message_1:"",
... // 有几个留言就有几条
message_0: '12',
message_1: ''
},
// 另一种格式的留言，key不同
cartMessages: {
'留言1': 'xxxx',
... // key是message的name
'Message 1': 'xxxx'
},
// 选择的商品数量
selectedNum:1,
// 选择的sku组合
selectedNum: 1,
selectedSkuComb: {
id:2257,
price:100,
s1:"30349",
s2:"1193",
s3:"0",
stock_num:111
id: 2257,
price: 100,
s1: '30349',
s2: '1193',
s3: '0',
stock_num: 111
}
}
```

180
docs/markdown/zh-CN/sku.md
View File

@@ -26,7 +26,7 @@ Vue.use(Sku);
/>
```
#### 自定义 sku slot 区块
#### 高级用法
```html
<van-sku
@@ -44,13 +44,13 @@ Vue.use(Sku);
@buy-clicked="handleBuyClicked"
@add-cart="handleAddCartClicked"
>
<!-- 隐藏sku messages -->
<!-- 隐藏 sku messages -->
<template slot="sku-messages"></template>
<!-- 自定义sku actions -->
<!-- 自定义 sku actions -->
<template slot="sku-actions" slot-scope="props">
<div class="van-sku-actions">
<van-button bottomAction @click="handlePointClicked">积分兑换</van-button>
<!-- 直接触发sku内部事件，通过内部事件执行handleBuyClicked回调 -->
<!-- 直接触发 sku 内部事件，通过内部事件执行 handleBuyClicked 回调 -->
<van-button type="primary" bottomAction @click="props.skuEventBus.$emit('sku:buy')">买买买</van-button>
</div>
</template>
@@ -60,26 +60,32 @@ Vue.use(Sku);
### API
| 参数 | 说明 | 类型 | 默认值 | 必须 |
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|-----------|-----------|-----------|-------------|-------------|
| v-model | 是否显示sku | Boolean | false | 是 |
| sku | 商品sku数据 | Object | - | 是 |
| goods | 商品信息 | Object | - | 是 |
| goodsId | 商品id | String/Number | - | 是 |
| hideStock | 是否显示商品剩余库存 | Boolean | false | 否 |
| showAddCartBtn | 是否显示加入购物车按钮 | Boolean | true | 否 |
| quota | 限购数(0表示不限购) | Number | 0 | 否 |
| quotaUsed | 已经购买过的数量 | Number | 0 | 否 |
| resetStepperOnHide | 窗口隐藏时重置选择的商品数量 | Boolean | false | 否 |
| disableStepperInput | 是否禁用sku中stepper的input框 | Boolean | false | 否 |
| stepperTitle | 数量选择组件左侧文案 | String | '购买数量' | 否 |
| add-cart | 点击添加购物车回调 | Function(skuData: Object) | - | 否 |
| buy-clicked | 点击购买回调 | Function(skuData: Object) | - | 否 |
| v-model | 是否显示sku | `Boolean` | `false` | - |
| sku | 商品sku数据 | `Object` | - | - |
| goods | 商品信息 | `Object` | - | - |
| goodsId | 商品id | `String | Number` | - | - |
| hideStock | 是否显示商品剩余库存 | `Boolean` | `false` | - |
| showAddCartBtn | 是否显示加入购物车按钮 | `Boolean` | `true` | - |
| quota | 限购数(0表示不限购) | `Number` | `0` | - |
| quotaUsed | 已经购买过的数量 | `Number` | `0` | - |
| resetStepperOnHide | 窗口隐藏时重置选择的商品数量 | `Boolean` | `false` | - |
| disableStepperInput | 是否禁用sku中stepper的input框 | `Boolean` | `false` | - |
| stepperTitle | 数量选择组件左侧文案 | `String` | `购买数量` | - |
### slots
sku组件默认划分好了若干区块，这些区块都定义成了slot，可以按需进行替换。区块顺序见下表：
### Event
| Name | 说明 |
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|
| add-cart | 点击添加购物车回调 | skuData: Object |
| buy-clicked | 点击购买回调 | skuData: Object |
### Slot
Sku 组件默认划分好了若干区块，这些区块都定义成了 slot，可以按需进行替换。区块顺序见下表：
| 名称 | 说明 |
|-----------|-----------|
| sku-header | 商品信息展示区，包含商品图片、名称、价格等信息 |
| sku-group | 商品sku展示区 |
@@ -91,82 +97,90 @@ sku组件默认划分好了若干区块，这些区块都定义成了slot，可
### 数据结构
#### sku对象结构
```javascript
"sku": {
// 所有sku规格类目与其值的从属关系，比如商品有颜色和尺码两大类规格，颜色下面又有红色和蓝色两个规格值。
// 可以理解为一个商品可以有多个规格类目，一个规格类目下可以有多个规格值。
"tree": [{
"k": "颜色", // skuKeyName：规格类目名称
"v": [{
"id": "30349", // skuValueId：规格值id
"name": "红色", // skuValueName：规格值名称
"imgUrl": "https:\/\/img.yzcdn.cn\/upload_files\/2017\/02\/21\/FjKTOxjVgnUuPmHJRdunvYky9OHP.jpg" // 规格类目图片，只有第一个规格类目可以定义图片
}, {
"id": "1215",
"name": "蓝色",
"imgUrl": "https:\/\/img.yzcdn.cn\/upload_files\/2017\/03\/16\/Fs_OMbSFPa183sBwvG_94llUYiLa.jpeg"
}],
"k_s": "s1" // skuKeyStr：sku组合列表（下方list）中当前类目对应的key值，value值会是从属于当前类目的一个规格值id
}, ...],
// 所有sku的组合列表，比如红色、M码为一个sku组合，红色、S码为另一个组合
"list": [{
"id": 2259, // skuId，下单时后端需要
"price": 100, // 价格（单位分）
"s1": "1215", // 规格类目k_s为s1的对应规格值id
"s2": "1193", // 规格类目k_s为s2的对应规格值id
"s3": "0", // 最多包含3个规格值，为0表示不存在该规格
"stock_num": 110 // 当前sku组合对应的库存
}, ...],
"price": "1.00", // 默认价格（单位元）后端单位暂时有点不统一
"stock_num": 227, // 商品总库存
"collection_id": 2261, // 无规格商品skuId取collection_id，否则取所选sku组合对应的id
"none_sku": false, // 是否无规格商品
"messages": [{ // 商品留言
"datetime": "0", // 留言类型为time时，是否含日期。“1”表示包含
"multiple": "0", // 留言类型为text时，是否多行文本。“1”表示多行
"name": "留言", // 留言名称
"type": "text", // 留言类型，可选id_no（身份证）, text, tel, date, time, email
"required": "1" // 是否必填 “1”表示必填
}, ...],
"hide_stock": false // 是否隐藏剩余库存
},
sku: {
// 所有sku规格类目与其值的从属关系，比如商品有颜色和尺码两大类规格，颜色下面又有红色和蓝色两个规格值。
// 可以理解为一个商品可以有多个规格类目，一个规格类目下可以有多个规格值。
tree: [
{
k: '颜色', // skuKeyName：规格类目名称
v: [
{
id: '30349', // skuValueId：规格值 id
name: '红色', // skuValueName：规格值名称
imgUrl: 'https://img.yzcdn.cn/1.jpg' // 规格类目图片，只有第一个规格类目可以定义图片
},
{
id: '1215',
name: '蓝色',
imgUrl: 'https://img.yzcdn.cn/2.jpg'
}
],
k_s: 's1' // skuKeyStr：sku 组合列表（下方 list）中当前类目对应的 key 值，value 值会是从属于当前类目的一个规格值 id
}
],
// 所有 sku 的组合列表，比如红色、M 码为一个 sku 组合，红色、S 码为另一个组合
list: [
{
id: 2259, // skuId，下单时后端需要
price: 100, // 价格（单位分）
s1: '1215', // 规格类目 k_s 为 s1 的对应规格值 id
s2: '1193', // 规格类目 k_s 为 s2 的对应规格值 id
s3: '0', // 最多包含3个规格值，为0表示不存在该规格
stock_num: 110 // 当前 sku 组合对应的库存
}
],
price: '1.00', // 默认价格（单位元）
stock_num: 227, // 商品总库存
collection_id: 2261, // 无规格商品 skuId 取 collection_id，否则取所选 sku 组合对应的 id
none_sku: false, // 是否无规格商品
messages: [
{
// 商品留言
datetime: '0', // 留言类型为 time 时，是否含日期。'1' 表示包含
multiple: '0', // 留言类型为 text 时，是否多行文本。'1' 表示多行
name: '留言', // 留言名称
type: 'text', // 留言类型，可选: id_no（身份证）, text, tel, date, time, email
required: '1' // 是否必填 '1' 表示必填
}
],
hide_stock: false // 是否隐藏剩余库存
}
```
#### goods对象结构
#### goods 对象结构
```javascript
"goods": {
// 商品标题
"title": "测试商品",
// 默认商品sku缩略图
"picture": "https:\/\/img.yzcdn.cn\/upload_files\/2017\/03\/16\/Fs_OMbSFPa183sBwvG_94llUYiLa.jpeg?imageView2\/2\/w\/100\/h\/100\/q\/75\/format\/webp"
},
goods: {
// 商品标题
title: '测试商品',
// 默认商品 sku 缩略图
picture: 'https://img.yzcdn.cn/1.jpg'
}
```
#### 添加购物车和点击购买回调函数接收的skuData对象结构
#### 添加购物车和点击购买回调函数接收的 skuData 对象结构
```javascript
skuData: {
// 商品id
goodsId:"946755",
// 商品 id
goodsId: '946755',
// 留言信息
messages: {
message_0:"12",
message_1:"",
... // 有几个留言就有几条
message_0: '12',
message_1: ''
},
// 另一种格式的留言，key不同
// 另一种格式的留言，key 不同
cartMessages: {
'留言1': 'xxxx',
... // key是message的name
'留言1': 'xxxx'
},
// 选择的商品数量
selectedNum:1,
// 选择的sku组合
selectedNum: 1,
// 选择的 sku 组合
selectedSkuComb: {
id:2257,
price:100,
s1:"30349",
s2:"1193",
s3:"0",
stock_num:111
id: 2257,
price: 100,
s1: '30349',
s2: '1193',
s3: '0',
stock_num: 111
}
}
```