New to KendoReactStart a free 30-day trial

WindowProps

Interface

Represents the props of the KendoReact Window component.

Definition

Package:@progress/kendo-react-dialogs

Properties

appendTo?

null | HTMLElement

Defines the container to which the Window will be appended. If set to null, the Window will be rendered without React Portal.

Default:

parent element

autoFocus?

boolean

Focus the Window container automatically when mounted.

Default:

true

Sets a class of the Window DOM element.

closeButton?

ComponentType​<any>

Specifies if the Window will render the close button.

Specifies if the Window stage will change on title double click.

Default:

true

draggable?

boolean

Specifies if the Window will be draggable (see example).

Default:

true

height?

null | number

Specifies the height of the Window (see example). When set to null, the window is automatically sized to fit its content.

id?

string

Sets the id attribute value of the wrapper element of the Window.

initialHeight?

null | number

Specifies the initial height of the Window (see example). The component will be in an uncontrolled mode.

Specifies the initial left value (see example). The Window will be in an uncontrolled mode.

Specifies the initial top value (see example). The component will be in an uncontrolled mode.

Specifies the initial width of the Window (see example). The component will be in an uncontrolled mode.

left?

number

Specifies the left coordinates of the Window.

maximizeButton?

ComponentType​<any>

Specifies if the Window will render the maximize button.

Specifies the minimum height of the Window (see example).

Default:

100

minimizeButton?

ComponentType​<any>

Specifies if the Window will render the minimize button.

minWidth?

number

Specifies the minimum width of the Window (see example).

Default:

120

boolean

Specifies if the Window will be modal by rendering an overlay under the component.

Default:

false

Fires when the Close button in the title is clicked or when the Esc button is pressed.

Parameters:eventWindowActionsEvent

onMove?

(event: WindowMoveEvent) => void

Fires when the Window is dragged.

Parameters:eventWindowMoveEvent

onResize?

(event: WindowMoveEvent) => void

Fires when the Window resizes.

Parameters:eventWindowMoveEvent

Fires when the DEFAULT, FULLSCREEN, or MINIMIZED state of the Window is changed.

Parameters:eventWindowActionsEvent

overlayStyle?

CSSProperties

Set styles to the Window overlay element rendered when the modal prop is enabled.

resizable?

boolean

Specifies if the Window will be resizable (see example).

Default:

true

restoreButton?

ComponentType​<any>

Specifies if the Window will render the restore button.

Specifies if the Window content will update during resizing.

stage?

string

Controls the state of the Window (see example).

The supported values are:

  • DEFAULT
  • MINIMIZED
  • FULLSCREEN

style?

CSSProperties

Set styles to the Window element.

title?

ReactNode

Specifies the title of the Window (see example).

top?

number

Specifies the top coordinates of the Window.

webMcp?

boolean | WebMcpProps

Enables Web MCP tool registration so AI agents can interact with this Window. Set to true to use the provider-level dataName, or pass a config object to override.

Requires a WebMcpProvider ancestor from @progress/kendo-react-webmcp.

width?

number

Specifies the width of the Window.