mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-15 18:01:24 +08:00
87a16f24d3
* chore: add components-helper * docs: unified style * docs: unified style * docs: unified style * docs: unified style * chore: replace Accepted Values for icon * chore: delete vetur folder * chore: add components-helper * docs: unified style * docs: unified style * docs: unified style * docs: unified style * chore: replace Accepted Values for icon * chore: delete vetur folder
288 lines
7.0 KiB
Markdown
288 lines
7.0 KiB
Markdown
## Space
|
|
Even though we have [Divider](#/en-US/component/divider), but sometimes we need more than one [Divider](#/en-US/component/divider) to split the elements apart, so we stack each elements upon [Divider](#/en-US/component/divider), but doing so not only makes our code ugly but also makes it difficult to maintain. **Space** is this kind of component provides us both productivity and elegance.
|
|
|
|
### Basic usage
|
|
The basic use case is using this component to provide unified space between each components
|
|
|
|
:::demo Using Space to provide space
|
|
|
|
```html
|
|
<template>
|
|
<el-space wrap>
|
|
<el-card class="box-card" style="width: 250px" v-for="i in 3" :key="i">
|
|
<template #header>
|
|
<div class="card-header">
|
|
<span>Card name</span>
|
|
<el-button class="button" type="text">Operation button</el-button>
|
|
</div>
|
|
</template>
|
|
<div v-for="o in 4" :key="o" class="text item">
|
|
{{ 'List item ' + o }}
|
|
</div>
|
|
</el-card>
|
|
</el-space>
|
|
</template>
|
|
```
|
|
:::
|
|
|
|
### Vertical layout
|
|
Using `direction` attribute to control the layout, we use `flex-direction` to implement this.
|
|
|
|
:::demo We also provide vertical layout.
|
|
|
|
```html
|
|
<template>
|
|
<el-space direction="vertical">
|
|
<el-card class="box-card" style="width: 250px" v-for="i in 2" :key="i">
|
|
<template #header>
|
|
<div class="card-header">
|
|
<span>Card name</span>
|
|
<el-button class="button" type="text">Operation button</el-button>
|
|
</div>
|
|
</template>
|
|
<div v-for="o in 4" :key="o" class="text item">
|
|
{{ 'List item ' + o }}
|
|
</div>
|
|
</el-card>
|
|
</el-space>
|
|
</template>
|
|
```
|
|
|
|
:::
|
|
|
|
### Control the size of the space
|
|
Control the space size via `size` API.
|
|
|
|
You can set the size with built-in sizes `mini`, `small`, `medium`, `large`, these size coresponds to `4px`, `8px`, `12px`, `16px`. The default size is `small`, A.K.A. `8px`
|
|
|
|
You can also using customized size to override it. Refer to the next part.
|
|
|
|
:::demo
|
|
```html
|
|
<template>
|
|
<el-space direction="vertical" alignment="start" :size="30">
|
|
<el-radio-group v-model="size">
|
|
<el-radio :label="'mini'">mini</el-radio>
|
|
<el-radio :label="'small'">small</el-radio>
|
|
<el-radio :label="'medium'">medium</el-radio>
|
|
<el-radio :label="'large'">large</el-radio>
|
|
</el-radio-group>
|
|
|
|
<el-space wrap :size="size">
|
|
<el-card class="box-card" style="width: 250px" v-for="i in 3" :key="i">
|
|
<template #header>
|
|
<div class="card-header">
|
|
<span>Card name</span>
|
|
<el-button class="button" type="text">Operation button</el-button>
|
|
</div>
|
|
</template>
|
|
<div v-for="o in 4" :key="o" class="text item">
|
|
{{ 'List item ' + o }}
|
|
</div>
|
|
</el-card>
|
|
</el-space>
|
|
</el-space>
|
|
</template>
|
|
|
|
<script>
|
|
|
|
export default {
|
|
|
|
data() {
|
|
return {
|
|
size: 'mini',
|
|
}
|
|
}
|
|
}
|
|
</script>
|
|
```
|
|
:::
|
|
|
|
### Customized Size
|
|
Sometimes built-in sizes could not meet the business needs, we can use custom size (number type) to control the space between items.
|
|
|
|
:::demo
|
|
```html
|
|
<template>
|
|
<el-slider v-model="size" />
|
|
<el-space wrap :size="size">
|
|
<el-card class="box-card" style="width: 250px" v-for="i in 2" :key="i">
|
|
<template #header>
|
|
<div class="card-header">
|
|
<span>Card name</span>
|
|
<el-button class="button" type="text">Operation button</el-button>
|
|
</div>
|
|
</template>
|
|
<div v-for="o in 4" :key="o" class="text item">
|
|
{{ 'List item ' + o }}
|
|
</div>
|
|
</el-card>
|
|
</el-space>
|
|
</template>
|
|
|
|
<script>
|
|
export default {
|
|
|
|
data() {
|
|
return {
|
|
size: 20,
|
|
}
|
|
}
|
|
}
|
|
</script>
|
|
```
|
|
:::
|
|
|
|
:::tip
|
|
Do not use `ElSpace` with components that depend on ancestor width (height), e.g. `ElSlider`, in this case when you drag the trigger button the bar will grow which causes misplacement between cursor and trigger button.
|
|
:::
|
|
|
|
### Auto wrapping
|
|
When in **horizontal** mode, using `wrap` (**bool type**) to control auto wrapping behavior.
|
|
|
|
:::demo Using `wrap` to control line wrap
|
|
|
|
```html
|
|
<el-space wrap>
|
|
<div v-for="i in 20" :key="i">
|
|
<el-button type="text">
|
|
Text button
|
|
</el-button>
|
|
</div>
|
|
</el-space>
|
|
```
|
|
:::
|
|
|
|
### Spacer
|
|
Sometimes we want something more than blank space, so we have (spacer) to help us.
|
|
|
|
#### Literal type spacer
|
|
|
|
:::demo
|
|
|
|
```html
|
|
<template>
|
|
<el-space :size="size" spacer="|">
|
|
<div v-for="i in 2" :key="i">
|
|
<el-button>
|
|
button {{ i }}
|
|
</el-button>
|
|
</div>
|
|
</el-space>
|
|
</template>
|
|
|
|
<script>
|
|
|
|
export default {
|
|
data() {
|
|
return {
|
|
size: 10,
|
|
}
|
|
},
|
|
}
|
|
</script>
|
|
```
|
|
:::
|
|
|
|
#### Spacer can also be VNode
|
|
|
|
:::demo
|
|
```html
|
|
<template>
|
|
<el-space :size="size" :spacer="spacer">
|
|
<div v-for="i in 2" :key="i">
|
|
<el-button>
|
|
button {{ i }}
|
|
</el-button>
|
|
</div>
|
|
</el-space>
|
|
</template>
|
|
|
|
<script>
|
|
import { h, resolveComponent } from 'vue'
|
|
import { ElDivider } from 'element-plus'
|
|
export default {
|
|
data() {
|
|
return {
|
|
size: 10,
|
|
spacer: h(ElDivider, { direction: 'vertical' }),
|
|
}
|
|
},
|
|
}
|
|
</script>
|
|
|
|
```
|
|
:::
|
|
|
|
### Alignment
|
|
Setting this attribute can adjust the alignment of child nodes, the desirable value can be found at [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
|
|
|
|
:::demo Using `alignment`
|
|
|
|
```html
|
|
|
|
<template>
|
|
<div style="width: 240px;margin-bottom: 20px;padding: 8px;border: 1px solid #ccc;">
|
|
<el-space>
|
|
string
|
|
<el-button>
|
|
button
|
|
</el-button>
|
|
<el-card>
|
|
<template #header>
|
|
header
|
|
</template>
|
|
body
|
|
</el-card>
|
|
</el-space>
|
|
</div>
|
|
<div style="width: 240px;margin-bottom: 20px;padding: 8px;border: 1px solid #ccc;">
|
|
<el-space alignment="flex-start">
|
|
string
|
|
<el-button>
|
|
button
|
|
</el-button>
|
|
<el-card>
|
|
<template #header>
|
|
header
|
|
</template>
|
|
body
|
|
</el-card>
|
|
</el-space>
|
|
</div>
|
|
<div style="width: 240px;margin-bottom: 20px;padding: 8px;border: 1px solid #ccc;">
|
|
<el-space alignment="flex-end">
|
|
string
|
|
<el-button>
|
|
button
|
|
</el-button>
|
|
<el-card>
|
|
<template #header>
|
|
header
|
|
</template>
|
|
body
|
|
</el-card>
|
|
</el-space>
|
|
</div>
|
|
</template>
|
|
|
|
```
|
|
:::
|
|
|
|
### Space Attributes
|
|
|
|
| Attribute | Description | Type | Available value | Default |
|
|
|---------- |-------- |---------- |------------- |-------- |
|
|
| alignment | Controls the alignment of items | string | [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items)| 'center' |
|
|
| class | Classname | string / Array<Object \| String> / Object | - | - |
|
|
| direction | Placement direction | string | vertical/horizontal | horizontal |
|
|
| prefixCls | Prefix for space-items | string | el-space | - |
|
|
| style | Extra style rules | string / Array<Object \| String> / Object | - | - |
|
|
| spacer | Spacer | string / number / VNode | - | - |
|
|
| size | Spacing size | string / number / [number, number] | - | 'small' |
|
|
| wrap | Auto wrapping | boolean | true / false | false |
|
|
### Space Slots
|
|
| Name | Description |
|
|
|----|----|
|
|
| default | Items to be spaced |
|