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

WindowProps

Interface

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"

Sets if the Window changes its stage when the user double-clicks the title bar.

Default:

true

draggable?

boolean

Sets if the user can drag the Window (see example).

Default:

true

height?

number

Sets the height of the Window in pixels (see example).

id?

string

Sets the id of the Window.

Sets the initial height of the Window in pixels (see example). When you use it, the Window works in uncontrolled mode.

Sets the initial left position of the Window in pixels (see example). When you use it, the Window works in uncontrolled mode.

Sets the initial top position of the Window in pixels (see example). When you use it, the Window works in uncontrolled mode.

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.

Sets the minimum height of the Window in pixels (see example).

Default:

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).

Default:

120

boolean

Sets if the Window is modal. A modal Window renders an overlay below it and sets the aria-modal attribute.

Default:

false

Fires when the user clicks the Close button in the title bar or presses Esc.

Parameters:eventWindowActionsEvent

onMove?

(event: WindowMoveEvent) => void

Fires when the user moves the Window by dragging it or with the keyboard.

Parameters:eventWindowMoveEvent

onOverlayclick?

(event: any) => void

Fires when the user clicks the modal overlay of the Window.

Parameters:eventany

onResize?

(event: WindowMoveEvent) => void

Fires when the user resizes the Window.

Parameters:eventWindowMoveEvent

Fires when the stage of the Window changes to DEFAULT, FULLSCREEN, or MINIMIZED.

Parameters:eventWindowActionsEvent

resizable?

boolean

Sets if the user can resize the Window (see example).

Default:

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.

Sets if the Window content updates while the user resizes the Window.

stage?

string

Sets the stage of the Window (see example).

The supported values are:

  • DEFAULT
  • MINIMIZED
  • FULLSCREEN

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.

Sets a CSS class on the Window element.

Sets the styles of the Window element.