反馈类

气泡确认框

目标元素的操作需要用户进一步的确认时使用。与 Popover 相比它内置了一系列可配置的操作按钮,与 Modal 相比它不强制全屏居中显示,交互也更轻量

代码演示

如何引入

<script lang="ts">
    import { Popconfirm } from '@fibrae/semi-ui-svelte';
</script>

基本使用

Popconfirm 底层基于 Tooltip 封装,Children 支持类型同 Tooltip,注意事项详情可查阅 Tooltip注意事项

代码
<script lang="ts">
    import { Button, Popconfirm, Toast } from '@fibrae/semi-ui-svelte';

    const onConfirm = () => {
        Toast.success('确认保存!');
    };

    const onCancel = () => {
        Toast.warning('取消保存!');
    };
</script>

<Popconfirm {onCancel} {onConfirm} title="确定是否要保存此修改?">
    <Button>保存</Button>
    {#snippet content()}此修改将不可逆{/snippet}
</Popconfirm>

类型搭配

开发者可以基于场景使用 okType/cancelType 参数和 icon snippet 搭配出不同风格的气泡式确认框。没有传入 icon 时显示默认警告图标,传入 icon={null} 则不渲染图标。

代码
<script lang="ts">
    import { IconAlertTriangle } from '@fibrae/semi-icons-svelte';
    import { Button, Popconfirm, Radio, RadioGroup, type RadioValue } from '@fibrae/semi-ui-svelte';

    type TypeKey = 'default' | 'warning' | 'danger' | 'tertiary';

    const typeMap: Record<TypeKey, { okType?: 'danger'; color?: string }> = {
        default: {},
        warning: { color: 'var(--semi-color-warning)' },
        danger: { okType: 'danger', color: 'var(--semi-color-danger)' },
        tertiary: { color: 'var(--semi-color-tertiary)' },
    };
    const keys = Object.keys(typeMap) as TypeKey[];
    let value = $state<RadioValue | undefined>('default');
    let visible = $state(true);
    const type = $derived(keys.find((key) => key === value) ?? 'default');
</script>

<div>
    <RadioGroup bind:value style="margin-top: 14px; margin-bottom: 14px" type="button">
        {#each keys as key (key)}
            <Radio value={key}>
                <span style={`color: var(--semi-color-${key === 'default' ? 'primary' : key})`}>{key}</span>
            </Radio>
        {/each}
    </RadioGroup>
    <div>
        <Popconfirm bind:visible okType={typeMap[type].okType} title="确定是否要保存此修改?" trigger="custom">
            <Button onclick={() => (visible = !visible)}>点击此处</Button>
            {#snippet icon()}
                <IconAlertTriangle size="extra-large" style={typeMap[type].color ? `color: ${typeMap[type].color}` : undefined} />
            {/snippet}
            {#snippet content()}此修改将不可逆{/snippet}
        </Popconfirm>
    </div>
</div>

延时关闭

onConfirm、onCancel 可以通过 return Promise 实现点击后延时关闭。
onCancel、onConfirm 被触发时,对应的 Button 会自动切换为 loading: true, promise solve 会关闭气泡确认框, promise reject时气泡依然保留,同时 button loading 自动切换为 false

代码
<script lang="ts">
    import { Button, Popconfirm } from '@fibrae/semi-ui-svelte';

    const onConfirm = () =>
        new Promise<void>((resolve) => {
            setTimeout(() => {
                console.log('resolve,close popconfirm');
                resolve();
            }, 2000);
        });

    const onCancel = () =>
        new Promise<void>((_resolve, reject) => {
            setTimeout(() => {
                console.log('reject, popconfirm still exist');
                reject();
            }, 2000);
        });
</script>

<Popconfirm {onCancel} {onConfirm} title="确定是否要保存此修改?">
    <Button>保存</Button>
    {#snippet content()}此修改将不可逆{/snippet}
</Popconfirm>

初始化弹出层焦点位置

okButtonProps 和 cancelButtonProps 支持传入 autoFocus 参数,传入后打开面板时会自动聚焦在该位置。

content snippet 的参数为 { initialFocusRef },用 {@attach initialFocusRef} 把它绑定在可聚焦 DOM 或组件上,打开面板时会自动聚焦在该位置。同时指定按钮 autoFocus 与 initialFocusRef 时,按钮优先。

代码
<script lang="ts">
    import { Button, Popconfirm, Space } from '@fibrae/semi-ui-svelte';
</script>

{#snippet text()}此修改将不可逆{/snippet}

<Space>
    <Popconfirm content={text} okButtonProps={{ autoFocus: true, type: 'danger' }} title="确定是否要保存此修改?">
        <Button>确认聚焦</Button>
    </Popconfirm>
    <Popconfirm cancelButtonProps={{ autoFocus: true }} content={text} title="确定是否要保存此修改?">
        <Button>取消聚焦</Button>
    </Popconfirm>
    <Popconfirm title="确定是否要保存此修改?">
        <Button>内容聚焦</Button>
        {#snippet content({ initialFocusRef })}
            <input {@attach initialFocusRef} placeholder="focus here" />
        {/snippet}
    </Popconfirm>
</Space>

搭配 Tooltip 或 Popover 使用

请参考搭配使用

API 参考

Props

属性说明类型默认值
afterClose确认框关闭且离场动画结束后调用。TooltipProps['afterClose']-
afterOpen确认框打开且进场动画结束后调用;没有进场动画时打开后即调用,受控与非受控相同;进场结束前被关闭的打开不调用。TooltipProps['afterOpen']-
aria-describedby对话框的 aria-describedby,缺省在同时有标题和内容时指向内容。string-
aria-label对话框的 aria-label,传入后优先于标题。string-
aria-labelledby对话框的 aria-labelledby,缺省指向标题,没有标题时指向内容。string-
arrowPointAtCenter箭头是否指向触发元素中心,需要同时开启 showArrow。boolean-
arrowStyle箭头的边框色、背景色与边框透明度。ArrowStyle-
autoAdjustOverflow弹出层被遮挡时是否自动调整方向。boolean-
cancelButtonProps取消按钮的属性,autoFocus 为 true 时打开后聚焦该按钮,onclick 先于内置的取消处理执行。PopconfirmButtonProps-
cancelText取消按钮文字,缺省取语言包 Popconfirm.cancel。string-
cancelType取消按钮类型。ButtonType"tertiary"
child直接渲染触发元素的 snippet,参数 { props } 必须整体展开到触发元素上;传了 child 时 children 不再生效。TooltipProps['child']-
children触发元素的 snippet,会被包进 Tooltip 自己的 span,由该 span 接收触发属性。TooltipProps['children']-
class确认卡片的类名。string-
clickToHide点击弹出层及其内部任一元素时是否关闭。boolean-
closeOnEsc弹出层打开期间按 Esc 是否关闭确认框;trigger 为 custom 时只调用 onEscKeyDown,由使用方决定是否关闭。boolean-
condition是否允许触发显示;仅显式设为 false 时,hover、click、focus 等触发行为不生效。由 true 变为 false 时立即关闭已显示的确认框;visible 受控时只调用 onVisibleChange(false),使用方回写后才关闭。boolean-
content确认框内容的 snippet,参数 { initialFocusRef } 是回调,可直接写 {@attach initialFocusRef} 绑定到打开时需要聚焦的元素;不传时不渲染内容区。TypeSnippet<[RenderContentProps]>-
contentClassName内容容器的类名。ClassValue-
disableArrowKeyDown是否禁用在触发元素上按方向键把焦点移入确认框。boolean-
disabled是否禁用;禁用时只渲染触发元素,不弹出确认框。booleanfalse
disableFocusListenertrigger 为 hover 时,是否不响应键盘聚焦打开。boolean-
guardFocus焦点位于确认框内时,Tab 是否在其中循环。boolean-
icon自定义图标的 snippet;不传时显示默认警告图标,传入 null 则不渲染图标。Snippet | null-
keepDOM关闭时是否保留内容而不销毁。boolean-
motion是否展示弹出动画。boolean-
mouseEnterDelay指针移入后延迟显示的毫秒数,仅 trigger 为 hover 或 focus 时生效。number-
mouseLeaveDelay指针移出后延迟隐藏的毫秒数,仅 trigger 为 hover 或 focus 时生效。number-
okButtonProps确认按钮的属性,autoFocus 为 true 时打开后聚焦该按钮,onclick 先于内置的确认处理执行。PopconfirmButtonProps-
okText确认按钮文字,缺省取语言包 Popconfirm.confirm(zh_CN 为「确定」)。string-
okType确认按钮类型。ButtonType"primary"
onCancel点击取消按钮或关闭按钮的回调,参数是按钮的原生 click 事件;返回 Promise 时按钮保持加载,落定后才关闭,reject 时保留确认框。Type(event: MouseEvent) => Promise<unknown> | void-
onClickOutSide确认框打开时在触发元素与确认框以外的区域按下鼠标时调用,仅 trigger 为 click、contextMenu 或 custom 时有效。TooltipProps['onClickOutSide']-
onConfirm点击确认按钮的回调,参数是按钮的原生 click 事件;返回 Promise 时按钮保持加载,落定后才关闭,reject 时保留确认框。Type(event: MouseEvent) => Promise<unknown> | void-
onEscKeyDowncloseOnEsc 为 true 时,确认框打开期间按 Esc 调用。TooltipProps['onEscKeyDown']-
onOpen确认框显示、进场动画开始时调用,每次打开一次,早于 afterOpen,受控与非受控相同;悬停打开后指针已离开而撤回的打开不调用。TooltipProps['onOpen']-
onVisibleChange显示状态变化时调用;visible 受控时只报告用户交互发起的请求,使用方自己改变 visible 不调用。TooltipProps['onVisibleChange']-
position弹出层相对触发元素的位置,共十二个方向。TooltipProps['position']-
prefixCls确认卡片的类名前缀。string"semi-popconfirm"
returnFocusOnClose关闭后焦点是否回到触发元素;受控的 visible 也照常生效,trigger 为 custom 时不生效。boolean-
role弹出层的 ARIA role,缺省为 dialog。string"dialog"
showArrow是否显示箭头三角形。boolean-
showCloseIcon是否显示右上角关闭按钮。booleantrue
spacing弹出层与触发元素的距离,单位为像素;对象形式分别设置水平与垂直方向。number | { x: number; y: number }-
stopPropagation是否阻止弹出层上的 click、mousedown 与焦点进出事件冒泡。boolean | stringtrue
style确认卡片的样式字符串。string-
title标题,可以是字符串或 snippet,同时作为对话框的可访问名称。string | Snippet-
trigger触发展示的时机,可选 hover、focus、click、contextMenu 或 custom。custom 时显示与否完全由 visible 决定。TooltipProps['trigger']"click"
visible是否展示,可用 bind:visible 双向绑定;传入后由该值决定显示,trigger 保持原值,触发器事件仍然生效。boolean-

Methods

方法说明类型
focusTrigger让触发元素获得焦点,仅在 returnFocusOnClose 为 true 且 trigger 不是 custom 时生效;disabled 时调用无效果。Type() => void

class、style 落在确认卡片上,okButtonProps、cancelButtonProps 中的属性落在对应按钮上(autoFocus 除外);bind:this 收到 focusTrigger 句柄。Popconfirm 没有根 DOM 元素,其他未声明的原生属性和事件会被丢弃。

Accessibility

ARIA

  • 无论 trigger 是什么(包括 hover、focus),Popconfirm 的弹出层都具有 dialog role,以 title 命名(没有 title 时以 content 命名);可用 role 属性覆盖
  • 其余语义化请参考 Popover

键盘和焦点

  • Popconfirm 必须带有触发器,触发器可被聚焦,使用 Enter 键打开 Popconfirm
  • Popconfirm 激活后,按下方向键 ⬇️ 将焦点移动到 Popconfirm 上。Popconfirm 的初始焦点应当遵循以下几个原则:
    • 如果 Popconfirm 内包含一个不可逆转过程的最后一个步骤,比如:删除数据等,那么这个初始焦点最好放在破坏性最小的可交互元素上,如:关闭按钮 ( 通过向对象 cancelButtonProps 中传入 autoFocus 实现)
    • 如果 Popconfirm 内仅为阅读文本,那么建议将初始焦点设置在最可能常用的交互元素上,如:确定按钮 ( 通过向对象 okButtonProps 中传入 autoFocus 实现)
  • 键盘用户能够通过按 Esc 关闭 Popconfirm,并且焦点应该返回到触发器上。用户通过 Popconfirm 内的交互元素关闭该 Pop 后,焦点也应当返回到触发器上(trigger 为 custom 时除外)
  • 打开的情况下,用户点击 Popconfirm 内的空白处 Esc 后,焦点也会回到触发器上 (trigger 为 custom 时除外)

设计变量

下表是组件内部的 Sass 变量,不能覆写。定制样式请覆写 --semi-* CSS 变量(见 Design Token 页),或写不分层的 CSS 规则。
Sass 变量值用法
$color-popconfirm_header-textvar(--semi-color-text-0)标题文字颜色
$color-popconfirm_body-textvar(--semi-color-text-2)正文文字颜色
$color-popconfirm_header_alert-iconvar(--semi-color-warning)警示图标颜色
$width-popconfirm-icon24px图标宽度
$width-popconfirm-maxWidth400px整体最大宽度
$spacing-popconfirm-top24px顶部内边距
$spacing-popconfirm-bottom20px底部内边距
$spacing-popconfirm_with_arrow-padding12px顶部内边距
$spacing-popconfirm_header_title-marginBottom8pxheader 标题底部外边距
$spacing-popconfirm_body_p-padding0body 正文内边距
$spacing-popconfirm_body_p-margin0body 正文外边距
$spacing-popconfirm_footer-marginTop25pxfooter 顶部外边距
$spacing-popconfirm_footer_btn-marginRight8pxfooter 按钮右侧外边距
$spacing-popconfirm_popover_with_arrow_inner-padding($spacing-popconfirm-top - $spacing-popconfirm_with_arrow-padding) ($spacing-popconfirm-top - $spacing-popconfirm_with_arrow-padding) ($spacing-popconfirm-top - $spacing-popconfirm_with_arrow-padding) ($spacing-popconfirm-bottom - $spacing-popconfirm_with_arrow-padding)带三角形箭头时的内边距
$spacing-popconfirm_popover_with_arrow_inner_rtl-padding($spacing-popconfirm-top - $spacing-popconfirm_with_arrow-padding) ($spacing-popconfirm-bottom - $spacing-popconfirm_with_arrow-padding) ($spacing-popconfirm-top - $spacing-popconfirm_with_arrow-padding) ($spacing-popconfirm-top - $spacing-popconfirm_with_arrow-padding)带三角形箭头时的内边距(rtl)
$spacing-popconfirm_header_icon-marginRight12pxheader 图标的右侧外边距
$font-popconfirm_header_title-fontWeight$font-weight-boldheader 标题字重
$radius-popconfirm-popovervar(--semi-border-radius-medium)气泡确认框圆角大小

FAQ

  • 为什么 Popconfirm 浮层在靠近屏幕边界宽度不够时,丢失宽度意外换行?
    在 chromium 104 后 对于屏幕边界文本宽度不够时的换行渲染策略发生变化,详细原因可查看 issue #1022,semi侧已经在v2.17.0版本修复了这个问题。