popup.md

:: BASE_DOC ::

API

Popup Props

名称	类型	默认值	说明	必传
attach	String / Function	'body'	制定挂载节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body。TS 类型：AttachNode。通用类型定义	N
content	String / Slot / Function	-	浮层里面的内容。TS 类型：`string	TNode`。通用类型定义
default	String / Slot / Function	-	触发元素，同 triggerElement。TS 类型：`string	TNode`。通用类型定义
destroyOnClose	Boolean	false	是否在关闭浮层时销毁浮层	N
disabled	Boolean	false	是否禁用组件	N
hideEmptyPopup	Boolean	false	【开发中】浮层是否隐藏空内容，默认不隐藏	N
overlayClassName	String / Object / Array	-	浮层类名，示例：'name1 name2 name3' 或 ['name1', 'name2'] 或 [{ 'name1': true }]。TS 类型：ClassName。通用类型定义	N
overlayStyle	Boolean / Object / Function	-	浮层样式，第一个参数 triggerElement 表示触发元素 DOM 节点，第二个参数 popupElement 表示浮层元素 DOM 节点。TS 类型：`Styles	((triggerElement: HTMLElement, popupElement: HTMLElement) => Styles)`。通用类型定义
placement	String	top	浮层出现位置。TS 类型：PopupPlacement `type PopupPlacement = 'top'	'left'
showArrow	Boolean	false	是否显示浮层箭头	N
trigger	String	hover	触发浮层出现的方式。可选项：hover/click/focus/context-menu	N
triggerElement	String / Slot / Function	-	触发元素。TS 类型：`string	TNode`。通用类型定义
visible	Boolean	false	是否显示浮层。支持语法糖 v-model。TS 类型：boolean	N
defaultVisible	Boolean	false	是否显示浮层。非受控属性。TS 类型：boolean	N
zIndex	Number	-	组件层级，Web 侧样式默认为 5500，移动端和小程序样式默认为 1500	N
onScroll	Function		TS 类型：(context: { e: WheelEvent }) => void 下拉选项滚动事件	N
onVisibleChange	Function		TS 类型：(visible: boolean, context: PopupVisibleChangeContext) => void 当浮层隐藏或显示时触发，trigger=document 表示点击非浮层元素触发；trigger=document 表示右击触发。详细类型定义。 interface PopupVisibleChangeContext { e?: PopupTriggerEvent; trigger?: PopupTriggerSource } `type PopupTriggerEvent = MouseEvent	FocusEvent

Popup Events

名称	参数	描述
scroll	(context: { e: WheelEvent })	下拉选项滚动事件
visible-change	(visible: boolean, context: PopupVisibleChangeContext)	当浮层隐藏或显示时触发，trigger=document 表示点击非浮层元素触发；trigger=document 表示右击触发。详细类型定义。 interface PopupVisibleChangeContext { e?: PopupTriggerEvent; trigger?: PopupTriggerSource } `type PopupTriggerEvent = MouseEvent