@progress/kendo-react-dialogs 12.0.2-develop.3 → 12.0.2-develop.5

package/index.d.mts

@@ -75,7 +75,9 @@ export declare interface DialogHandle {
  */
 export declare interface DialogProps {
     /**
-     * Set the focus the Dialog container automatically when mounted. By default, the `autoFocus` is `false`.
+     * Set the focus the Dialog container automatically when mounted.
+     *
+     * @default false
      *
      * @example
      * ```jsx
@@ -93,7 +95,7 @@ export declare interface DialogProps {
      */
     autoFocusedElement?: string;
     /**
-     * Sets the title of the Dialog ([see example]({% slug title_dialog %})). If `title` is not specified, the Dialog does not render a **Close** button.
+     * Sets the title of the Dialog ([see example]({% slug title_dialog %})). If you do not specify the `title`, the Dialog does not render a **Close** button.
      *
      * @example
      * ```jsx
@@ -113,6 +115,8 @@ export declare interface DialogProps {
     /**
      * Specifies whether a close button should be rendered at the top corner of the dialog.
      *
+     * @default true
+     *
      * @example
      * ```jsx
      * <Dialog closeIcon={true} />
@@ -120,7 +124,9 @@ export declare interface DialogProps {
      */
     closeIcon?: boolean;
     /**
-     * Specifies if the Dialog will be modal by rendering an overlay under the component. Defaults to `true`.
+     * Specifies if the Dialog will be modal by rendering an overlay under the component.
+     *
+     * @default true
      *
      * @example
      * ```jsx
@@ -214,9 +220,11 @@ export declare interface DialogProps {
      */
     contentStyle?: React.CSSProperties;
     /**
-     * Defines the container to which the Dialog will be appended. Defaults to body.
+     * Defines the container to which the Dialog will be appended.
      * * If set to `null` the Dialog will be rendered without React Portal.
      *
+     * @default document.body
+     *
      * @example
      * ```jsx
      * <Dialog appendTo={document.getElementById('container')} />
@@ -282,6 +290,9 @@ declare interface WindowActionsBarProps {
 }
 
 export declare interface WindowActionsEvent extends BaseEvent<Window_2> {
+    /**
+     * The current stage state of the Window.
+     */
     state?: 'DEFAULT' | 'FULLSCREEN' | 'MINIMIZED';
 }
 
@@ -339,8 +350,9 @@ export declare interface WindowMoveEvent {
  */
 export declare interface WindowProps {
     /**
-     * Defines the container to which the Window will be appended. Defaults to its parent element.
-     * If set to `null`, the Window will be rendered without React Portal.
+     * 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
      *
      * @example
      * ```jsx
@@ -349,7 +361,9 @@ export declare interface WindowProps {
      */
     appendTo?: HTMLElement | null;
     /**
-     * Focus the Window container automatically when mounted. By default, the `autoFocus` is `true`.
+     * Focus the Window container automatically when mounted.
+     *
+     * @default true
      *
      * @example
      * ```jsx
@@ -371,7 +385,9 @@ export declare interface WindowProps {
      */
     closeButton?: React.ComponentType<any>;
     /**
-     * Specifies if the Window stage will change on title double click. This is on by default.
+     * Specifies if the Window stage will change on title double click.
+     *
+     * @default true
      *
      * @example
      * ```jsx
@@ -382,6 +398,8 @@ export declare interface WindowProps {
     /**
      * Specifies if the Window will be draggable ([see example]({% slug positioningdragging_window %}#toc-dragging)).
      *
+     * @default true
+     *
      * @example
      * ```jsx
      * <Window draggable={true} />
@@ -389,8 +407,7 @@ export declare interface WindowProps {
      */
     draggable?: boolean;
     /**
-     * Specifies the height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-dimensions)).
-     * When set to null the window is automatically sized to fit its content.
+     * Specifies the height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-dimensions)). When set to `null`, the window is automatically sized to fit its content.
      *
      * @example
      * ```jsx
@@ -455,6 +472,8 @@ export declare interface WindowProps {
     /**
      * Specifies the minimum height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
      *
+     * @default 100
+     *
      * @example
      * ```jsx
      * <Window minHeight={100} />
@@ -464,6 +483,8 @@ export declare interface WindowProps {
     /**
      * Specifies the minimum width of the Window ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
      *
+     * @default 120
+     *
      * @example
      * ```jsx
      * <Window minWidth={100} />
@@ -482,6 +503,8 @@ export declare interface WindowProps {
     /**
      * Specifies if the Window will be modal by rendering an overlay under the component.
      *
+     * @default false
+     *
      * @example
      * ```jsx
      * <Window modal={true} />
@@ -491,6 +514,8 @@ export declare interface WindowProps {
     /**
      * Specifies if the Window will be resizable ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
      *
+     * @default true
+     *
      * @example
      * ```jsx
      * <Window resizable={true} />
@@ -727,6 +752,9 @@ export declare class WindowWithoutContext extends React_2.Component<WindowProps,
      * @hidden
      */
     windowTitle?: any;
+    /**
+     * The draggable handle for the Window component.
+     */
     draggable: Draggable | null;
     private windowCoordinatesState?;
     private offSetCoordinates?;

package/index.d.ts

@@ -75,7 +75,9 @@ export declare interface DialogHandle {
  */
 export declare interface DialogProps {
     /**
-     * Set the focus the Dialog container automatically when mounted. By default, the `autoFocus` is `false`.
+     * Set the focus the Dialog container automatically when mounted.
+     *
+     * @default false
      *
      * @example
      * ```jsx
@@ -93,7 +95,7 @@ export declare interface DialogProps {
      */
     autoFocusedElement?: string;
     /**
-     * Sets the title of the Dialog ([see example]({% slug title_dialog %})). If `title` is not specified, the Dialog does not render a **Close** button.
+     * Sets the title of the Dialog ([see example]({% slug title_dialog %})). If you do not specify the `title`, the Dialog does not render a **Close** button.
      *
      * @example
      * ```jsx
@@ -113,6 +115,8 @@ export declare interface DialogProps {
     /**
      * Specifies whether a close button should be rendered at the top corner of the dialog.
      *
+     * @default true
+     *
      * @example
      * ```jsx
      * <Dialog closeIcon={true} />
@@ -120,7 +124,9 @@ export declare interface DialogProps {
      */
     closeIcon?: boolean;
     /**
-     * Specifies if the Dialog will be modal by rendering an overlay under the component. Defaults to `true`.
+     * Specifies if the Dialog will be modal by rendering an overlay under the component.
+     *
+     * @default true
      *
      * @example
      * ```jsx
@@ -214,9 +220,11 @@ export declare interface DialogProps {
      */
     contentStyle?: React.CSSProperties;
     /**
-     * Defines the container to which the Dialog will be appended. Defaults to body.
+     * Defines the container to which the Dialog will be appended.
      * * If set to `null` the Dialog will be rendered without React Portal.
      *
+     * @default document.body
+     *
      * @example
      * ```jsx
      * <Dialog appendTo={document.getElementById('container')} />
@@ -282,6 +290,9 @@ declare interface WindowActionsBarProps {
 }
 
 export declare interface WindowActionsEvent extends BaseEvent<Window_2> {
+    /**
+     * The current stage state of the Window.
+     */
     state?: 'DEFAULT' | 'FULLSCREEN' | 'MINIMIZED';
 }
 
@@ -339,8 +350,9 @@ export declare interface WindowMoveEvent {
  */
 export declare interface WindowProps {
     /**
-     * Defines the container to which the Window will be appended. Defaults to its parent element.
-     * If set to `null`, the Window will be rendered without React Portal.
+     * 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
      *
      * @example
      * ```jsx
@@ -349,7 +361,9 @@ export declare interface WindowProps {
      */
     appendTo?: HTMLElement | null;
     /**
-     * Focus the Window container automatically when mounted. By default, the `autoFocus` is `true`.
+     * Focus the Window container automatically when mounted.
+     *
+     * @default true
      *
      * @example
      * ```jsx
@@ -371,7 +385,9 @@ export declare interface WindowProps {
      */
     closeButton?: React.ComponentType<any>;
     /**
-     * Specifies if the Window stage will change on title double click. This is on by default.
+     * Specifies if the Window stage will change on title double click.
+     *
+     * @default true
      *
      * @example
      * ```jsx
@@ -382,6 +398,8 @@ export declare interface WindowProps {
     /**
      * Specifies if the Window will be draggable ([see example]({% slug positioningdragging_window %}#toc-dragging)).
      *
+     * @default true
+     *
      * @example
      * ```jsx
      * <Window draggable={true} />
@@ -389,8 +407,7 @@ export declare interface WindowProps {
      */
     draggable?: boolean;
     /**
-     * Specifies the height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-dimensions)).
-     * When set to null the window is automatically sized to fit its content.
+     * Specifies the height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-dimensions)). When set to `null`, the window is automatically sized to fit its content.
      *
      * @example
      * ```jsx
@@ -455,6 +472,8 @@ export declare interface WindowProps {
     /**
      * Specifies the minimum height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
      *
+     * @default 100
+     *
      * @example
      * ```jsx
      * <Window minHeight={100} />
@@ -464,6 +483,8 @@ export declare interface WindowProps {
     /**
      * Specifies the minimum width of the Window ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
      *
+     * @default 120
+     *
      * @example
      * ```jsx
      * <Window minWidth={100} />
@@ -482,6 +503,8 @@ export declare interface WindowProps {
     /**
      * Specifies if the Window will be modal by rendering an overlay under the component.
      *
+     * @default false
+     *
      * @example
      * ```jsx
      * <Window modal={true} />
@@ -491,6 +514,8 @@ export declare interface WindowProps {
     /**
      * Specifies if the Window will be resizable ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
      *
+     * @default true
+     *
      * @example
      * ```jsx
      * <Window resizable={true} />
@@ -727,6 +752,9 @@ export declare class WindowWithoutContext extends React_2.Component<WindowProps,
      * @hidden
      */
     windowTitle?: any;
+    /**
+     * The draggable handle for the Window component.
+     */
     draggable: Draggable | null;
     private windowCoordinatesState?;
     private offSetCoordinates?;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progress/kendo-react-dialogs",
-  "version": "12.0.2-develop.3",
+  "version": "12.0.2-develop.5",
   "description": "React Dialogs provide modal and non-modal windows for showing additional information to the user. KendoReact Dialogs package",
   "author": "Progress",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -26,9 +26,9 @@
   "sideEffects": false,
   "peerDependencies": {
     "@progress/kendo-licensing": "^1.7.0",
-    "@progress/kendo-react-buttons": "12.0.2-develop.3",
-    "@progress/kendo-react-common": "12.0.2-develop.3",
-    "@progress/kendo-react-intl": "12.0.2-develop.3",
+    "@progress/kendo-react-buttons": "12.0.2-develop.5",
+    "@progress/kendo-react-common": "12.0.2-develop.5",
+    "@progress/kendo-react-intl": "12.0.2-develop.5",
     "@progress/kendo-svg-icons": "^4.0.0",
     "react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
     "react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"