[Doc] add some english documents (#220)

* [bugfix] Checkbox border render error in weixin browser

* [bugfix] TreeSelect dependency path error

* [bugfix] Swipe should clear autoplay timer when destroyed
This commit is contained in:
neverland
2017-10-18 07:14:25 -05:00
committed by GitHub
parent 10ab0e52c4
commit 14de879a3b
48 changed files with 4710 additions and 176 deletions

View File

@@ -1,6 +1,6 @@
/* eslint-disable */
module.exports = {
"zh-CN": {
'zh-CN': {
header: {
Github: 'https://github.com/youzan/vant',
English: '#/en-US/'
@@ -8,30 +8,31 @@ module.exports = {
footer: {
github: 'https://github.com/youzan/vant',
nav: {
'React': 'https://www.youzanyun.com/zanui/react',
'微信小程序': 'https://github.com/youzan/zanui-weapp',
'意见反馈': 'https://github.com/youzan/vant/issues',
'开发指南': 'https://github.com/youzan/vant/blob/dev/docs/examples-docs/zh-CN/contribute.md'
React: 'https://www.youzanyun.com/zanui/react',
微信小程序: 'https://github.com/youzan/zanui-weapp',
意见反馈: 'https://github.com/youzan/vant/issues',
开发指南:
'https://github.com/youzan/vant/blob/dev/docs/examples-docs/zh-CN/contribute.md'
}
},
nav: [
{
"name": "开发指南",
"groups": [
name: '开发指南',
groups: [
{
"list": [
list: [
{
"path": "/quickstart",
"title": "快速上手",
path: '/quickstart',
title: '快速上手',
noExample: true
},
{
"title": "业务组件",
"link": "/zanui/captain/component/quickstart"
title: '业务组件',
link: '/zanui/captain/component/quickstart'
},
{
"path": "/changelog",
"title": "更新日志",
path: '/changelog',
title: '更新日志',
noExample: true
}
]
@@ -39,215 +40,215 @@ module.exports = {
]
},
{
"name": "组件",
"showInMobile": true,
"groups": [
name: '组件',
showInMobile: true,
groups: [
{
"groupName": "基础组件",
"list": [
groupName: '基础组件',
list: [
{
"path": "/layout",
"title": "Layout - 布局"
path: '/layout',
title: 'Layout - 布局'
},
{
"path": "/badge",
"title": "Badge - 徽章"
path: '/badge',
title: 'Badge - 徽章'
},
{
"path": "/button",
"title": "Button - 按钮"
path: '/button',
title: 'Button - 按钮'
},
{
"path": "/card",
"title": "Card - 卡片"
path: '/card',
title: 'Card - 卡片'
},
{
"path": "/cell",
"title": "Cell - 单元格"
path: '/cell',
title: 'Cell - 单元格'
},
{
"path": "/icon",
"title": "Icon - 图标"
path: '/icon',
title: 'Icon - 图标'
},
{
"path": "/image-preview",
"title": "ImagePreview - 图片预览"
path: '/image-preview',
title: 'ImagePreview - 图片预览'
},
{
"path": "/lazyload",
"title": "Lazyload - 图片懒加载"
path: '/lazyload',
title: 'Lazyload - 图片懒加载'
},
{
"path": "/loading",
"title": "Loading - 加载"
path: '/loading',
title: 'Loading - 加载'
},
{
"path": "/nav-bar",
"title": "NavBar - 导航栏"
path: '/nav-bar',
title: 'NavBar - 导航栏'
},
{
"path": "/notice-bar",
"title": "NoticeBar - 通告栏"
path: '/notice-bar',
title: 'NoticeBar - 通告栏'
},
{
"path": "/panel",
"title": "Panel - 面板"
path: '/panel',
title: 'Panel - 面板'
},
{
"path": "/popup",
"title": "Popup - 弹出层"
path: '/popup',
title: 'Popup - 弹出层'
},
{
"path": "/progress",
"title": "Progress - 进度条"
path: '/progress',
title: 'Progress - 进度条'
},
{
"path": "/search",
"title": "Search - 搜索"
path: '/search',
title: 'Search - 搜索'
},
{
"path": "/stepper",
"title": "Stepper - 步进器"
path: '/stepper',
title: 'Stepper - 步进器'
},
{
"path": "/steps",
"title": "Steps - 步骤条"
path: '/steps',
title: 'Steps - 步骤条'
},
{
"path": "/swipe",
"title": "Swipe - 轮播"
path: '/swipe',
title: 'Swipe - 轮播'
},
{
"path": "/tab",
"title": "Tab - 标签页"
path: '/tab',
title: 'Tab - 标签页'
},
{
"path": "/tabbar",
"title": "Tabbar - 标签栏"
path: '/tabbar',
title: 'Tabbar - 标签栏'
},
{
"path": "/tag",
"title": "Tag - 标记"
path: '/tag',
title: 'Tag - 标记'
},
{
"path": "/waterfall",
"title": "Waterfall - 瀑布流"
path: '/waterfall',
title: 'Waterfall - 瀑布流'
}
]
},
{
"groupName": "表单",
"list": [
groupName: '表单',
list: [
{
"path": "/checkbox",
"title": "Checkbox - 复选框"
path: '/checkbox',
title: 'Checkbox - 复选框'
},
{
"path": "/field",
"title": "Field - 输入框"
path: '/field',
title: 'Field - 输入框'
},
{
"path": "/number-keyboard",
"title": "NumberKeyboard - 数字键盘"
path: '/number-keyboard',
title: 'NumberKeyboard - 数字键盘'
},
{
"path": "/password-input",
"title": "PasswordInput - 密码输入框"
path: '/password-input',
title: 'PasswordInput - 密码输入框'
},
{
"path": "/radio",
"title": "Radio - 单选框"
path: '/radio',
title: 'Radio - 单选框'
},
{
"path": "/switch",
"title": "Switch - 开关"
path: '/switch',
title: 'Switch - 开关'
},
{
"path": "/uploader",
"title": "Uploader - 图片上传"
path: '/uploader',
title: 'Uploader - 图片上传'
}
]
},
{
"groupName": "操作反馈",
"list": [
groupName: '操作反馈',
list: [
{
"path": "/actionsheet",
"title": "Actionsheet - 行动按钮"
path: '/actionsheet',
title: 'Actionsheet - 行动按钮'
},
{
"path": "/datetime-picker",
"title": "DatetimePicker - 时间选择"
path: '/datetime-picker',
title: 'DatetimePicker - 时间选择'
},
{
"path": "/dialog",
"title": "Dialog - 弹出框"
path: '/dialog',
title: 'Dialog - 弹出框'
},
{
"path": "/picker",
"title": "Picker - 选择器"
path: '/picker',
title: 'Picker - 选择器'
},
{
"path": "/pull-refresh",
"title": "PullRefresh - 下拉刷新"
path: '/pull-refresh',
title: 'PullRefresh - 下拉刷新'
},
{
"path": "/toast",
"title": "Toast - 轻提示"
path: '/toast',
title: 'Toast - 轻提示'
}
]
},
{
"groupName": "高阶组件",
"list": [
groupName: '高阶组件',
list: [
{
"path": "/cell-swipe",
"title": "CellSwipe - 滑动单元格"
path: '/cell-swipe',
title: 'CellSwipe - 滑动单元格'
},
{
"path": "/switch-cell",
"title": "SwitchCell - 开关单元格"
path: '/switch-cell',
title: 'SwitchCell - 开关单元格'
},
{
"path": "/tree-select",
"title": "TreeSelect - 分类选择"
},
path: '/tree-select',
title: 'TreeSelect - 分类选择'
}
]
},
{
"groupName": "业务组件",
"list": [
groupName: '业务组件',
list: [
{
"path": "/address-edit",
"title": "AddressEdit - 地址编辑"
path: '/address-edit',
title: 'AddressEdit - 地址编辑'
},
{
"path": "/address-list",
"title": "AddressList - 地址列表"
path: '/address-list',
title: 'AddressList - 地址列表'
},
{
"path": "/area",
"title": "Area - 省市区选择"
path: '/area',
title: 'Area - 省市区选择'
},
{
"path": "/contact",
"title": "Contact - 联系人"
path: '/contact',
title: 'Contact - 联系人'
},
{
"path": "/coupon",
"title": "Coupon - 优惠券选择器"
path: '/coupon',
title: 'Coupon - 优惠券选择器'
},
{
"path": "/goods-action",
"title": "GoodsAction - 商品页行动点"
path: '/goods-action',
title: 'GoodsAction - 商品页行动点'
},
{
"path": "/submit-bar",
"title": "SubmitBar - 提交订单栏"
path: '/submit-bar',
title: 'SubmitBar - 提交订单栏'
},
{
"path": "/sku",
"title": "Sku - 商品规格弹层"
path: '/sku',
title: 'Sku - 商品规格弹层'
}
]
}
@@ -255,85 +256,256 @@ module.exports = {
}
]
},
"en-US": {
'en-US': {
header: {
Github: 'https://github.com/youzan/vant',
'中文': '#/zh-CN'
中文: '#/zh-CN'
},
footer: {
github: 'https://github.com/youzan/vant',
nav: {
'React': 'https://www.youzanyun.com/zanui/react',
'Weapp': 'https://github.com/youzan/zanui-weapp',
'Feedback': 'https://github.com/youzan/vant/issues',
'Contribute': 'https://github.com/youzan/vant/blob/dev/docs/examples-docs/en-US/contribute.md'
React: 'https://www.youzanyun.com/zanui/react',
Weapp: 'https://github.com/youzan/zanui-weapp',
Feedback: 'https://github.com/youzan/vant/issues',
Contribute:
'https://github.com/youzan/vant/blob/dev/docs/examples-docs/en-US/contribute.md'
}
},
nav: [
{
"name": "Essentials",
"groups": [
name: 'Essentials',
groups: [
{
"list": [
list: [
{
"path": "/quickstart",
"title": "Getting Started",
path: '/quickstart',
title: 'Getting Started',
noExample: true
},
{
"path": "/changelog",
"title": "Changelog",
path: '/changelog',
title: 'Changelog',
noExample: true
}
]
}
]
},
// translation needed
{
"name": "Components",
"showInMobile": true,
"groups": [
name: 'Components',
showInMobile: true,
groups: [
{
"groupName": "Base Components",
"list": [
groupName: 'Basic Components',
list: [
{
"path": "/layout",
"title": "Layout"
path: '/layout',
title: 'Layout'
},
{
path: '/badge',
title: 'Badge'
},
{
path: '/button',
title: 'Button'
},
{
path: '/card',
title: 'Card'
},
{
path: '/cell',
title: 'Cell'
},
{
path: '/icon',
title: 'Icon'
},
{
path: '/image-preview',
title: 'ImagePreview'
},
{
path: '/lazyload',
title: 'Lazyload'
},
{
path: '/loading',
title: 'Loading'
},
{
path: '/nav-bar',
title: 'NavBar'
},
{
path: '/notice-bar',
title: 'NoticeBar'
},
{
path: '/panel',
title: 'Panel'
},
{
path: '/popup',
title: 'Popup'
},
{
path: '/progress',
title: 'Progress'
},
{
path: '/search',
title: 'Search'
},
{
path: '/stepper',
title: 'Stepper'
},
{
path: '/steps',
title: 'Steps'
},
{
path: '/swipe',
title: 'Swipe'
},
{
path: '/tab',
title: 'Tab'
},
{
path: '/tabbar',
title: 'Tabbar'
},
{
path: '/tag',
title: 'Tag'
},
{
path: '/waterfall',
title: 'Waterfall'
}
]
},
{
"groupName": "Form",
"list": [
groupName: 'Form Components',
list: [
{
"path": "/checkbox",
"title": "Checkbox"
path: '/checkbox',
title: 'Checkbox'
},
{
"path": "/field",
"title": "Field"
path: '/field',
title: 'Field'
},
{
"path": "/number-keyboard",
"title": "NumberKeyboard"
path: '/number-keyboard',
title: 'NumberKeyboard'
},
{
"path": "/password-input",
"title": "PasswordInput"
path: '/password-input',
title: 'PasswordInput'
},
{
"path": "/radio",
"title": "Radio"
path: '/radio',
title: 'Radio'
},
{
"path": "/switch",
"title": "Switch"
path: '/switch',
title: 'Switch'
},
{
path: '/uploader',
title: 'Uploader'
}
]
},
{
groupName: 'Action Components',
list: [
{
path: '/actionsheet',
title: 'Actionsheet'
},
{
path: '/datetime-picker',
title: 'DatetimePicker'
},
{
path: '/dialog',
title: 'Dialog'
},
{
path: '/picker',
title: 'Picker'
},
{
path: '/pull-refresh',
title: 'PullRefresh'
},
{
path: '/toast',
title: 'Toast'
}
]
},
{
groupName: 'Advanced Components',
list: [
{
path: '/cell-swipe',
title: 'CellSwipe'
},
{
path: '/switch-cell',
title: 'SwitchCell'
},
{
path: '/tree-select',
title: 'TreeSelect'
}
]
},
{
groupName: 'Business Components',
list: [
{
path: '/address-edit',
title: 'AddressEdit'
},
{
path: '/address-list',
title: 'AddressList'
},
{
path: '/area',
title: 'Area'
},
{
path: '/contact',
title: 'Contact'
},
{
path: '/coupon',
title: 'Coupon'
},
{
path: '/goods-action',
title: 'GoodsAction'
},
{
path: '/submit-bar',
title: 'SubmitBar'
},
{
path: '/sku',
title: 'Sku'
}
]
}
]
}
]
}
}
};