WindowProps
Represents the props of the Kendo UI for Vue Window component.
Definition
Package:@progress/kendo-vue-dialogs
Properties
appendTo?
string
Sets the CSS selector of the element to which the Window is appended.
When you do not set it, the Window is appended to the body element.
closeButton?
string | boolean | object | Function
Sets a custom template for the Close button. Accepts a slot name (string), a functional component, or a class component.
Set it to false to hide the button. When you do not set it, the Window renders the default button.
dir?
string
Sets the dir HTML attribute of the Window. Use it to switch between LTR and RTL.
The supported values are:
"ltr""rtl"
doubleClickStageChange?
boolean
Sets if the Window changes its stage when the user double-clicks the title bar.
true
draggable?
boolean
Sets if the user can drag the Window (see example).
true
height?
number
Sets the height of the Window in pixels (see example).
id?
string
Sets the id of the Window.
initialHeight?
number
Sets the initial height of the Window in pixels (see example). When you use it, the Window works in uncontrolled mode.
initialLeft?
number
Sets the initial left position of the Window in pixels (see example).
When you use it, the Window works in uncontrolled mode.
initialTop?
number
Sets the initial top position of the Window in pixels (see example).
When you use it, the Window works in uncontrolled mode.
initialWidth?
number
Sets the initial width of the Window in pixels (see example). When you use it, the Window works in uncontrolled mode.
left?
number
Sets the left position of the Window in pixels.
maximizeButton?
string | boolean | object | Function
Sets a custom template for the Maximize button. Accepts a slot name (string), a functional component, or a class component.
Set it to false to hide the button. When you do not set it, the Window renders the default button.
minHeight?
number
Sets the minimum height of the Window in pixels (see example).
100
minimizeButton?
string | boolean | object | Function
Sets a custom template for the Minimize button. Accepts a slot name (string), a functional component, or a class component.
Set it to false to hide the button. When you do not set it, the Window renders the default button.
minWidth?
number
Sets the minimum width of the Window in pixels (see example).
120
modal?
boolean
Sets if the Window is modal. A modal Window renders an overlay below it and sets the aria-modal attribute.
false
onClose?
(event: WindowActionsEvent) => void
Fires when the user clicks the Close button in the title bar or presses Esc.
onMove?
(event: WindowMoveEvent) => void
Fires when the user moves the Window by dragging it or with the keyboard.
onOverlayclick?
(event: any) => void
Fires when the user clicks the modal overlay of the Window.
onResize?
(event: WindowMoveEvent) => void
Fires when the user resizes the Window.
onStagechange?
(event: WindowActionsEvent) => void
Fires when the stage of the Window changes to DEFAULT, FULLSCREEN, or MINIMIZED.
resizable?
boolean
Sets if the user can resize the Window (see example).
true
restoreButton?
string | boolean | object | Function
Sets a custom template for the Restore button. Accepts a slot name (string), a functional component, or a class component.
Set it to false to hide the button. When you do not set it, the Window renders the default button.
shouldUpdateOnDrag?
boolean
Sets if the Window content updates while the user resizes the Window.
stage?
string
title?
any
Sets the title of the Window (see example).
The Window uses the title as its accessible name through aria-labelledby.
titleRender?
string | object | Function
Sets a custom template for the title. Accepts a slot name (string), a functional component, or a class component.
top?
number
Sets the top position of the Window in pixels.
width?
number
Sets the width of the Window in pixels.
windowClass?
string
Sets a CSS class on the Window element.
windowStyle?
object
Sets the styles of the Window element.