Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
duduluu committed Dec 11, 2017
1 parent f2a3165 commit d9417cf
Show file tree
Hide file tree
Showing 9 changed files with 154 additions and 239 deletions.
2 changes: 1 addition & 1 deletion docs/App.vue
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<template>
<div id="app">
<main-nav mode="router"></main-nav>
<vd-main>
<vd-main class="docs-main-wrapper">
<keep-alive>
<router-view></router-view>
</keep-alive>
Expand Down
188 changes: 94 additions & 94 deletions docs/articles/zh-CN/layout/flexbox.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,94 @@
# Flexbox 弹性盒子布局

响应式弹性盒子布局。通过定义每一栏的百分比进行界面布局。

```html
<vd-flexbox></vd-flexbox>
```

## 基础用法

当不设置 `flex` 属性的值时,元素会平均分配父容器宽度。相当于 `flex: 1 1 0%;`

`flex="auto"` flexbox 会根据自身的宽度与高度来确定尺寸,但是会自行伸长以吸收父容器中额外的
自由空间,也会缩短至自身最小尺寸以适应父容器。

`flex="initial"` flexbox 会根据自身宽高设置尺寸。它会缩短自身以适应父容器,但不会伸长并吸
收父容器中的额外自由空间来适应容器。

`flex="none"` flexbox 会根据自身宽高来设置尺寸。它是完全非弹性的:既不会缩短,也不会伸长来
适应父容器。

<example-board :component="FlexboxPreset" :source="FlexboxPresetSource"></example-board>

`flex` 属性使用具体的值,设置一个 flexbox 占其父 flexbox 的宽度百分比。

<example-board :component="FlexboxBasic" :source="FlexboxBasicSource"></example-board>

## 对齐

`justify`属性值设置其内容的水平对齐方式。

<example-board :component="FlexboxJustify" :source="FlexboxJustifySource"></example-board>

`align`属性值设置其内容的垂直对齐方式。

<example-board :component="FlexboxAlign" :source="FlexboxAlignSource"></example-board>

## 响应式

<example-board :component="FlexboxResponsive" :source="FlexboxResponsiveSource"></example-board>

---

## 所有属性

> `*`表示默认值。
| Property | Type | Available Value |
| :------------ | :-------------- | :------------------------------------------------------------------- |
| flex | `string|number` | **auto\***, initial<template v-for="i in 20">, {{i \* 5}}</template> |
| flex-xsmall | `string|number` | |
| flex-small | `string|number` | |
| flex-medium | `string|number` | |
| flex-large | `string|number` | |
| flex-xlarge | `string|number` | |
| gutter | `string` | auto, xsmall, small, medium, large, xlarge |
| justify | `string` | **start\***, end, center, between, around |
| align | `string` | **start\***, end, center, stretch, baseline |
| hidden | `bolean` | |
| hidden-xsmall | `bolean` | |
| hidden-small | `bolean` | |
| hidden-medium | `bolean` | |
| hidden-large | `bolean` | |
| hidden-xlarge | `bolean` | |

<script>
import FlexboxBasic from 'docs/examples/layout/FlexboxBasic';
import FlexboxBasicSource from 'docs/examples/layout/FlexboxBasic.txt';
import FlexboxPreset from 'docs/examples/layout/FlexboxPreset';
import FlexboxPresetSource from 'docs/examples/layout/FlexboxPreset.txt';
import FlexboxJustify from 'docs/examples/layout/FlexboxJustify';
import FlexboxJustifySource from 'docs/examples/layout/FlexboxJustify.txt';
import FlexboxAlign from 'docs/examples/layout/FlexboxAlign';
import FlexboxAlignSource from 'docs/examples/layout/FlexboxAlign.txt';
import FlexboxResponsive from 'docs/examples/layout/FlexboxResponsive';
import FlexboxResponsiveSource from 'docs/examples/layout/FlexboxResponsive.txt';

export default {
data() {
return {
FlexboxBasic,
FlexboxBasicSource,
FlexboxPreset,
FlexboxPresetSource,
FlexboxJustify,
FlexboxJustifySource,
FlexboxAlign,
FlexboxAlignSource,
FlexboxResponsive,
FlexboxResponsiveSource,
}
}
}
</script>
# Flexbox 弹性盒子布局

响应式弹性盒子布局。通过定义每一栏的百分比进行界面布局。

```html
<vd-flexbox></vd-flexbox>
```

## 基础用法

当不设置 `flex` 属性的值时,元素会平均分配父容器宽度。实际上的 CSS 代码:`flex: 1 1 0%;`

`flex="auto"` flexbox 会根据自身的宽度与高度来确定尺寸,但是会自行伸长以吸收父容器中额外的
自由空间,也会缩短至自身最小尺寸以适应父容器。

`flex="initial"` flexbox 会根据自身宽高设置尺寸。它会缩短自身以适应父容器,但不会伸长并吸
收父容器中的额外自由空间来适应容器。

`flex="none"` flexbox 会根据自身宽高来设置尺寸。它是完全非弹性的:既不会缩短,也不会伸长来
适应父容器。

<example-board :component="FlexboxPreset" :source="FlexboxPresetSource"></example-board>

`flex` 属性使用具体的值,设置一个 flexbox 占其父 flexbox 的宽度百分比。

<example-board :component="FlexboxBasic" :source="FlexboxBasicSource"></example-board>

## 对齐

`justify`属性值设置其内容的水平对齐方式。

<example-board :component="FlexboxJustify" :source="FlexboxJustifySource"></example-board>

`align`属性值设置其内容的垂直对齐方式。

<example-board :component="FlexboxAlign" :source="FlexboxAlignSource"></example-board>

