popup.en-US.md

:: BASE_DOC ::

API

Popup Props

name	type	default	description	required
attach	String / Function	'body'	Typescript：AttachNode。see more ts definition	N
content	String / Slot / Function	-	Typescript：string | TNode。see more ts definition	N
default	String / Slot / Function	-	Typescript：string | TNode。see more ts definition	N
delay	Number / Array	-	delay to show or hide popover。Typescript：number | Array<number>	N
destroyOnClose	Boolean	false	-	N
disabled	Boolean	-	-	N
hideEmptyPopup	Boolean	false	-	N
overlayClassName	String / Object / Array	-	Typescript：ClassName。see more ts definition	N
overlayInnerClassName	String / Object / Array	-	Typescript：ClassName。see more ts definition	N
overlayInnerStyle	Boolean / Object / Function	-	Typescript：Styles | ((triggerElement: HTMLElement, popupElement: HTMLElement) => Styles)。see more ts definition	N
overlayStyle	Boolean / Object / Function	-	Typescript：Styles | ((triggerElement: HTMLElement, popupElement: HTMLElement) => Styles)。see more ts definition	N
placement	String	top	Typescript：PopupPlacement type PopupPlacement = 'top'|'left'|'right'|'bottom'|'top-left'|'top-right'|'bottom-left'|'bottom-right'|'left-top'|'left-bottom'|'right-top'|'right-bottom'。see more ts definition	N
popperOptions	Object	-	popper initial options，details refer to https://popper.js.org/docs	N
showArrow	Boolean	false	-	N
trigger	String	hover	options: hover/click/focus/mousedown/context-menu	N
triggerElement	String / Slot / Function	-	Typescript：string | TNode。see more ts definition	N
visible	Boolean	-	v-model is supported。Typescript：boolean	N
defaultVisible	Boolean	-	uncontrolled property。Typescript：boolean	N
zIndex	Number	-	-	N
onScroll	Function		Typescript：(context: { e: WheelEvent }) => void	N
onScrollToBottom	Function		Typescript：(context: { e: WheelEvent }) => void	N
onVisibleChange	Function		Typescript：(visible: boolean, context: PopupVisibleChangeContext) => void see more ts definition。 interface PopupVisibleChangeContext { e?: PopupTriggerEvent; trigger?: PopupTriggerSource } type PopupTriggerEvent = MouseEvent | FocusEvent | KeyboardEvent type PopupTriggerSource = 'document' | 'trigger-element-click' | 'trigger-element-hover' | 'trigger-element-blur' | 'trigger-element-focus' | 'trigger-element-mousedown' | 'trigger-element-close' | 'context-menu' | 'keydown-esc'	N

Popup Events

name	params	description
scroll	(context: { e: WheelEvent })	-
scroll-to-bottom	(context: { e: WheelEvent })	-
visible-change	(visible: boolean, context: PopupVisibleChangeContext)	see more ts definition。 interface PopupVisibleChangeContext { e?: PopupTriggerEvent; trigger?: PopupTriggerSource } type PopupTriggerEvent = MouseEvent | FocusEvent | KeyboardEvent type PopupTriggerSource = 'document' | 'trigger-element-click' | 'trigger-element-hover' | 'trigger-element-blur' | 'trigger-element-focus' | 'trigger-element-mousedown' | 'trigger-element-close' | 'context-menu' | 'keydown-esc'

PopupInstanceFunctions 组件实例方法

name	params	return	description
getOverlay	-	HTMLElement	used to get overly html element
getOverlayState	-	{ hover: boolean }	get mouseover state of overlay
update	-	-	used to update overlay content