Skip to content

Alert 警告提示

YhAlert 用于展示需要用户立即关注的重要提示信息,支持语义状态、滚动公告、自动关闭和自定义操作区。

基础状态

通过 type 可以快速切换成功、信息、警告和错误四种语义状态。

基础状态

关闭与图标

组件默认不显示关闭按钮。开启 closable 后可手动关闭,开启 show-icon 后会显示状态图标。

关闭与图标

滚动公告

内容较长时可以开启 scrollable,并通过 scroll-speedpause-on-hover 控制滚动节奏。

滚动公告

自动关闭

设置 duration 后,提示会在指定时间后自动关闭;开启 show-progress 后,会在底部显示倒计时进度条。

自动关闭

主题效果

effect 支持 lightdarkoutlineglass 四种视觉风格。

主题效果

在 Nuxt 中使用

接入 @yh-ui/nuxt 后,可直接在页面中使用 YhAlert。组件初始渲染不依赖浏览器专属 API,因此 SSR 阶段可以正常输出静态内容,自动关闭与悬停暂停会在客户端激活后生效。

在 Nuxt 中使用

API

Props

名称说明类型默认值
title标题文本string''
description描述文本string''
type提示类型'success' | 'info' | 'warning' | 'error''info'
effect视觉风格'light' | 'dark' | 'outline' | 'glass''light'
closable是否显示关闭按钮booleanfalse
close-text自定义关闭按钮文案string''
close-icon自定义关闭图标组件或图标名string | Component''
show-icon是否显示状态图标booleanfalse
icon自定义状态图标组件或图标名string | Component''
center内容是否居中booleanfalse
scrollable是否开启滚动公告模式booleanfalse
scroll-speed完成一轮滚动所需秒数number15
pause-on-hover悬停时是否暂停滚动booleantrue
duration自动关闭时长,单位毫秒,0 表示不自动关闭number0
show-progress自动关闭时是否显示进度条booleanfalse
theme-overrides组件级主题覆盖ComponentThemeVarsundefined

Events

名称说明参数
close点击关闭按钮时触发(event: MouseEvent)

Slots

名称说明
default描述内容
title标题内容
icon自定义状态图标
close自定义关闭区域
action自定义操作区

Expose

当前组件未暴露公开实例方法或属性。

类型导出

名称说明
YhAlertPropsYhAlert 的 props 类型
YhAlertEmitsYhAlert 的 emits 类型
YhAlertSlotsYhAlert 的 slots 类型
YhAlertType提示类型联合类型
YhAlertEffect视觉风格联合类型
YhAlertInstance组件实例类型

主题变量

YhAlert 没有完整暴露一组独立的组件级专属主题变量,当前样式主要依赖全局主题令牌。滚动公告模式额外消费下方变量,组件仍支持通过 themeOverrides 参与主题覆盖。

变量名说明默认值
--yh-alert-scroll-speed滚动公告动画时长15s

Released under the MIT License.