Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
0xjoanne committed Oct 12, 2017
1 parent 167e010 commit 8e7e2f4
Show file tree
Hide file tree
Showing 18 changed files with 183 additions and 71 deletions.
5 changes: 4 additions & 1 deletion src/components/checklist/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,10 @@ export default {
type: Boolean,
default: true
},
labelPosition: String,
labelPosition: {
type: String,
default: 'right'
},
disabled: Boolean
},
data () {
Expand Down
5 changes: 3 additions & 2 deletions src/components/checklist/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@ props:
label-position:
version: v2.2.1-rc.4
type: String
en: label position, can be set to left
zh-CN: label 位置,可以设置为 left
default: right
en: label position, can be set to left or right
zh-CN: label 位置,可以设置为 left 或者 right
disabled:
version: v2.3.8
en: if disable user from selecting
Expand Down
8 changes: 6 additions & 2 deletions src/components/clocker/clocker.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,13 @@ function strftime (offsetObject) {
.replace('%_M2', offsetObject.minutes_2)
.replace('%_S1', offsetObject.seconds_1)
.replace('%_S2', offsetObject.seconds_2)
.replace('%_S3', offsetObject.seconds_3)
.replace('%_H1', offsetObject.hours_1)
.replace('%_H2', offsetObject.hours_2)
.replace('%_H3', offsetObject.hours_3)
.replace('%_D1', offsetObject.days_1)
.replace('%_D2', offsetObject.days_2)
.replace('%_D3', offsetObject.days_3)
format = format.replace(/%%/, '%')
return format
}
Expand Down Expand Up @@ -209,8 +212,9 @@ var fns = {
for (var i = 0; i < list.length; i++) {
var key = list[i]
var numbers = splitNumber(this.offset[key])
this.offset[key + '_1'] = numbers[0]
this.offset[key + '_2'] = numbers[1]
for (let n = 0; n < numbers.length; n++) {
this.offset[`${key}_${n + 1}`] = numbers[n]
}
}
// Dispatch an event
if (this.totalSecsLeft === 0) {
Expand Down
16 changes: 15 additions & 1 deletion src/components/clocker/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,20 @@
<script>
import Clocker from './clocker'
let format = '%D 天 %H 小时 %M 分 %S 秒'
if (typeof V_LOCALE === 'undefined') {
if (process.env.NODE_ENV === 'development') {
console.warn('[VUX warn] 抱歉,clocker 组件需要升级 vux-loader 到最新版本才能正常使用')
}
} else {
if (V_LOCALE === 'en') { // eslint-disable-line
format = '%D d %H h %M m %S s'
} else if (V_LOCALE === 'zh-CN') { // eslint-disable-line
format = '%D 天 %H 小时 %M 分 %S 秒'
}
}
export default {
name: 'clocker',
mounted () {
Expand Down Expand Up @@ -49,7 +63,7 @@ export default {
time: [String, Number],
format: {
type: String,
default: '%D 天 %H 小时 %M 分 %S 秒'
default: format
}
},
watch: {
Expand Down
4 changes: 2 additions & 2 deletions src/components/countup/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ props:
duration:
type: Number
default: 2
en: how long to complete
zh-CN: 耗时
en: duration value (second)
zh-CN: 耗时(秒)
options:
type: 'Object'
en: options for `countup.js`
Expand Down
6 changes: 3 additions & 3 deletions src/components/datetime-range/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ props:
en: label text
zh-CN: 标题文字
value:
type: String
type: Array
default: ''
en: form's value, use `v-model` for binding
zh-CN: 表单值,`v-model`绑定
en: "form's value, use `v-model` for binding. For example, ['2017-01-15', '03', '05']"
zh-CN: "表单值,`v-model`绑定。比如,['2017-01-15', '03', '05']"
inline-desc:
type: String
default: ''
Expand Down
3 changes: 3 additions & 0 deletions src/components/datetime/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,9 @@ props:
en: 'dynamically set days list, params `({year, month, min, max}, generateRange)`'
zh-CN: '动态设置日期列表,参数为 `({year, month, min, max}, generateRange)`'
slots:
default:
en: trigger element content
zh-CN: 触发元素内容
title:
version: v2.3.6
en: title slot
Expand Down
20 changes: 17 additions & 3 deletions src/components/flexbox/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,40 @@ flexbox:
gutter:
type: Number
default: 8
zh-CN: 间隙像素大小
en: gap size (px)
zh-CN: 间隙像素大小(px)
orient:
type: String
default: horizontal
en: "can be in ['horizontal', 'vertical']"
zh-CN: "排布方向,可选['horizontal', 'vertical']"
justify:
zh-CN: '`flex`的 `justify-content`属性'
en: '`justify-content` in `flex`'
zh-CN: '`flex`的`justify-content`属性'
align:
en: '`align-items` in `flex`'
zh-CN: '`flex`的`align-items`属性'
wrap:
en: '`flex-wrap` in `flex`'
zh-CN: '`flex`的`flex-wrap`属性'
direction:
en: '`flex-direction` in `flex`'
zh-CN: '`flex`的`flex-direction`属性'
slots:
default:
en: 'content slot for `flexbox-item`'
zh-CN: '`flexbox-item`的内容插槽'
flexbox-item:
props:
span:
type: Number
zh-CN: 占用宽度,如果不设,所有flexbox-item将平分
en: occupied width. If not set, all flexbox-item will get the same width.
zh-CN: 占用宽度,如果不设置,所有flexbox-item将平分
order:
type: String
en: '`order` in `flex`'
zh-CN: '`flex`的`order`属性'
slots:
default:
en: content slot
zh-CN: '内容插槽'
46 changes: 45 additions & 1 deletion src/components/flow/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,57 @@ items:
- flow-line
flow:
props:
orientation:
type: String
default: 'horizontal'
en: "orientation of flow, can be in ['horizontal', 'vertical']"
zh-CN: "flow 方向,可选['horizontal', 'vertical']"
flow-state:
props:
title:
type: String
default: ''
en: title for state point
zh-CN: 标题
state:
type: String,Number
default: ''
en: content showed inside state point.
zh-CN: 在节点中显示的内容
is-done:
type: Boolean
default: false
en: if done
zh-CN: 该节点是否完成
flow-line:
props:
tip:
type: String
default: ''
en: tip for flow line, invalid when is-done is true
zh-CN: 流线的提示文字,当 is-done 为 true 时无效
tip-direction:
type: String
default: top for horizontal flow, left for vertical flow
en: "orientation of tip, can be in ['top', 'right', 'bottom', 'left']. If horizontal flow, the default is top; if vertical flow, the default is left"
zh-CN: "提示文字方向,可选['top', 'right', 'bottom', 'left']. 在横向 flow 中默认为 top,纵向默认则为 left"
is-done:
type: Boolean
default: false
en: if done
zh-CN: 该流线是否完成
line-span:
type: Number,String
en: length of flow line. if not set, all flow-line will get the same length
zh-CN: 流线的整体长度,如果不设置,所有 flow line 将平分
process-span:
type: Number,String
default: 50
en: percentage rate of progress which will be showed in flow line
zh-CN: 在 flow line 上显示的进度比例
changes:
v2.3.1:
en:
- '[feature] new component'
zh-CN:
- '[feature] 新组件'
- '[feature] 新组件'
4 changes: 2 additions & 2 deletions src/components/form-preview/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ props:
type: Array
default: '[]'
en: |
button list, [{style: 'primary', text: 'text', onButtonClick: fn(prop:name), link: '/path'}]
zh-CN: '底部按钮列表,default为灰色样式,primary文字为高亮颜色, [{style: "primary", text: "text", onButtonClick: fn(prop:name), link: "/path"}]'
button list. Default is a gray style, and the primary text is highlighted. [{style: 'primary', text: 'text', onButtonClick: fn(prop:name), link: '/path'}]
zh-CN: '底部按钮列表,default 为灰色样式,primary 文字为高亮颜色, [{style: "primary", text: "text", onButtonClick: fn(prop:name), link: "/path"}]'
changes:
v2.5.12:
en:
Expand Down
10 changes: 5 additions & 5 deletions src/components/grid/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ grid:
type: Number
version: v2.2.0
default: 3
en: (deprecated after v2.6.0)rows number
zh-CN: (v2.6.0 之后废弃,使用 col 替代)宫格列数,建议少于`5`
en: (deprecated after v2.6.0) the number of rows. Less than 5 will be better
zh-CN: (v2.6.0 之后废弃,使用 col 替代)宫格行数,建议少于`5`
cols:
type: Number
version: v2.6.1
default: 3
en: column number
en: the number of columns. if there is more than one row in grid, need to set cols value, otherwise all grid items will show in one row with the same width
zh-CN: 列数。如果为非单行 Grid,需要设置 cols,否则所有 GridItem 会平均宽度显示在一行。
slots:
default:
Expand All @@ -49,10 +49,10 @@ grid-item:
slots:
icon:
en: 'icon slot, use `<img>`'
zh-CN: 图标内容,`直接使用<img>标签`
zh-CN: "图标内容,直接使用`<img>`标签"
label:
en: slot for label, the same func as prop:label
zh-CN: label文字的slot,作用同prop:label
zh-CN: label 文字的 slot,作用同 prop:label
changes:
v2.6.1:
en:
Expand Down
8 changes: 4 additions & 4 deletions src/components/group/metas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@ props:
default: ''
en: group title
zh-CN: 分组标题
titleColor:
title-color:
type: String
default: ''
en: group title's color
zh-CN: 分组标题文字颜色
labelWidth:
label-width:
type: String
default: ''
en: common label width for child components
zh-CN: 为子元素设定统一label宽度
labelAlign:
label-align:
type: String
default: ''
en: common label text-align for child components
zh-CN: 为子元素设定统一对齐方式
labelMarginRight:
label-margin-right:
type: String
default: ''
en: common margin right value for child components
Expand Down
11 changes: 6 additions & 5 deletions src/demos/Clocker.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,23 @@

<group :title=" $t('Use in cell') ">
<cell :title=" $t('Date: 2018-08-01') ">
<clocker time="2018-08-01" slot="value"></clocker>
<clocker time="2018-08-01"></clocker>
</cell>
</group>

<group :title=" $t('Custom template') ">
<cell :title=" $t('Date: 2018-08-01') ">
<clocker time="2018-08-01" slot="value">
<clocker time="2018-08-01">
<span style="color:red">%D 天</span>
<span style="color:green">%H 小时</span>
<span style="color:blue">%M 分 %S 秒</span>
</clocker>
</cell>
<cell title="2018-08-08">
<clocker time="2018-08-08" slot="value">
<clocker time="2018-08-08">
<span class="day">%_D1</span>
<span class="day">%_D2</span>天
<span class="day">%_D2</span>
<span class="day">%_D3</span>天
<span class="day">%_H1</span>
<span class="day">%_H2</span>时
<span class="day">%_M1</span>
Expand Down Expand Up @@ -54,7 +55,7 @@ export default {
Cell,
Group
},
ready () {
created () {
setTimeout(() => {
this.time1 = '2018-08-13 22:54'
}, 5000)
Expand Down
8 changes: 0 additions & 8 deletions src/demos/Datetime.vue
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@
<datetime v-model="limitHourValue" :start-date="startDate" :end-date="endDate" format="YYYY-MM-DD HH:mm" @on-change="change" :title="$t('Start time')"></datetime>
</group>

<div style="padding:15px;">
<x-button @click.native="reRender" type="primary">2016-11-11 ~ 2018-10-11</x-button>
</div>

<group :title="$t('Format') + ': ' + format">
<datetime v-model="value2" :format="format" @on-change="change" :title="$t('Start time')"></datetime>
</group>
Expand Down Expand Up @@ -235,10 +231,6 @@ export default {
toggleFormat () {
this.format = this.format === 'YYYY-MM-DD HH:mm' ? 'YYYY-MM-DD' : 'YYYY-MM-DD HH:mm'
},
reRender () {
this.startDate = '2016-11-11'
this.endDate = '2018-10-11'
},
change (value) {
console.log('change', value)
},
Expand Down
Loading

0 comments on commit 8e7e2f4

Please sign in to comment.