Tag 标签
用来标记状态、分类或属性的小标签,例如“已发布”“草稿”。可以带关闭按钮。需要点击选中、带图标或头像时用 Chip。
引入
import { NsTag } from '@ns/ui'
基础用法
文字写在默认插槽里。
<script setup lang="ts">
import { NsTag } from '@ns/ui'
</script>
<template>
<NsTag>标签</NsTag>
</template>
不同类型
type 决定颜色,有 primary、success、warning、danger、info、help 六种,默认是 primary。
<script setup lang="ts">
import { NsSpace, NsTag } from '@ns/ui'
</script>
<template>
<NsSpace wrap>
<NsTag type="primary">primary</NsTag>
<NsTag type="success">success</NsTag>
<NsTag type="warning">warning</NsTag>
<NsTag type="danger">danger</NsTag>
<NsTag type="info">info</NsTag>
<NsTag type="help">help</NsTag>
</NsSpace>
</template>
效果
effect 有三种:light(默认)是浅色底、主色文字;dark 是主色底、白色文字;plain 的底色用主题的背景色(亮色主题下是白色),文字是主色,边框是浅一些的主色。
下面每一行是一种效果,从左到右是 6 种类型:
<template>
<NsSpace direction="vertical" align="start">
<NsSpace wrap>
<span class="row-label">light</span>
<NsTag type="primary" effect="light">主要</NsTag>
<NsTag type="success" effect="light">成功</NsTag>
<NsTag type="warning" effect="light">警告</NsTag>
<NsTag type="danger" effect="light">危险</NsTag>
<NsTag type="info" effect="light">信息</NsTag>
<NsTag type="help" effect="light">帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">dark</span>
<NsTag type="primary" effect="dark">主要</NsTag>
<NsTag type="success" effect="dark">成功</NsTag>
<NsTag type="warning" effect="dark">警告</NsTag>
<NsTag type="danger" effect="dark">危险</NsTag>
<NsTag type="info" effect="dark">信息</NsTag>
<NsTag type="help" effect="dark">帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">plain</span>
<NsTag type="primary" effect="plain">主要</NsTag>
<NsTag type="success" effect="plain">成功</NsTag>
<NsTag type="warning" effect="plain">警告</NsTag>
<NsTag type="danger" effect="plain">危险</NsTag>
<NsTag type="info" effect="plain">信息</NsTag>
<NsTag type="help" effect="plain">帮助</NsTag>
</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>
尺寸
size 有 large、default、small 三种,高度分别是 32、24、18px。不传时跟随 NsConfigProvider 的 size,都没设置时是 default。关闭按钮和圆角也跟着尺寸变化。
<template>
<NsSpace direction="vertical" align="start">
<NsSpace wrap align="center">
<NsTag size="large">大型(large)</NsTag>
<NsTag>默认(default)</NsTag>
<NsTag size="small">小型(small)</NsTag>
</NsSpace>
<NsSpace wrap align="center">
<NsTag type="success" size="large" closable>可关闭</NsTag>
<NsTag type="success" closable>可关闭</NsTag>
<NsTag type="success" size="small" closable>可关闭</NsTag>
</NsSpace>
<NsSpace wrap align="center">
<NsTag type="warning" effect="dark" size="large" round>圆角</NsTag>
<NsTag type="warning" effect="dark" round>圆角</NsTag>
<NsTag type="warning" effect="dark" size="small" round>圆角</NsTag>
</NsSpace>
</NsSpace>
</template>
可关闭
加上 closable 以后文字后面出现关闭按钮,每种效果都能用。关闭按钮的颜色跟着文字颜色,悬停时出现一圈半透明底。
<template>
<NsSpace direction="vertical" align="start">
<NsSpace wrap>
<span class="row-label">light</span>
<NsTag type="primary" closable>主要</NsTag>
<NsTag type="success" closable>成功</NsTag>
<NsTag type="warning" closable>警告</NsTag>
<NsTag type="danger" closable>危险</NsTag>
<NsTag type="info" closable>信息</NsTag>
<NsTag type="help" closable>帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">dark</span>
<NsTag type="primary" effect="dark" closable>主要</NsTag>
<NsTag type="success" effect="dark" closable>成功</NsTag>
<NsTag type="warning" effect="dark" closable>警告</NsTag>
<NsTag type="danger" effect="dark" closable>危险</NsTag>
<NsTag type="info" effect="dark" closable>信息</NsTag>
<NsTag type="help" effect="dark" closable>帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">plain</span>
<NsTag type="primary" effect="plain" closable>主要</NsTag>
<NsTag type="success" effect="plain" closable>成功</NsTag>
<NsTag type="warning" effect="plain" closable>警告</NsTag>
<NsTag type="danger" effect="plain" closable>危险</NsTag>
<NsTag type="info" effect="plain" closable>信息</NsTag>
<NsTag type="help" effect="plain" closable>帮助</NsTag>
</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>
点关闭按钮触发 close 事件。标签不会自己消失,要在事件里把对应的数据删掉。点“重置”恢复全部标签:
<script setup lang="ts">
import { ref } from 'vue'
import { NsButton, NsSpace, NsTag } from '@ns/ui'
const all = ['Vue', 'React', 'Angular', 'Svelte']
const tags = ref([...all])
const lastClosed = ref('')
const handleClose = (name: string) => {
tags.value = tags.value.filter((item) => item !== name)
lastClosed.value = name
}
const reset = () => {
tags.value = [...all]
lastClosed.value = ''
}
</script>
<template>
<NsSpace wrap align="center">
<NsTag v-for="tag in tags" :key="tag" closable @close="handleClose(tag)">
{{ tag }}
</NsTag>
<NsButton size="small" icon="refresh" @click="reset">重置</NsButton>
</NsSpace>
<p style="margin-top: 12px">{{ lastClosed ? `刚关闭了 ${lastClosed}` : '点标签上的 × 试试' }}</p>
</template>
圆角
加上 round 以后两端是半圆,每种效果都能用,带关闭按钮时也一样。
<template>
<NsSpace direction="vertical" align="start">
<NsSpace wrap>
<span class="row-label">light</span>
<NsTag type="primary" round>主要</NsTag>
<NsTag type="success" round>成功</NsTag>
<NsTag type="warning" round>警告</NsTag>
<NsTag type="danger" round>危险</NsTag>
<NsTag type="info" round>信息</NsTag>
<NsTag type="help" round>帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">dark</span>
<NsTag type="primary" effect="dark" round>主要</NsTag>
<NsTag type="success" effect="dark" round>成功</NsTag>
<NsTag type="warning" effect="dark" round>警告</NsTag>
<NsTag type="danger" effect="dark" round>危险</NsTag>
<NsTag type="info" effect="dark" round>信息</NsTag>
<NsTag type="help" effect="dark" round>帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">plain</span>
<NsTag type="primary" effect="plain" round>主要</NsTag>
<NsTag type="success" effect="plain" round>成功</NsTag>
<NsTag type="warning" effect="plain" round>警告</NsTag>
<NsTag type="danger" effect="plain" round>危险</NsTag>
<NsTag type="info" effect="plain" round>信息</NsTag>
<NsTag type="help" effect="plain" round>帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">closable</span>
<NsTag round closable>可关闭</NsTag>
<NsTag type="success" effect="dark" round closable>可关闭</NsTag>
<NsTag type="danger" effect="plain" round closable>可关闭</NsTag>
</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>
加深边框
加上 hit 以后边框换成类型的主色,比 light、plain 效果默认的浅色边框更明显。dark 效果的边框本来就是主色,加不加没有区别。
第一行是没加 hit 的 light 标签,用来对比;后面三行是三种效果加了 hit:
<template>
<NsSpace direction="vertical" align="start">
<NsSpace wrap>
<span class="row-label">不加 hit</span>
<NsTag type="primary">主要</NsTag>
<NsTag type="success">成功</NsTag>
<NsTag type="warning">警告</NsTag>
<NsTag type="danger">危险</NsTag>
<NsTag type="info">信息</NsTag>
<NsTag type="help">帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">light</span>
<NsTag type="primary" hit>主要</NsTag>
<NsTag type="success" hit>成功</NsTag>
<NsTag type="warning" hit>警告</NsTag>
<NsTag type="danger" hit>危险</NsTag>
<NsTag type="info" hit>信息</NsTag>
<NsTag type="help" hit>帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">plain</span>
<NsTag type="primary" effect="plain" hit>主要</NsTag>
<NsTag type="success" effect="plain" hit>成功</NsTag>
<NsTag type="warning" effect="plain" hit>警告</NsTag>
<NsTag type="danger" effect="plain" hit>危险</NsTag>
<NsTag type="info" effect="plain" hit>信息</NsTag>
<NsTag type="help" effect="plain" hit>帮助</NsTag>
</NsSpace>
<NsSpace wrap>
<span class="row-label">dark</span>
<NsTag type="primary" effect="dark" hit>主要</NsTag>
<NsTag type="success" effect="dark" hit>成功</NsTag>
<NsTag type="warning" effect="dark" hit>警告</NsTag>
<NsTag type="danger" effect="dark" hit>危险</NsTag>
<NsTag type="info" effect="dark" hit>信息</NsTag>
<NsTag type="help" effect="dark" hit>帮助</NsTag>
</NsSpace>
</NsSpace>
</template>
<style scoped>
.row-label {
display: inline-block;
width: 64px;
color: var(--ns-text-color-secondary);
font-size: var(--ns-font-size-sm);
}
</style>
点击
点击标签触发 click。标签本身没有选中状态,下面的例子用 click 加 effect 切换实现了一个简单的多选;需要现成的多选时用 NsChipGroup。
<script setup lang="ts">
import { ref } from 'vue'
import { NsSpace, NsTag } from '@ns/ui'
const options = ['前端', '后端', '测试', '运维']
const selected = ref<string[]>(['前端'])
const toggle = (name: string) => {
selected.value = selected.value.includes(name)
? selected.value.filter((item) => item !== name)
: [...selected.value, name]
}
</script>
<template>
<NsSpace wrap>
<NsTag
v-for="name in options"
:key="name"
:effect="selected.includes(name) ? 'dark' : 'plain'"
style="cursor: pointer"
@click="toggle(name)"
>
{{ name }}
</NsTag>
</NsSpace>
<p style="margin-top: 12px">已选:{{ selected.length ? selected.join('、') : '无' }}</p>
</template>
同时监听 click 和 close,点关闭按钮只触发 close,不触发 click:
<script setup lang="ts">
import { ref } from 'vue'
import { NsTag } from '@ns/ui'
const log = ref('')
</script>
<template>
<NsTag
type="help"
closable
style="cursor: pointer"
@click="log = '触发了 click'"
@close="log = '触发了 close'"
>
点文字或点 ×
</NsTag>
<p style="margin-top: 12px">{{ log || '还没有触发事件' }}</p>
</template>
Props
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| type | 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'help' | 'primary' | 类型,决定颜色 |
| size | 'large' | 'default' | 'small' | 'default' | 尺寸。不写时跟随 NsConfigProvider 的 size,都没有时是 'default' |
| closable | boolean | false | 是否显示关闭按钮 |
| effect | 'dark' | 'light' | 'plain' | 'light' | 效果:light 浅色底,dark 主色底白字,plain 用主题背景色做底 |
| round | boolean | false | 两端是否是半圆 |
| hit | boolean | false | 边框是否用类型的主色 |
Events
| 事件 | 回调参数 | 说明 |
|---|---|---|
| click | (event: MouseEvent) | 点击标签时触发。点关闭按钮不触发 |
| close | (event: MouseEvent) | 点击关闭按钮时触发 |
Slots
| 插槽 | 作用域参数 | 说明 |
|---|---|---|
| default | - | 标签内容 |
类型
import type { TagType, TagSize, TagEffect, TagProps } from '@ns/ui'
type TagType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'help'
type TagSize = 'large' | 'default' | 'small'
type TagEffect = 'dark' | 'light' | 'plain'
interface TagProps {
type?: TagType
size?: TagSize
closable?: boolean
effect?: TagEffect
round?: boolean
hit?: boolean
}
另外还导出了 TagEmits。
注意事项
close只是通知,标签不会自己消失。点关闭按钮不会触发click。- 标签的鼠标指针是默认箭头。把它当按钮用(监听
click)时,自己加上cursor: pointer。 - 组件没有
disabled属性,也不能自定义颜色,颜色只能从六种类型里选。 - 关闭按钮是原生
button,可以用 Tab 聚焦,按空格或回车触发close。按钮上的回车、空格的keydown不会冒泡到外层,放在 Select 这类会用这两个键开关下拉的组件里也不会误触发。标签本身不能聚焦。 - 文字不换行,也不会省略,很长的文字会让标签超出容器。
- 每个尺寸的高度是固定的(large 32px、default 24px、small 18px),没有内容、带关闭按钮的标签和只有文字的一样高。
- 标签之间没有自带的间距,并排放多个时用
NsSpace或者自己加间距。
优化点
- [ ] 支持标签组组件
- [ ] 支持可编辑标签
- [ ] 支持自定义颜色
- [ ] 支持标签动画效果
- [ ] 文字过长时省略显示
- [ ]
dark效果的warning标签是黄底白字,对比度偏低