FloatLabel 浮动标签
独立使用的浮动标签。控件有值、获得焦点或打开面板时,标签浮到上边框。
引入
ts
import { NsFloatLabel, NsInput } from '@ns/ui'
import type { FloatLabelProps } from '@ns/ui'
示例
基础用法
vue
<script setup lang="ts">
import { ref } from 'vue'
import { NsFloatLabel, NsInput } from '@ns/ui'
const name = ref('')
</script>
<template>
<NsFloatLabel label="部门名称" style="width: 260px; margin-top: 8px">
<NsInput v-model="name" clearable />
</NsFloatLabel>
</template>
各种控件
vue
<script setup lang="ts">
import { reactive } from 'vue'
import {
NsFloatLabel,
NsInput,
NsTextarea,
NsSelect,
NsCascader,
NsTreeSelect,
NsTimePicker,
NsDatePicker,
NsAutoComplete,
NsInputTag,
NsMentions,
NsIconPicker
} from '@ns/ui'
const model = reactive({
name: '',
remark: '',
department: undefined as string | undefined,
region: [] as string[],
tree: undefined as string | undefined,
time: '',
date: '',
keyword: '',
tags: [] as string[],
mentions: '',
icon: ''
})
const options = [
{ label: '研发部', value: 'dev' },
{ label: '运营部', value: 'ops' }
]
const regions = [{ label: '华东', value: 'east', children: [{ label: '上海', value: 'sh' }] }]
const tree = [{ label: '总部', id: 'root', children: [{ label: '研发部', id: 'dev' }] }]
</script>
<template>
<div class="float-grid">
<NsFloatLabel label="Input 名称"><NsInput v-model="model.name" clearable /></NsFloatLabel>
<NsFloatLabel label="Textarea 备注"><NsTextarea v-model="model.remark" /></NsFloatLabel>
<NsFloatLabel label="Select 部门"
><NsSelect v-model="model.department" :options="options" clearable
/></NsFloatLabel>
<NsFloatLabel label="Cascader 地区"
><NsCascader v-model="model.region" :options="regions"
/></NsFloatLabel>
<NsFloatLabel label="TreeSelect 组织"
><NsTreeSelect v-model="model.tree" :data="tree"
/></NsFloatLabel>
<NsFloatLabel label="TimePicker 时间"><NsTimePicker v-model="model.time" /></NsFloatLabel>
<NsFloatLabel label="DatePicker 日期"><NsDatePicker v-model="model.date" /></NsFloatLabel>
<NsFloatLabel label="AutoComplete 关键词"
><NsAutoComplete v-model="model.keyword" :options="options"
/></NsFloatLabel>
<NsFloatLabel label="InputTag 标签"><NsInputTag v-model="model.tags" /></NsFloatLabel>
<NsFloatLabel label="Mentions 成员"
><NsMentions v-model="model.mentions" :options="options"
/></NsFloatLabel>
<NsFloatLabel label="IconPicker 图标"><NsIconPicker v-model="model.icon" /></NsFloatLabel>
</div>
</template>
<style scoped>
.float-grid {
display: grid;
grid-template-columns: repeat(2, minmax(0, 1fr));
gap: 24px;
padding-top: 8px;
}
@media (max-width: 600px) {
.float-grid {
grid-template-columns: minmax(0, 1fr);
}
}
</style>
一直浮起的控件
数字框、日期范围和带前置内容的输入框,标签始终浮起,避免遮住按钮、前缀和两段占位文字。
vue
<script setup lang="ts">
import { ref } from 'vue'
import { NsFloatLabel, NsInputNumber, NsDatePicker, NsInput, NsSpace } from '@ns/ui'
const count = ref<number | undefined>()
const range = ref<[string, string]>(['', ''])
const keyword = ref('')
</script>
<template>
<NsSpace wrap align="start" size="large" style="padding-top: 8px">
<NsFloatLabel label="InputNumber 数量" style="width: 200px"
><NsInputNumber v-model="count"
/></NsFloatLabel>
<NsFloatLabel label="DatePicker 日期范围" style="width: 300px"
><NsDatePicker v-model="range" type="daterange"
/></NsFloatLabel>
<NsFloatLabel label="Input 前缀图标" style="width: 240px"
><NsInput v-model="keyword" prefix-icon="search"
/></NsFloatLabel>
</NsSpace>
</template>
尺寸
vue
<script setup lang="ts">
import { reactive } from 'vue'
import { NsFloatLabel, NsInput, NsSpace } from '@ns/ui'
const sizes = ['large', 'default', 'small'] as const
const model = reactive({ large: '', default: '', small: '' })
</script>
<template>
<NsSpace direction="vertical" fill size="large" style="padding-top: 8px">
<NsFloatLabel v-for="size in sizes" :key="size" :label="size" style="width: 260px">
<NsInput v-model="model[size]" :size="size" />
</NsFloatLabel>
</NsSpace>
</template>
工具栏
vue
<script setup lang="ts">
import { ref } from 'vue'
import { NsFloatLabel, NsInput, NsSelect, NsButton, NsMessage, NsSpace } from '@ns/ui'
const name = ref('')
const status = ref<string>()
const options = [
{ label: '启用', value: 'enabled' },
{ label: '停用', value: 'disabled' }
]
const search = () =>
NsMessage.info(`查询:${name.value || '全部名称'},${status.value || '全部状态'}`)
</script>
<template>
<NsSpace wrap align="center" style="padding-top: 8px">
<NsFloatLabel label="名称" style="width: 220px"
><NsInput v-model="name" clearable
/></NsFloatLabel>
<NsFloatLabel label="状态" style="width: 180px"
><NsSelect v-model="status" :options="options" clearable
/></NsFloatLabel>
<NsButton type="primary" icon="search" @click="search">查询</NsButton>
</NsSpace>
</template>
禁用
vue
<script setup lang="ts">
import { NsFloatLabel, NsInput, NsSelect, NsSpace } from '@ns/ui'
</script>
<template>
<NsSpace wrap size="large" style="padding-top: 8px">
<NsFloatLabel label="空值禁用" style="width: 240px"><NsInput disabled /></NsFloatLabel>
<NsFloatLabel label="已有值禁用" style="width: 240px"
><NsInput model-value="研发部" disabled
/></NsFloatLabel>
<NsFloatLabel label="下拉禁用" style="width: 240px"
><NsSelect disabled :options="[]"
/></NsFloatLabel>
</NsSpace>
</template>
显式校验状态
vue
<script setup lang="ts">
import { ref } from 'vue'
import { NsFloatLabel, NsInput, NsSwitch, NsSpace } from '@ns/ui'
const invalid = ref(true)
const name = ref('')
</script>
<template>
<NsSpace direction="vertical" fill size="large">
<NsSwitch v-model="invalid" aria-label="校验失败" />
<NsFloatLabel label="部门名称" :invalid="invalid" style="width: 260px; margin-top: 8px">
<NsInput v-model="name" />
</NsFloatLabel>
</NsSpace>
</template>
跟随表单校验
表单项不再填写 label。输入后删空、离开输入框或点击校验,错误提示仍由表单项显示。
vue
<script setup lang="ts">
import { reactive, ref } from 'vue'
import { NsFloatLabel, NsInput, NsForm, NsFormItem, NsButton, NsMessage, NsSpace } from '@ns/ui'
const model = reactive({ name: '' })
const form = ref<InstanceType<typeof NsForm>>()
const rules = { name: [{ required: true, message: '请输入部门名称', trigger: 'blur' as const }] }
const validate = async () => {
const result = await form.value?.validate()
if (result?.valid) NsMessage.success('校验通过')
}
</script>
<template>
<NsForm ref="form" :model="model" :rules="rules" label-width="0" style="padding-top: 8px">
<NsFormItem prop="name">
<NsFloatLabel label="部门名称" style="width: 260px"
><NsInput v-model="model.name"
/></NsFloatLabel>
</NsFormItem>
<NsSpace><NsButton type="primary" @click="validate">校验</NsButton></NsSpace>
</NsForm>
</template>
自定义标签
vue
<script setup lang="ts">
import { ref } from 'vue'
import { NsFloatLabel, NsInput, NsIcon } from '@ns/ui'
const name = ref('')
</script>
<template>
<NsFloatLabel style="width: 260px; margin-top: 8px">
<template #label><NsIcon name="user" size="inherit" /> 联系人 *</template>
<NsInput v-model="name" />
</NsFloatLabel>
</template>
手动有值状态与原生输入框
filled 显式覆盖自动判断。原生输入框不自动登记,标签在上方显示,读屏名称由使用者提供。
vue
<script setup lang="ts">
import { ref } from 'vue'
import { NsFloatLabel, NsInput, NsSwitch, NsSpace } from '@ns/ui'
const filled = ref(false)
const nativeValue = ref('')
</script>
<template>
<NsSpace direction="vertical" fill size="large">
<NsSwitch v-model="filled" aria-label="手动浮起" />
<NsFloatLabel label="手动浮起" :filled="filled" style="width: 260px; margin-top: 8px"
><NsInput
/></NsFloatLabel>
<NsFloatLabel label="原生输入框" :filled="nativeValue !== ''" style="width: 260px">
<input v-model="nativeValue" aria-label="原生输入框" />
</NsFloatLabel>
</NsSpace>
</template>
占位文字
vue
<script setup lang="ts">
import { ref } from 'vue'
import { NsFloatLabel, NsInput } from '@ns/ui'
const name = ref('')
</script>
<template>
<NsFloatLabel label="部门名称" style="width: 260px; margin-top: 8px">
<NsInput v-model="name" placeholder="例如:研发部" clearable />
</NsFloatLabel>
</template>
Props
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| label | string | — | 标签文字,label 插槽优先 |
| filled | boolean | undefined | 手动指定有值;不写时自动判断,无法判断则保持浮起状态 |
| invalid | boolean | undefined | 手动指定标签校验状态;不写时跟随所在表单项 |
Events
无。
Slots
| 插槽 | 说明 |
|---|---|
| default | 单个输入控件 |
| label | 自定义标签内容,覆盖 label 属性 |
方法
无。
类型
ts
interface FloatLabelProps {
label?: string
filled?: boolean
invalid?: boolean
}
注意事项
- 一个标签只关联第一个输入控件,额外控件会输出开发警告。
null、undefined、空字符串、空数组和元素全为空的数组视为无值;0、false视为有值。- 尺寸跟随控件,优先级为控件自身、表单项、表单、全局配置;没有独立的
size属性。 - 数字框、日期范围和带前置内容的输入框始终浮起;复选框、开关和无支持输入框结构的控件,标签在上方显示。
- 标签上方至少留 8px,避免被紧邻内容或裁切容器遮住。
- 表单里可直接使用
label-position="float";若在表单项内使用 FloatLabel,表单项不要再写label。需要取消表单标签列时设置label-width="0"。 invalid只控制标签颜色,不执行校验,也不覆盖控件的aria-invalid。- 原生输入框、自定义组件的值和读屏关联需自行提供;可用
filled同步有值状态。没有标签时不会隐藏控件的占位文字。 - 浮起的标签用
--ns-bg-color遮住一小段边框;放在不同底色上时应同步设置该变量。