## 响应式

<example-board :component="FlexboxResponsive" :source="FlexboxResponsiveSource"></example-board>

---

## 所有属性

> `*`表示默认值。
| Property | Type | Available Value |
| :------------ | :-------------- | :------------------------------------------------------------------- |
| flex | `string|number` | **auto\***, initial<template v-for="i in 20">, {{i \* 5}}</template> |
| flex-xsmall | `string|number` | |
| flex-small | `string|number` | |
| flex-medium | `string|number` | |
| flex-large | `string|number` | |
| flex-xlarge | `string|number` | |
| gutter | `string` | auto, xsmall, small, medium, large, xlarge |
| justify | `string` | **start\***, end, center, between, around |
| align | `string` | **start\***, end, center, stretch, baseline |
| hidden | `bolean` | |
| hidden-xsmall | `bolean` | |
| hidden-small | `bolean` | |
| hidden-medium | `bolean` | |
| hidden-large | `bolean` | |
| hidden-xlarge | `bolean` | |

<script>
import FlexboxBasic from 'docs/examples/layout/FlexboxBasic';
import FlexboxBasicSource from 'docs/examples/layout/FlexboxBasic.txt';
import FlexboxPreset from 'docs/examples/layout/FlexboxPreset';
import FlexboxPresetSource from 'docs/examples/layout/FlexboxPreset.txt';
import FlexboxJustify from 'docs/examples/layout/FlexboxJustify';
import FlexboxJustifySource from 'docs/examples/layout/FlexboxJustify.txt';
import FlexboxAlign from 'docs/examples/layout/FlexboxAlign';
import FlexboxAlignSource from 'docs/examples/layout/FlexboxAlign.txt';
import FlexboxResponsive from 'docs/examples/layout/FlexboxResponsive';
import FlexboxResponsiveSource from 'docs/examples/layout/FlexboxResponsive.txt';

export default {
data() {
return {
FlexboxBasic,
FlexboxBasicSource,
FlexboxPreset,
FlexboxPresetSource,
FlexboxJustify,
FlexboxJustifySource,
FlexboxAlign,
FlexboxAlignSource,
FlexboxResponsive,
FlexboxResponsiveSource,
}
}
}
</script>
66 changes: 9 additions & 57 deletions docs/examples/layout/FlexboxAlign.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,68 +2,20 @@
<vd-flexbox gutter="xsmall">

<vd-flexbox flex="100"
align="start">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
李白
</vd-flexbox>
</vd-flexbox>
v-for="align in ['start', 'center', 'end', 'stretch', 'baseline']"
:key="align"
:align="align">

<vd-flexbox flex="100"
align="center">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
李白
</vd-flexbox>
</vd-flexbox>

<vd-flexbox flex="100"
align="end">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
<vd-flexbox flex="50">
<div class="layout-content"
style="height: 92px;">align = "{{align}}"<br/>height: 92px;</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
李白
</vd-flexbox>
</vd-flexbox>

<vd-flexbox flex="100"
align="baseline">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
李白
<vd-flexbox flex="50">
<div class="layout-content"
style="">align = "{{align}}"</div>
</vd-flexbox>
</vd-flexbox>

<vd-flexbox flex="100"
align="stretch">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">李白</div>
</vd-flexbox>
</vd-flexbox>

</vd-flexbox>
Expand Down
66 changes: 9 additions & 57 deletions docs/examples/layout/FlexboxAlign.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,68 +2,20 @@
<vd-flexbox gutter="xsmall">

<vd-flexbox flex="100"
align="start">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
李白
</vd-flexbox>
</vd-flexbox>
v-for="align in ['start', 'center', 'end', 'stretch', 'baseline']"
:key="align"
:align="align">

<vd-flexbox flex="100"
align="center">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
李白
</vd-flexbox>
</vd-flexbox>

<vd-flexbox flex="100"
align="end">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
<vd-flexbox flex="50">
<div class="layout-content"
style="height: 92px;">align = "{{align}}"<br/>height: 92px;</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
李白
</vd-flexbox>
</vd-flexbox>

<vd-flexbox flex="100"
align="baseline">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
李白
<vd-flexbox flex="50">
<div class="layout-content"
style="">align = "{{align}}"</div>
</vd-flexbox>
</vd-flexbox>

<vd-flexbox flex="100"
align="stretch">
<vd-flexbox flex="33">
<div class="layout-content">日照香炉生紫烟,<br/>遥看瀑布挂前川。<br/>飞流直下三千尺,<br/>疑是银河落九天。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">从军玉门道,逐虏金微山。笛奏梅花曲,刀开明月环。鼓声鸣海上,兵气拥云间。愿斩单于首,长驱静铁关。</div>
</vd-flexbox>
<vd-flexbox flex="33">
<div class="layout-content">李白</div>
</vd-flexbox>
</vd-flexbox>

</vd-flexbox>
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/layout/FlexboxBasic.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@
</vd-flexbox>

<vd-flexbox flex="40">
<div class="layout-content">30</div>
<div class="layout-content">40</div>
</vd-flexbox>
<vd-flexbox flex="60">
<div class="layout-content">70</div>
<div class="layout-content">60</div>
</vd-flexbox>

<vd-flexbox flex="50">
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/layout/FlexboxBasic.vue
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@
</vd-flexbox>

<vd-flexbox flex="40">
<div class="layout-content">30</div>
<div class="layout-content">40</div>
</vd-flexbox>
<vd-flexbox flex="60">
<div class="layout-content">70</div>
<div class="layout-content">60</div>
</vd-flexbox>

<vd-flexbox flex="50">
Expand Down
Loading

0 comments on commit d9417cf

Please sign in to comment.