Popconfirm 气泡确认框
点击某个元素后,在它旁边弹出一个带“取消”“确定”按钮的小卡片,用户确认后才执行操作。适合删除一行数据这类不需要整屏对话框的二次确认;需要说明较多内容或填写表单时用 Modal。
引入
import { NsPopconfirm } from '@ns/ui'
基础用法
触发元素放在默认插槽里,title 是确认的问题。点“确定”触发 confirm,点“取消”触发 cancel,两个按钮点完都会收起气泡。
<script setup lang="ts">
import { NsPopconfirm, NsButton, NsMessage } from '@ns/ui'
const handleConfirm = () => {
// 在这里执行删除
NsMessage.success('点了确定,触发 confirm')
}
const handleCancel = () => {
NsMessage('点了取消,触发 cancel')
}
</script>
<template>
<NsPopconfirm title="确定要删除这条记录吗?" @confirm="handleConfirm" @cancel="handleCancel">
<NsButton type="danger">删除</NsButton>
</NsPopconfirm>
</template>
按钮文字
confirm-button-text、cancel-button-text 改按钮文字,默认是“确定”“取消”。
<template>
<NsPopconfirm
title="删除后无法恢复,确定继续吗?"
confirm-button-text="删除"
cancel-button-text="再想想"
confirm-button-type="danger"
>
<NsButton type="danger">删除</NsButton>
</NsPopconfirm>
</template>
按钮类型
confirm-button-type、cancel-button-type 改按钮类型,取值和 NsButton 的 type 相同,共 7 种。确定按钮默认 primary,取消按钮默认 default。第一行改确定按钮,第二行改取消按钮,点开看效果:
<template>
<NsSpace direction="vertical" align="start">
<NsSpace wrap>
<span class="row-label">确定按钮</span>
<NsPopconfirm title="确定按钮是 default" confirm-button-type="default">
<NsButton>default</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定按钮是 primary(默认)">
<NsButton>primary</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定按钮是 success" confirm-button-type="success">
<NsButton>success</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定按钮是 warning" confirm-button-type="warning">
<NsButton>warning</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定按钮是 danger" confirm-button-type="danger">
<NsButton>danger</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定按钮是 info" confirm-button-type="info">
<NsButton>info</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定按钮是 help" confirm-button-type="help">
<NsButton>help</NsButton>
</NsPopconfirm>
</NsSpace>
<NsSpace wrap>
<span class="row-label">取消按钮</span>
<NsPopconfirm title="取消按钮是 default(默认)">
<NsButton>default</NsButton>
</NsPopconfirm>
<NsPopconfirm title="取消按钮是 primary" cancel-button-type="primary">
<NsButton>primary</NsButton>
</NsPopconfirm>
<NsPopconfirm title="取消按钮是 success" cancel-button-type="success">
<NsButton>success</NsButton>
</NsPopconfirm>
<NsPopconfirm title="取消按钮是 warning" cancel-button-type="warning">
<NsButton>warning</NsButton>
</NsPopconfirm>
<NsPopconfirm title="取消按钮是 danger" cancel-button-type="danger">
<NsButton>danger</NsButton>
</NsPopconfirm>
<NsPopconfirm title="取消按钮是 info" cancel-button-type="info">
<NsButton>info</NsButton>
</NsPopconfirm>
<NsPopconfirm title="取消按钮是 help" cancel-button-type="help">
<NsButton>help</NsButton>
</NsPopconfirm>
</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>
图标
icon 是图标名(NsIcon 的 name),默认 warning;icon-color 改图标颜色,不传时是警告色;hide-icon 隐藏图标。
<template>
<NsSpace wrap>
<NsPopconfirm title="确定要提交吗?">
<NsButton>默认(warning)</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定要发布吗?" icon="info" icon-color="var(--ns-color-primary)">
<NsButton>换图标和颜色</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定要标记为已解决吗?" icon="help" icon-color="var(--ns-color-help)">
<NsButton>help 图标</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定要清空回收站吗?" icon="trash" icon-color="var(--ns-color-danger)">
<NsButton>trash 图标</NsButton>
</NsPopconfirm>
<NsPopconfirm title="确定要发布吗?" hide-icon>
<NsButton>不显示图标</NsButton>
</NsPopconfirm>
</NsSpace>
</template>
插槽
title 插槽放带格式的问题,优先于 title 属性。触发元素也可以写在 reference 插槽里,和默认插槽作用相同,两个都写了时只渲染 reference。
<template>
<NsSpace wrap>
<NsPopconfirm>
<NsButton>title 插槽</NsButton>
<template #title>确定要把 <strong>3 个文件</strong> 移到回收站吗?</template>
</NsPopconfirm>
<NsPopconfirm title="确定要移除这位成员吗?">
<template #reference>
<NsButton type="danger" variant="link">reference 插槽</NsButton>
</template>
</NsPopconfirm>
</NsSpace>
</template>
位置
placement 设置气泡的位置,共 12 个方向,默认 top,放不下时自动翻到反方向;offset 设置气泡和触发元素的间距。点下面的按钮看效果:
<template>
<div class="placements">
<div class="placements__row placements__row--center">
<NsPopconfirm placement="top-start" title="确定删除吗?" :width="160">
<NsButton>top-start</NsButton>
</NsPopconfirm>
<NsPopconfirm placement="top" title="确定删除吗?" :width="160">
<NsButton>top</NsButton>
</NsPopconfirm>
<NsPopconfirm placement="top-end" title="确定删除吗?" :width="160">
<NsButton>top-end</NsButton>
</NsPopconfirm>
</div>
<div class="placements__row placements__row--between">
<NsSpace direction="vertical" align="start">
<NsPopconfirm placement="left-start" title="确定删除吗?" :width="160">
<NsButton>left-start</NsButton>
</NsPopconfirm>
<NsPopconfirm placement="left" title="确定删除吗?" :width="160">
<NsButton>left</NsButton>
</NsPopconfirm>
<NsPopconfirm placement="left-end" title="确定删除吗?" :width="160">
<NsButton>left-end</NsButton>
</NsPopconfirm>
</NsSpace>
<NsSpace direction="vertical" align="end">
<NsPopconfirm placement="right-start" title="确定删除吗?" :width="160">
<NsButton>right-start</NsButton>
</NsPopconfirm>
<NsPopconfirm placement="right" title="确定删除吗?" :width="160">
<NsButton>right</NsButton>
</NsPopconfirm>
<NsPopconfirm placement="right-end" title="确定删除吗?" :width="160">
<NsButton>right-end</NsButton>
</NsPopconfirm>
</NsSpace>
</div>
<div class="placements__row placements__row--center">
<NsPopconfirm placement="bottom-start" title="确定删除吗?" :width="160">
<NsButton>bottom-start</NsButton>
</NsPopconfirm>
<NsPopconfirm placement="bottom" title="确定删除吗?" :width="160">
<NsButton>bottom</NsButton>
</NsPopconfirm>
<NsPopconfirm placement="bottom-end" title="确定删除吗?" :width="160">
<NsButton>bottom-end</NsButton>
</NsPopconfirm>
</div>
</div>
</template>
<style scoped>
.placements {
max-width: 520px;
margin: 0 auto;
}
.placements__row {
display: flex;
gap: var(--ns-spacing-2);
}
.placements__row--center {
justify-content: center;
}
.placements__row--between {
justify-content: space-between;
margin: var(--ns-spacing-3) 0;
}
</style>
宽度
width 默认 300,数字按 px 处理,也可以传带单位的字符串。问题文字超过宽度时自动换行。
<template>
<NsSpace wrap>
<NsPopconfirm title="这段文字比较长,超过气泡宽度以后会自动换行,按钮始终在最下面一行。">
<NsButton>默认宽度 300</NsButton>
</NsPopconfirm>
<NsPopconfirm
:width="220"
title="这段文字比较长,超过气泡宽度以后会自动换行,按钮始终在最下面一行。"
>
<NsButton>:width="220"</NsButton>
</NsPopconfirm>
<NsPopconfirm width="24em" title="宽度是 24em,字符串原样使用。">
<NsButton>width="24em"</NsButton>
</NsPopconfirm>
</NsSpace>
</template>
禁用
disabled 为 true 时点击触发元素不弹出气泡。
<script setup lang="ts">
import { ref } from 'vue'
import { NsButton, NsCheckbox, NsPopconfirm, NsSpace } from '@ns/ui'
const disabled = ref(true)
</script>
<template>
<NsSpace wrap>
<NsCheckbox v-model="disabled">禁用确认框</NsCheckbox>
<NsPopconfirm title="没被禁用时才会弹出来" :disabled="disabled">
<NsButton>点我</NsButton>
</NsPopconfirm>
</NsSpace>
</template>
确认后执行异步操作
confirm 触发时气泡已经收起,接着执行请求即可。请求期间让按钮显示加载状态,并禁用确认框,免得重复提交。
<script setup lang="ts">
import { ref } from 'vue'
import { NsButton, NsMessage, NsPopconfirm } from '@ns/ui'
const publishing = ref(false)
const publish = () => {
publishing.value = true
// 用定时器模拟请求
setTimeout(() => {
publishing.value = false
NsMessage.success('发布成功')
}, 1500)
}
const cancel = () => {
NsMessage('已取消发布')
}
</script>
<template>
<NsPopconfirm
title="发布后所有人都能看到,确定发布吗?"
icon="info"
icon-color="var(--ns-color-primary)"
confirm-button-text="发布"
:disabled="publishing"
@confirm="publish"
@cancel="cancel"
>
<NsButton type="primary" :loading="publishing" loading-text="发布中...">发布</NsButton>
</NsPopconfirm>
</template>
在列表里逐行确认
每一行各放一个 NsPopconfirm。打开一行的气泡后再点另一行,前一个会自动收起。
<script setup lang="ts">
import { ref } from 'vue'
import { NsPopconfirm, NsButton, NsSpace } from '@ns/ui'
const initialRows = [
{ id: 1, name: '张三' },
{ id: 2, name: '李四' },
{ id: 3, name: '王五' }
]
const rows = ref([...initialRows])
const remove = (id: number) => {
rows.value = rows.value.filter((row) => row.id !== id)
}
const reset = () => {
rows.value = [...initialRows]
}
</script>
<template>
<NsSpace direction="vertical" align="start">
<NsSpace v-for="row in rows" :key="row.id">
<span>{{ row.name }}</span>
<NsPopconfirm :title="`确定要删除 ${row.name} 吗?`" @confirm="remove(row.id)">
<NsButton size="small" type="danger">删除</NsButton>
</NsPopconfirm>
</NsSpace>
<NsButton v-if="rows.length < initialRows.length" size="small" @click="reset">
恢复数据
</NsButton>
</NsSpace>
</template>
挂载位置
气泡默认挂在 body 下。teleport 传 CSS 选择器可以挂到别的元素下,传 false 则留在组件所在的位置(传 true 等同于 'body')。
<template>
<NsPopconfirm title="留在组件所在的位置" :teleport="false">
<NsButton>:teleport="false"</NsButton>
</NsPopconfirm>
</template>
Props
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| title | string | - | 确认的问题 |
| confirmButtonText | string | '确定' | 确定按钮的文字 |
| cancelButtonText | string | '取消' | 取消按钮的文字 |
| confirmButtonType | ButtonType | 'primary' | 确定按钮的类型,取值见“类型” |
| cancelButtonType | ButtonType | 'default' | 取消按钮的类型 |
| icon | string | 'warning' | 图标名(NsIcon 的 name) |
| iconColor | string | - | 图标颜色。不传时是警告色 |
| hideIcon | boolean | false | 是否隐藏图标 |
| disabled | boolean | false | 是否禁用 |
| width | number | string | 300 | 气泡宽度,数字按 px 处理 |
| teleport | string | boolean | 'body' | 气泡挂到哪个元素下(CSS 选择器)。传 false 时留在组件所在的位置 |
| placement | PopperPlacement | 'top' | 气泡的位置,12 个取值同 NsPopover。放不下时自动翻到反方向 |
| offset | number | - | 气泡和触发元素的间距(px),不传时同 NsPopover 的默认值 |
Events
| 事件 | 回调参数 | 说明 |
|---|---|---|
| confirm | - | 点“确定”按钮时触发 |
| cancel | - | 点“取消”按钮时触发 |
Slots
| 插槽 | 作用域参数 | 说明 |
|---|---|---|
| default | - | 触发元素 |
| reference | - | 触发元素,优先于默认插槽 |
| title | - | 确认的问题,优先于 title 属性 |
类型
import type { PopconfirmProps, ButtonType, PopperPlacement } from '@ns/ui'
type ButtonType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'help' | 'default'
type PopperPlacement =
| 'top'
| 'top-start'
| 'top-end'
| 'bottom'
| 'bottom-start'
| 'bottom-end'
| 'left'
| 'left-start'
| 'left-end'
| 'right'
| 'right-start'
| 'right-end'
注意事项
- 只有点“取消”按钮才触发
cancel。点气泡以外的地方、按 Esc 也会收起气泡,但不触发任何事件。 - 固定是点击触发,组件没有
trigger属性,也不支持从外部打开、关闭。 - 气泡弹出后焦点会移到“取消”按钮上,可以直接用键盘操作:Tab 切到“确定”,Enter 或空格触发,Esc 收起。收起后焦点回到触发元素。
- 气泡默认出现在触发元素上方,放不下时自动翻到反方向,用
placement可以换位置。 - 放在对话框、抽屉里时,气泡显示着按 Esc 只收起气泡,不会把对话框、抽屉一起关掉。
default和reference两个插槽都写了时,只渲染reference,和 NsPopover 一致。
优化点
- [x] 把
placement、offset声明成正式的属性 - [ ] 支持
v-model:visible,从外部打开、关闭 - [ ] 支持异步确认:点“确定”后按钮显示加载状态,等操作完成再收起