Translation in progress
This page hasn't been translated into English yet, so the content below is in Chinese. The code examples work the same way.
Space 间距
给一组元素之间加上统一的间距,可以横排或竖排,也可以在相邻元素之间加分隔符。
引入
import { NsSpace } from '@ns/ui'
基础用法
把元素直接放进 NsSpace,每个子元素各占一格,格子之间默认隔 16px,横着排。
<script setup lang="ts">
import { NsSpace, NsButton } from '@ns/ui'
</script>
<template>
<NsSpace>
<NsButton>新建</NsButton>
<NsButton>编辑</NsButton>
<NsButton>删除</NsButton>
</NsSpace>
</template>
排列方向
direction 可选 horizontal(默认,横排)和 vertical(竖排)。竖排时容器的宽度随内容,子元素按 align 在最宽的那个子元素的宽度里对齐。
<template>
<NsSpace size="large" align="start">
<div>
<p class="label">horizontal(默认)</p>
<NsSpace>
<NsButton>第一个</NsButton>
<NsButton>第二个按钮</NsButton>
<NsButton>第三个</NsButton>
</NsSpace>
</div>
<div>
<p class="label">vertical</p>
<NsSpace direction="vertical" align="start">
<NsButton>第一个</NsButton>
<NsButton>第二个按钮</NsButton>
<NsButton>第三个</NsButton>
</NsSpace>
</div>
</NsSpace>
</template>
<style scoped>
.label {
margin: 0 0 8px;
color: var(--ns-text-color-secondary);
font-size: var(--ns-font-size-sm);
}
</style>
间距大小
size 可以是预设值 small(8px)、default(16px)、large(24px),也可以是数字(单位 px)。
<template>
<NsSpace direction="vertical" align="start">
<NsSpace>
<span class="row-label">small</span>
<NsSpace size="small">
<NsButton>8px</NsButton>
<NsButton>8px</NsButton>
<NsButton>8px</NsButton>
</NsSpace>
</NsSpace>
<NsSpace>
<span class="row-label">default</span>
<NsSpace>
<NsButton>16px</NsButton>
<NsButton>16px</NsButton>
<NsButton>16px</NsButton>
</NsSpace>
</NsSpace>
<NsSpace>
<span class="row-label">large</span>
<NsSpace size="large">
<NsButton>24px</NsButton>
<NsButton>24px</NsButton>
<NsButton>24px</NsButton>
</NsSpace>
</NsSpace>
<NsSpace>
<span class="row-label">40</span>
<NsSpace :size="40">
<NsButton>40px</NsButton>
<NsButton>40px</NsButton>
<NsButton>40px</NsButton>
</NsSpace>
</NsSpace>
<NsSpace>
<span class="row-label">0</span>
<NsSpace :size="0">
<NsButton>0px</NsButton>
<NsButton>0px</NsButton>
<NsButton>0px</NsButton>
</NsSpace>
</NsSpace>
</NsSpace>
</template>
<style scoped>
.row-label {
display: inline-block;
width: 56px;
color: var(--ns-text-color-secondary);
font-size: var(--ns-font-size-sm);
}
</style>
拖动滑块调整间距:
<script setup lang="ts">
import { ref } from 'vue'
import { NsButton, NsSlider, NsSpace } from '@ns/ui'
const gap = ref(16)
</script>
<template>
<NsSpace direction="vertical" fill>
<NsSlider v-model="gap" :min="0" :max="48" style="max-width: 320px" />
<div>
<NsSpace :size="gap">
<NsButton>按钮</NsButton>
<NsButton>按钮</NsButton>
<NsButton>按钮</NsButton>
</NsSpace>
</div>
<span>间距 {{ gap }}px</span>
</NsSpace>
</template>
水平和垂直间距分开设置
size 传数组时,顺序是 [水平间距, 垂直间距],单位 px。水平间距是同一行里相邻元素之间的距离,垂直间距是行与行之间的距离(换行或竖排时才看得出来)。
<template>
<NsSpace wrap :size="[8, 24]" style="width: 320px">
<NsButton v-for="i in 10" :key="i">按钮 {{ i }}</NsButton>
</NsSpace>
</template>
自动换行
wrap 为 true 时,一行放不下的元素换到下一行。不开 wrap 时元素一直排在同一行,超出容器也不换行。下面两个容器都是 300px 宽:
<template>
<NsSpace direction="vertical" align="start">
<p class="label">wrap:放不下时换行</p>
<NsSpace wrap class="box">
<NsButton v-for="i in 8" :key="i">标签 {{ i }}</NsButton>
</NsSpace>
<p class="label">不开 wrap:一直排在同一行,超出容器(这里给容器加了横向滚动条)</p>
<div class="box box--scroll">
<NsSpace>
<NsButton v-for="i in 8" :key="i">标签 {{ i }}</NsButton>
</NsSpace>
</div>
</NsSpace>
</template>
<style scoped>
.label {
margin: 0;
color: var(--ns-text-color-secondary);
font-size: var(--ns-font-size-sm);
}
.box {
width: 300px;
padding: var(--ns-spacing-2);
border: var(--ns-border-width) dashed var(--ns-border-color);
}
.box--scroll {
overflow-x: auto;
}
</style>
对齐方式
align 控制子元素在交叉轴上的对齐:横排时是上下对齐,竖排时是左右对齐。可选 start、center(默认)、end、baseline。
横排时每一行一个值,右边的灰块比按钮高:
<script setup lang="ts">
import { NsButton, NsSpace } from '@ns/ui'
import type { SpaceAlign } from '@ns/ui'
const aligns: SpaceAlign[] = ['start', 'center', 'end', 'baseline']
</script>
<template>
<NsSpace direction="vertical" align="start">
<NsSpace v-for="item in aligns" :key="item" :align="item" class="row">
<span class="row-label">{{ item }}</span>
<NsButton>按钮</NsButton>
<div class="block">高一些的块</div>
<span style="font-size: 24px">大字</span>
</NsSpace>
</NsSpace>
</template>
<style scoped>
.row {
padding: var(--ns-spacing-2);
background: var(--ns-fill-color-light);
}
.row-label {
display: inline-block;
width: 64px;
color: var(--ns-text-color-secondary);
font-size: var(--ns-font-size-sm);
}
.block {
padding: 24px 12px;
background: var(--ns-fill-color-dark);
}
</style>
竖排时 align 是左右对齐,子元素在最宽的那个子元素的宽度里靠左、居中或靠右:
<template>
<NsSpace size="large" align="start">
<div>
<p class="label">start</p>
<NsSpace direction="vertical" align="start" class="column">
<NsButton>短</NsButton>
<NsButton>长一些的按钮</NsButton>
<NsButton>中等按钮</NsButton>
</NsSpace>
</div>
<div>
<p class="label">center(默认)</p>
<NsSpace direction="vertical" class="column">
<NsButton>短</NsButton>
<NsButton>长一些的按钮</NsButton>
<NsButton>中等按钮</NsButton>
</NsSpace>
</div>
<div>
<p class="label">end</p>
<NsSpace direction="vertical" align="end" class="column">
<NsButton>短</NsButton>
<NsButton>长一些的按钮</NsButton>
<NsButton>中等按钮</NsButton>
</NsSpace>
</div>
</NsSpace>
</template>
<style scoped>
.label {
margin: 0 0 8px;
color: var(--ns-text-color-secondary);
font-size: var(--ns-font-size-sm);
}
.column {
padding: var(--ns-spacing-2);
background: var(--ns-fill-color-light);
}
</style>
分隔符
separator 传一个字符串,显示在每两个相邻元素之间,最后一个元素后面不加。分隔符和两边元素之间同样有间距,竖排时也能用。
<template>
<NsSpace direction="vertical" align="start">
<NsSpace separator="|">
<NsLink>查看</NsLink>
<NsLink>编辑</NsLink>
<NsLink>删除</NsLink>
</NsSpace>
<NsSpace separator="/" size="small">
<span>首页</span>
<span>系统管理</span>
<span>用户管理</span>
</NsSpace>
<NsSpace separator="·" size="small">
<span>3 分钟前</span>
<span>阅读 1024</span>
<span>评论 12</span>
</NsSpace>
<NsSpace direction="vertical" separator="—" size="small">
<span>第一项</span>
<span>第二项</span>
<span>第三项</span>
</NsSpace>
</NsSpace>
</template>
填充容器
fill 为 true 时,容器占满父元素的整行宽度,每个格子平分宽度,格子里的子元素也会被拉伸,填满各自的格子。
<template>
<NsSpace fill>
<NsButton>上一步</NsButton>
<NsButton type="primary">下一步</NsButton>
</NsSpace>
</template>
竖排时开 fill,每一格都占满整行宽度,适合把提示、卡片这类块级元素按固定间距上下排列。
<template>
<NsSpace direction="vertical" fill>
<NsAlert type="success" title="保存成功" />
<NsAlert type="warning" title="还有 3 项没有填写" />
</NsSpace>
</template>
用 v-for 生成子元素
v-for 和 <template> 生成的每个元素都各占一格,间距和分隔符都正常加上。
<script setup lang="ts">
import { NsSpace, NsTag } from '@ns/ui'
const tags = ['前端', '后端', '测试', '运维']
</script>
<template>
<NsSpace separator="/">
<NsTag v-for="tag in tags" :key="tag">{{ tag }}</NsTag>
</NsSpace>
</template>
<template v-if> 不满足条件时不占格子,也不会多出间距和分隔符:
<script setup lang="ts">
import { ref } from 'vue'
import { NsLink, NsSpace, NsSwitch } from '@ns/ui'
const canEdit = ref(true)
</script>
<template>
<NsSpace direction="vertical" align="start">
<NsSwitch v-model="canEdit" active-text="有编辑权限" />
<NsSpace separator="|">
<NsLink>查看</NsLink>
<template v-if="canEdit">
<NsLink>编辑</NsLink>
<NsLink type="danger">删除</NsLink>
</template>
<NsLink>导出</NsLink>
</NsSpace>
</NsSpace>
</template>
跟随全局尺寸
没写 size 时,间距跟随外层 NsConfigProvider 的 size:small 8px、default 16px、large 24px。自己写了 size 的以自己的为准。按钮也读取 ConfigProvider 的 size,所以下面的按钮会跟着变大变小。
<script setup lang="ts">
import { ref } from 'vue'
import { NsButton, NsConfigProvider, NsSegmented, NsSpace } from '@ns/ui'
const size = ref<'large' | 'default' | 'small'>('default')
</script>
<template>
<NsSpace direction="vertical" align="start">
<NsSegmented v-model="size" :options="['large', 'default', 'small']" />
<NsConfigProvider :size="size">
<NsSpace direction="vertical" align="start">
<NsSpace>
<NsButton>跟随</NsButton>
<NsButton>跟随</NsButton>
<NsButton>跟随</NsButton>
</NsSpace>
<NsSpace size="small">
<NsButton>固定 small</NsButton>
<NsButton>固定 small</NsButton>
</NsSpace>
</NsSpace>
</NsConfigProvider>
</NsSpace>
</template>
Props
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| direction | 'horizontal' | 'vertical' | 'horizontal' | 排列方向 |
| size | 'small' | 'default' | 'large' | number | [number, number] | 'default' | 间距。预设值分别是 8、16、24px;数字单位是 px;数组顺序是 [水平, 垂直]。不写时跟随 ConfigProvider 的 size,没有 ConfigProvider 时是 'default' |
| wrap | boolean | false | 放不下时是否换行 |
| align | 'start' | 'center' | 'end' | 'baseline' | 'center' | 子元素在交叉轴上的对齐方式 |
| fill | boolean | false | 是否占满父元素宽度。开启后格子平分宽度(竖排时每格占满整行),子元素被拉伸填满格子 |
| separator | string | - | 相邻元素之间的分隔符,只能是字符串。不传时不显示 |
Slots
| 插槽 | 作用域参数 | 说明 |
|---|---|---|
| default | - | 要排列的元素,每个子元素各占一格 |
类型
import type { SpaceProps, SpaceDirection, SpaceAlign, SpaceSize } from '@ns/ui'
type SpaceDirection = 'horizontal' | 'vertical'
type SpaceAlign = 'start' | 'center' | 'end' | 'baseline'
type SpaceSize = 'small' | 'default' | 'large' | number | [number, number]
interface SpaceProps {
direction?: SpaceDirection
size?: SpaceSize
wrap?: boolean
align?: SpaceAlign
fill?: boolean
separator?: string
}
注意事项
- 支持用
v-for、<template v-if>生成子元素,展开后的每个元素各占一格。注释节点和只有空白的文本不占格子。 - 每个子元素外面都包了一层
div.ns-space__item,子元素本身的margin仍然有效,会和间距叠加。 - 没开
fill时容器是inline-flex,宽度随内容,连续写多个NsSpace会排在同一行。要各占一行,外面自己套块级元素,或者开fill。 - 开
fill后容器变成块级、占满整行,格子平分空间,子元素被拉伸填满格子。不想被拉伸的元素不要放进开了fill的NsSpace。 size为数字时水平、垂直两个方向用同一个值;要分开设置用数组[水平, 垂直]。- 分隔符也是容器里的一项,它和两边元素之间同样有间距。分隔符只能是字符串,颜色是次要文字色(
--ns-text-color-secondary)。