New to Kendo UI for Vue? Start a free 30-day trial

PopupProps

Interface

Represents the props of the Kendo UI for Vue Popup component.

Definition

Package:@progress/kendo-vue-popup

Properties

anchor?

string | HTMLElement

Sets the anchor element of the Popup (see example). The Popup opens next to this element. Accepts an HTMLElement, a ref name, or an id.

Default:

''

Sets the point of the anchor to which the Popup aligns (see example).

Default:

{ horizontal: 'left', vertical: 'bottom' }

Sets the animation of the Popup (see example). Set a boolean value to turn the default animation on or off. Set a PopupAnimation object to set custom durations for the opening and closing animations.

Default:

true

appendTo?

string | HTMLElement

Sets the container to which the Popup is appended. Accepts an HTMLElement, a ref name, or an id. When you do not set it, the Popup is appended to the body element.

Default:

''

Sets the aria-describedby attribute of the Popup element. Use the id of the element that describes the Popup.

Sets the aria-labelledby attribute of the Popup element. Use the id of the element that labels the Popup.

className?

string | string[] | { [key: string]: boolean }

Sets a list of CSS classes on the root element of the Popup.

Sets the collision behavior of the Popup (see example).

Default:

{ horizontal: 'fit', vertical: 'flip' }

Sets the direction of the slide animation.

Default:

down

id?

string

Sets the id of the root element of the Popup.

margin?

{ horizontal?: number; vertical?: number }

Sets the horizontal and vertical margin between the Popup and its anchor in pixels.

Sets the absolute position of the Popup (see example). The Popup opens next to this point. The popupAlign setting sets the point of the Popup that aligns to the offset. The Popup uses the window viewport for boundary detection.

Default:

{ left: -1000, top: 0 }

onClose?

(event: CloseEvent) => void

Fires after the Popup closes.

Parameters:eventCloseEvent

Fires when the user presses the mouse button outside the Popup.

Parameters:eventMouseDownOutsideEvent
Example:
vue
<Popup @mousedownoutside="onMouseDownOutside" />

onOpen?

(event: OpenEvent) => void

Fires after the Popup opens and the opening animation ends.

Parameters:eventOpenEvent

onPosition?

(event: PositionEvent) => void

Fires after the Popup calculates its position.

Parameters:eventPositionEvent

Sets the point of the Popup that aligns to the anchor (see example).

Default:

{ horizontal: 'left', vertical: 'top' }

popupClass?

string | string[] | { [key: string]: boolean }

Sets a list of CSS classes on the inner k-popup element (see example).

positionMode?

"absolute" | "fixed"

Sets the CSS position of the Popup.

The supported values are:

  • absolute
  • fixed

role?

string

Sets the role attribute of the Popup element.

scale?

number

Sets the document scale that the Popup uses to calculate its position.

show?

boolean

Sets if the Popup is visible (see example).

Default:

false

Sets the styles of the Popup.