@progress/kendo-angular-utils 19.1.2-develop.4 → 19.1.2-develop.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/adaptive-breakpoints/adaptive-settings.d.ts +4 -4
  2. package/adaptive-breakpoints/adaptive-settings.service.d.ts +2 -2
  3. package/adaptive-breakpoints/adaptive.service.d.ts +6 -10
  4. package/adaptive-breakpoints/models/adaptive-settings.d.ts +6 -3
  5. package/directives.d.ts +20 -3
  6. package/drag-and-drop/draghandle.directive.d.ts +10 -2
  7. package/drag-and-drop/dragtarget-container.directive.d.ts +26 -25
  8. package/drag-and-drop/dragtarget.directive.d.ts +16 -15
  9. package/drag-and-drop/droptarget-container.directive.d.ts +12 -12
  10. package/drag-and-drop/droptarget.directive.d.ts +12 -4
  11. package/drag-and-drop/events/drag-target/drag-event.d.ts +6 -5
  12. package/drag-and-drop/events/drag-target/dragready-event.d.ts +5 -4
  13. package/drag-and-drop/events/drag-target/end-event.d.ts +5 -4
  14. package/drag-and-drop/events/drag-target/press-event.d.ts +5 -4
  15. package/drag-and-drop/events/drag-target/release-event.d.ts +5 -4
  16. package/drag-and-drop/events/drag-target/start-event.d.ts +5 -4
  17. package/drag-and-drop/events/drop-target-event.d.ts +3 -3
  18. package/drag-and-drop/models/autoscroll-options.d.ts +4 -4
  19. package/drag-and-drop/models/functions.d.ts +7 -9
  20. package/drag-and-drop/models/hint-settings.d.ts +3 -3
  21. package/drag-and-drop/models/scroll-direction.d.ts +3 -0
  22. package/drag-and-drop.module.d.ts +5 -17
  23. package/esm2022/adaptive-breakpoints/adaptive-settings.mjs +4 -4
  24. package/esm2022/adaptive-breakpoints/adaptive-settings.service.mjs +2 -2
  25. package/esm2022/adaptive-breakpoints/adaptive.service.mjs +6 -10
  26. package/esm2022/directives.mjs +20 -3
  27. package/esm2022/drag-and-drop/draghandle.directive.mjs +10 -2
  28. package/esm2022/drag-and-drop/dragtarget-container.directive.mjs +26 -25
  29. package/esm2022/drag-and-drop/dragtarget.directive.mjs +16 -15
  30. package/esm2022/drag-and-drop/droptarget-container.directive.mjs +12 -12
  31. package/esm2022/drag-and-drop/droptarget.directive.mjs +12 -4
  32. package/esm2022/drag-and-drop/events/drag-target/drag-event.mjs +6 -5
  33. package/esm2022/drag-and-drop/events/drag-target/dragready-event.mjs +5 -4
  34. package/esm2022/drag-and-drop/events/drag-target/end-event.mjs +5 -4
  35. package/esm2022/drag-and-drop/events/drag-target/press-event.mjs +5 -4
  36. package/esm2022/drag-and-drop/events/drag-target/release-event.mjs +5 -4
  37. package/esm2022/drag-and-drop/events/drag-target/start-event.mjs +5 -4
  38. package/esm2022/drag-and-drop/events/drop-target-event.mjs +3 -3
  39. package/esm2022/drag-and-drop.module.mjs +5 -17
  40. package/esm2022/package-metadata.mjs +2 -2
  41. package/esm2022/utils.module.mjs +5 -17
  42. package/fesm2022/progress-kendo-angular-utils.mjs +154 -141
  43. package/package.json +4 -4
  44. package/utils.module.d.ts +5 -17
@@ -5,17 +5,17 @@
5
5
  import { InjectionToken } from '@angular/core';
6
6
  import { AdaptiveSettings } from './models/adaptive-settings';
7
7
  /**
8
- * A token that specifies the AdaptiveSettings of the Kendo UI for Angular components.
8
+ * A token that specifies the `AdaptiveSettings` for Kendo UI for Angular components.
9
9
  *
10
+ * @example
10
11
  * ```ts
11
12
  * import { NgModule } from '@angular/core';
12
13
  *
13
14
  * @NgModule({
14
- * ...
15
- * providers: [{ provide: ADAPTIVE_SETTINGS, useValue: { small: 400, medium: 600 }}]
15
+ * ...,
16
+ * providers: [{ provide: ADAPTIVE_SETTINGS, useValue: { small: 400, medium: 600 } }]
16
17
  * })
17
18
  * export class AppModule {}
18
19
  * ```
19
- *
20
20
  */
21
21
  export declare const ADAPTIVE_SETTINGS: InjectionToken<AdaptiveSettings>;
@@ -6,7 +6,7 @@ import { Subject } from 'rxjs';
6
6
  import { AdaptiveSettings } from './models/adaptive-settings';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A service that allows changing the current adaptive settings dynamically. Use the public `notify` method to implement this.
9
+ * A service that lets you change the current adaptive settings dynamically. Use the public `notify` method to update the settings.
10
10
  */
11
11
  export declare class AdaptiveSettingsService {
12
12
  /**
@@ -14,7 +14,7 @@ export declare class AdaptiveSettingsService {
14
14
  */
15
15
  readonly changes: Subject<AdaptiveSettings>;
16
16
  /**
17
- * Notifies subscribers that the adaptive settings were changed.
17
+ * Notifies subscribers that the adaptive settings have changed.
18
18
  *
19
19
  * @param adaptiveSettings - (Optional) A new value for the adaptive settings token.
20
20
  */
@@ -9,21 +9,17 @@ import { AdaptiveSettingsService } from './adaptive-settings.service';
9
9
  import { AdaptiveSize } from './models/adaptive-size';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * The service responsible for handling changes in the adaptive settings. Should be included in the providers array when implementing the functionality in a standalone component.
12
+ * The service responsible for handling changes in adaptive settings. Add it to the providers array when using adaptive breakpoints in a standalone component.
13
13
  *
14
14
  * @example
15
- *
16
- * ```ts-no-run
17
- * // Import the AdaptiveService
15
+ * ```ts
18
16
  * import { AdaptiveService } from '@progress/kendo-angular-utils';
19
17
  *
20
- * // Define a standalone component
21
18
  * @Component({
22
- * selector: my-component,
23
- * standalone: true,
24
- * imports: [ ... ],
25
- * providers: [AdaptiveService, { provide: ADAPTIVE_SETTINGS , useValue: { small: 300 } }],
26
- * template: ...
19
+ * selector: 'my-component',
20
+ * standalone: true,
21
+ * providers: [AdaptiveService, { provide: ADAPTIVE_SETTINGS, useValue: { small: 300 } }],
22
+ * template: '...'
27
23
  * })
28
24
  * export class AppComponent {}
29
25
  * ```
@@ -3,17 +3,20 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the settings for the adaptive breakpoints of the component.
6
+ * * Represents the adaptive settings for Kendo UI for Angular components.
7
+ *
8
+ * Allows customization of adaptive breakpoints to ensure optimal rendering
9
+ * across different screen resolutions and device types.
7
10
  */
8
11
  export interface AdaptiveSettings {
9
12
  /**
10
- * Sets the screen width in pixels up to which the component will render a full-screen modal.
13
+ * Sets the screen width in pixels up to which the component renders a full-screen modal.
11
14
  *
12
15
  * @default 500
13
16
  */
14
17
  small?: number;
15
18
  /**
16
- * Sets the screen width in pixels up to which the component will render a docked to the bottom modal. Uses the `small` adaptive breakpoint as a lower boundary.
19
+ * Sets the screen width in pixels up to which the component renders a docked-to-bottom modal. Uses the `small` adaptive breakpoint as a lower boundary.
17
20
  *
18
21
  * @default 768
19
22
  */
package/directives.d.ts CHANGED
@@ -9,11 +9,28 @@ import { DropTargetContainerDirective } from "./drag-and-drop/droptarget-contain
9
9
  import { DropTargetDirective } from "./drag-and-drop/droptarget.directive";
10
10
  import { HintComponent } from "./drag-and-drop/hint.component";
11
11
  /**
12
- * Utility array that contains all `Drag and Drop` related components and directives
12
+ * Use this utility array to access all Drag and Drop-related components and directives in a standalone Angular component.
13
+ *
14
+ * @example
15
+ * ```typescript
16
+ * import { Component } from '@angular/core';
17
+ * import { KENDO_DRAGANDDROP } from '@progress/kendo-angular-utils';
18
+ *
19
+ * @Component({
20
+ * selector: 'my-app',
21
+ * standalone: true,
22
+ * imports: [KENDO_DRAGANDDROP],
23
+ * template: `
24
+ * <div kendoDragTarget>Drag me</div>
25
+ * <div kendoDropTarget>Drop here</div>
26
+ * `
27
+ * })
28
+ * export class AppComponent {}
29
+ * ```
13
30
  */
14
31
  export declare const KENDO_DRAGANDDROP: readonly [typeof DragTargetDirective, typeof DragHandleDirective, typeof DropTargetDirective, typeof DragTargetContainerDirective, typeof DropTargetContainerDirective, typeof HintComponent];
15
32
  /**
16
- * Utility array that contains all `@progress/kendo-angular-utils` related components and directives.
17
- * > As of now, `KENDO_UTILS` includes only the `KENDO_DRAGANDDROP` utility array and their usage is equivalent.
33
+ * Use this utility array to access all `@progress/kendo-angular-utils`-related components and directives in a standalone Angular component.
34
+ * > Currently, `KENDO_UTILS` includes only the `KENDO_DRAGANDDROP` utility array and their usage is equivalent.
18
35
  */
19
36
  export declare const KENDO_UTILS: readonly [typeof DragTargetDirective, typeof DragHandleDirective, typeof DropTargetDirective, typeof DragTargetContainerDirective, typeof DropTargetContainerDirective, typeof HintComponent];
@@ -6,13 +6,21 @@ import { ElementRef } from "@angular/core";
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the Kendo UI DragHandle directive for Angular.
9
- * It is used to specify a concrete element within a drag target as a handle for dragging, instead the drag target itself.
9
+ * Use this directive to specify an element inside a drag target as a handle for dragging instead of the drag target itself.
10
+ *
11
+ * ```html
12
+ * <div kendoDragTarget>
13
+ * <button kendoDragHandle kendoButton>
14
+ * Drag me
15
+ * </button>
16
+ * </div>
17
+ * ```
10
18
  */
11
19
  export declare class DragHandleDirective {
12
20
  element: ElementRef;
13
21
  touchActionStyle: string;
14
22
  /**
15
- * Specifies the cursor style of the drag handle. Accepts same values as the [CSS `cursor` property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor#values).
23
+ * Sets the cursor style of the drag handle. Accepts same values as the [CSS `cursor` property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor#values).
16
24
  *
17
25
  * @default 'move'
18
26
  */
@@ -10,12 +10,14 @@ import { DragTargetDragEndEvent, DragTargetDragEvent, DragTargetDragReadyEvent,
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
12
  * Represents the [Kendo UI DragTargetContainer directive for Angular]({% slug api_utils_dragtargetcontainerdirective %}).
13
- * Used to configure multiple elements as draggable.
13
+ * Use this directive to make multiple elements draggable inside a container.
14
14
  *
15
15
  * @example
16
- * ```ts-no-run
16
+ * ```html
17
17
  * <ul kendoDragTargetContainer dragTargetFilter=".my-draggable">
18
- * <li class="my-draggable">foo</li>
18
+ * <li class="my-draggable"> Item 1</li>
19
+ * <li class="my-draggable"> Item 2</li>
20
+ * <li class="my-draggable"> Item 3</li>
19
21
  * </ul>
20
22
  * ```
21
23
  */
@@ -27,61 +29,60 @@ export declare class DragTargetContainerDirective implements AfterViewInit, OnDe
27
29
  private viewContainer;
28
30
  private cdr;
29
31
  /**
30
- * Defines whether a hint will be used for dragging. By default, the hint is a copy of the current drag target. ([see example]({% slug drag_hint %})).
32
+ * Defines whether a hint will be used for dragging. By default, the hint is a copy of the current drag target. [See example]({% slug drag_hint %}).
31
33
  *
32
34
  * @default false
33
35
  */
34
36
  hint: boolean | HintSettings;
35
37
  /**
36
- * Specifies a selector for elements within a container which will be configured as draggable
37
- * ([see example]({% slug drag_target_container %})). The possible values include any
38
- * DOM `selector`.
38
+ * Sets a selector for elements in the container to make them draggable. The possible values include any
39
+ * DOM `selector`. [See example]({% slug drag_target_container %}).
39
40
  */
40
41
  set dragTargetFilter(value: string);
41
42
  get dragTargetFilter(): string;
42
43
  /**
43
- * Specifies a selector for elements within each DragTarget which will be configured as drag handles.
44
+ * Sets a selector for elements inside each drag target to use as drag handles.
44
45
  */
45
46
  dragHandle: string;
46
47
  /**
47
- * Defines the delay in milliseconds after which the drag will begin ([see example](slug:drag_target_container#toc-events)).
48
+ * Sets the delay in milliseconds before dragging begins. [See example](slug:drag_target_container#toc-events).
48
49
  *
49
50
  * @default 0
50
51
  */
51
52
  dragDelay: number;
52
53
  /**
53
- * The number of pixels the pointer moves in any direction before the dragging starts ([see example]({% slug minimum_distance %})).
54
+ * Sets the number of pixels the pointer must move before dragging starts. [See example]({% slug minimum_distance %}).
54
55
  *
55
56
  * @default 0
56
57
  */
57
58
  threshold: number;
58
59
  /**
59
- * Defines a unique identifier for each drag target.
60
- * It exposes the current DragTarget HTML element and its index in the collection of drag targets as arguments.
60
+ * Sets a unique identifier for each drag target.
61
+ * It exposes the current drag target HTML element and its index in the collection of drag targets as arguments.
61
62
  */
62
63
  set dragTargetId(fn: DragTargetIdFn);
63
64
  get dragTargetId(): DragTargetIdFn;
64
65
  /**
65
- * Defines a callback function which returns custom data passed to the DropTarget events.
66
- * It exposes the current DragTarget HTML element, its `dragTargetId` and its index in the collection of drag targets as arguments.
66
+ * Sets a callback function to return custom data for `DropTarget` events.
67
+ * It exposes the current `DragTarget` HTML element, its `dragTargetId`, and its index in the collection of drag targets as arguments.
67
68
  */
68
69
  set dragData(fn: DragTargetDataFn);
69
70
  get dragData(): DragTargetDataFn;
70
71
  /**
71
- * If set to true, the dragging of DragTargets within the container will be disabled.
72
+ * Disables dragging of drag targets in the container when set to `true`.
72
73
  *
73
74
  * @default false
74
75
  */
75
76
  set dragDisabled(value: boolean);
76
77
  get dragDisabled(): boolean;
77
78
  /**
78
- * Specifies whether the default dragging behavior will be performed or the developer will manually handle the drag action.
79
+ * Sets whether to use the default dragging behavior or handle it manually.
79
80
  *
80
81
  * @default 'auto'
81
82
  */
82
83
  mode: DragMode;
83
84
  /**
84
- * Specifies the cursor style of the drag targets. Accepts same values as the [CSS `cursor` property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor#values).
85
+ * Sets the cursor style of the drag targets. Accepts same values as the [CSS `cursor` property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor#values).
85
86
  *
86
87
  * @default 'move'
87
88
  */
@@ -91,31 +92,31 @@ export declare class DragTargetContainerDirective implements AfterViewInit, OnDe
91
92
  */
92
93
  hintContext: any;
93
94
  /**
94
- * Fires when a DragTarget's `dragDelay` has passed and the user is able to drag the element.
95
+ * Fires when a drag target's `dragDelay` has passed and the user can drag the element.
95
96
  */
96
97
  onDragReady: EventEmitter<DragTargetDragReadyEvent>;
97
98
  /**
98
- * Fires when the user presses a DragTarget element.
99
+ * Fires when the user presses a drag target element.
99
100
  */
100
101
  onPress: EventEmitter<DragTargetPressEvent>;
101
102
  /**
102
- * Fires when the dragging of a DragTarget element begins.
103
- */
103
+ * Fires when dragging of a drag target element begins.
104
+ */
104
105
  onDragStart: EventEmitter<DragTargetDragStartEvent>;
105
106
  /**
106
- * Fires while the user drags a DragTarget element.
107
+ * Fires while the user drags a drag target element.
107
108
  */
108
109
  onDrag: EventEmitter<DragTargetDragEvent>;
109
110
  /**
110
- * Fires when the user releases a DragTarget element after being pressed.
111
+ * Fires when the user releases a drag target element after pressing it.
111
112
  */
112
113
  onRelease: EventEmitter<DragTargetReleaseEvent>;
113
114
  /**
114
- * Fires when the dragging of a DragTarget ends and the element is released.
115
+ * Fires when dragging of a drag target ends and the element is released.
115
116
  */
116
117
  onDragEnd: EventEmitter<DragTargetDragEndEvent>;
117
118
  /**
118
- * Used for notifying the DragTargetContainer that its content has changed.
119
+ * Notifies the `DragTargetContainer` that its content has changed.
119
120
  */
120
121
  notify(): void;
121
122
  private currentDragTarget;
@@ -13,6 +13,7 @@ import { DragTargetDragReadyEvent } from "./events/drag-target/dragready-event";
13
13
  import * as i0 from "@angular/core";
14
14
  /**
15
15
  * Represents the Kendo UI DragTarget directive for Angular.
16
+ * Use this directive to make an element draggable.
16
17
  */
17
18
  export declare class DragTargetDirective implements OnInit, AfterContentInit, OnDestroy {
18
19
  private element;
@@ -28,72 +29,72 @@ export declare class DragTargetDirective implements OnInit, AfterContentInit, On
28
29
  */
29
30
  hint: boolean | HintSettings;
30
31
  /**
31
- * The number of pixels the pointer moves in any direction before the dragging starts ([see example]({% slug minimum_distance %})). Applicable when `manualDrag` is set to `false`.
32
+ * Sets the number of pixels the pointer must move before dragging starts. Applies when `manualDrag` is `false`. [See example]({% slug minimum_distance %}).
32
33
  *
33
34
  * @default 0
34
35
  */
35
36
  threshold: number;
36
37
  /**
37
- * Defines the automatic container scrolling behavior when close to the edge ([see example]({% slug auto_scroll %})).
38
+ * Sets the automatic container scrolling behavior when close to the edge. [See example]({% slug auto_scroll %}).
38
39
  *
39
40
  * @default true
40
41
  */
41
42
  autoScroll: boolean | AutoScrollOptions;
42
43
  /**
43
- * Defines a unique identifier for the dragTarget.
44
+ * Sets a unique identifier for the drag target.
44
45
  */
45
46
  dragTargetId: string | DragTargetIdFn;
46
47
  /**
47
- * Defines the delay in milliseconds after which the drag will begin ([see example]({% slug drag_delay %})).
48
+ * Sets the delay in milliseconds before dragging begins. [See example]({% slug drag_delay %}).
48
49
  *
49
50
  * @default 0
50
51
  */
51
52
  dragDelay: number;
52
53
  /**
53
- * Restricts the element to be dragged horizontally or vertically only ([see example]({% slug axis_lock %})). Applicable when `mode` is set to `auto`.
54
+ * Restricts dragging to horizontal or vertical only. Applies when `mode` is `auto`. [See example]({% slug axis_lock %}).
54
55
  */
55
56
  restrictByAxis: DragAxis;
56
57
  /**
57
- * Specifies whether the default dragging behavior will be performed or the developer will manually handle the drag action.
58
+ * Specifies whether to use the default dragging behavior or handle it manually.
58
59
  *
59
60
  * @default 'auto'
60
61
  */
61
62
  mode: DragMode;
62
63
  /**
63
- * Defines a callback function used for attaching custom data to the dragTarget.
64
- * The data will be available in the events of the respective [`DropTarget`]({% slug api_utils_droptargetdirective %}) or [`DropTargetContainer`]({% slug api_utils_droptargetcontainerdirective %}) directives.
64
+ * Defines a callback function used for attaching custom data to the drag target.
65
+ * The data is available in the events of the respective [`DropTarget`]({% slug api_utils_droptargetdirective %}) or [`DropTargetContainer`]({% slug api_utils_droptargetcontainerdirective %}) directives.
65
66
  * The current DragTarget HTML element and its `dragTargetId` will be available as arguments.
66
67
  */
67
68
  set dragData(fn: DragTargetDataFn);
68
69
  get dragData(): DragTargetDataFn;
69
70
  /**
70
- * Specifies the cursor style of the drag target. Accepts same values as the [CSS `cursor` property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor#values).
71
+ * Sets the cursor style of the drag target. Accepts same values as the [CSS `cursor` property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor#values).
71
72
  *
72
73
  * @default 'move'
73
74
  */
74
75
  cursorStyle: string;
75
76
  /**
76
- * Fires when the user presses the DragTarget element.
77
+ * Fires when the user presses the drag target element.
77
78
  */
78
79
  onPress: EventEmitter<DragTargetPressEvent>;
79
80
  /**
80
- * Fires when the dragging of the DragTarget element begins.
81
+ * Fires when dragging of the drag target element begins.
81
82
  */
82
83
  onDragStart: EventEmitter<DragTargetDragStartEvent>;
83
84
  /**
84
- * Fires while the user drags the DragTarget element.
85
+ * Fires while the user drags the drag target element.
85
86
  */
86
87
  onDrag: EventEmitter<DragTargetDragEvent>;
87
88
  /**
88
- * Fires when the DragTarget's `dragDelay` has passed and the user is able to drag the element.
89
+ * Fires when the drag target's `dragDelay` has passed and the user can drag the element.
89
90
  */
90
91
  onDragReady: EventEmitter<DragTargetDragReadyEvent>;
91
92
  /**
92
- * Fires when the user releases the DragTarget element after being pressed.
93
+ * Fires when `DragTarget` is released, either by dropping it on a drop target or by releasing the mouse button.
93
94
  */
94
95
  onRelease: EventEmitter<DragTargetReleaseEvent>;
95
96
  /**
96
- * Fires when the dragging of the DragTarget ends and the element is released.
97
+ * Fires when dragging of the drag target ends and the element is released.
97
98
  */
98
99
  onDragEnd: EventEmitter<DragTargetDragEndEvent>;
99
100
  private dragTarget;
@@ -9,12 +9,14 @@ import { DropTargetEvent } from './events/drop-target-event';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
11
  * Represents the [Kendo UI DropTargetContainer directive for Angular]({% slug api_utils_droptargetcontainerdirective %}).
12
- * Used to configure multiple elements as drop targets.
12
+ * Use this directive to make multiple elements drop targets inside a container.
13
13
  *
14
14
  * @example
15
- * ```ts-no-run
15
+ * ```html
16
16
  * <div kendoDropTargetContainer dropTargetFilter=".my-droptarget">
17
- * <div class="my-droptarget">foo</div>
17
+ * <div class="my-droptarget">
18
+ * Drop here
19
+ * </div>
18
20
  * </div>
19
21
  * ```
20
22
  */
@@ -24,35 +26,33 @@ export declare class DropTargetContainerDirective implements AfterViewInit {
24
26
  private ngZone;
25
27
  private cdr;
26
28
  /**
27
- * Specifies a selector for elements within a container which will be configured as drop targets
28
- * ([see example]({% slug drop_target_container %})). The possible values include any
29
- * DOM `selector`.
29
+ * Sets a selector for elements in the container to make them drop targets. [See example]({% slug drop_target_container %}).
30
30
  */
31
31
  set dropTargetFilter(value: string);
32
32
  get dropTargetFilter(): string;
33
33
  /**
34
- * Specifies whether the Drop Targets within the container will emit the corresponding events upon interaction with a Drag Target.
34
+ * Specifies whether the drop targets within the container will emit the corresponding events upon interaction with a drag target.
35
35
  */
36
36
  set dropDisabled(value: boolean);
37
37
  get dropDisabled(): boolean;
38
38
  /**
39
- * Fires when a DragTarget element enters the DropTarget.
39
+ * Fires when a drag target enters a drop target.
40
40
  */
41
41
  onDragEnter: EventEmitter<DropTargetEvent>;
42
42
  /**
43
- * Fires when a DragTarget element is being dragged over the DropTarget.
43
+ * Fires when a drag target is dragged over a drop target.
44
44
  */
45
45
  onDragOver: EventEmitter<DropTargetEvent>;
46
46
  /**
47
- * Fires when a DragTarget element leaves the DropTarget.
47
+ * Fires when a drag target leaves a drop target.
48
48
  */
49
49
  onDragLeave: EventEmitter<DropTargetEvent>;
50
50
  /**
51
- * Fires when a DragTarget element is dropped over the DropTarget.
51
+ * Fires when a drag target is dropped over a drop target.
52
52
  */
53
53
  onDrop: EventEmitter<DropTargetEvent>;
54
54
  /**
55
- * Used for notifying the DropTargetContainer that its content has changed.
55
+ * Notifies the `DropTargetContainer` that its content has changed.
56
56
  */
57
57
  notify(): void;
58
58
  constructor(service: DragStateService, element: ElementRef, ngZone: NgZone, cdr: ChangeDetectorRef);
@@ -9,25 +9,33 @@ import { DropTargetEvent } from './events/drop-target-event';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
11
  * Represents the Kendo UI DropTarget directive for Angular.
12
+ * Use this directive to make an element a drop target for draggable items.
13
+ *
14
+ * ```html
15
+ * <div kendoDropTarget>
16
+ * Drop here
17
+ * </div>
18
+ * ```
19
+ *
12
20
  */
13
21
  export declare class DropTargetDirective implements OnInit, OnDestroy {
14
22
  private service;
15
23
  private element;
16
24
  private ngZone;
17
25
  /**
18
- * Fires when a DragTarget element enters the DropTarget.
26
+ * Fires when a drag target enters the drop target.
19
27
  */
20
28
  onDragEnter: EventEmitter<DropTargetEvent>;
21
29
  /**
22
- * Fires when a DragTarget element is being dragged over the DropTarget.
30
+ * Fires when a drag target is dragged over the drop target.
23
31
  */
24
32
  onDragOver: EventEmitter<DropTargetEvent>;
25
33
  /**
26
- * Fires when a DragTarget element leaves the DropTarget.
34
+ * Fires when a drag target leaves the drop target.
27
35
  */
28
36
  onDragLeave: EventEmitter<DropTargetEvent>;
29
37
  /**
30
- * Fires when a DragTarget element is dropped over the DropTarget.
38
+ * Fires when a drag target is dropped over the drop target.
31
39
  */
32
40
  onDrop: EventEmitter<DropTargetEvent>;
33
41
  constructor(service: DragStateService, element: ElementRef, ngZone: NgZone);
@@ -5,19 +5,20 @@
5
5
  import { NormalizedDragEvent } from '@progress/kendo-draggable-common';
6
6
  import { PreventableEvent } from '@progress/kendo-angular-common';
7
7
  /**
8
- * Arguments for the drag event of the DragTarget and DragTargetContainer.
8
+ * Arguments for the drag event of the `DragTarget` and `DragTargetContainer`.
9
9
  */
10
10
  export declare class DragTargetDragEvent extends PreventableEvent {
11
11
  /**
12
- * The normalized drag event.
12
+ * The information related to the current drag event.
13
+ * This is the normalized drag event that contains details about the drag operation.
13
14
  */
14
15
  dragEvent: NormalizedDragEvent;
15
16
  /**
16
- * The DOM element that is being dragged.
17
+ * The DOM element being dragged.
17
18
  */
18
19
  dragTarget: HTMLElement;
19
20
  /**
20
- * The hint of the DragTarget.
21
+ * The hint element of the `DragTarget`.
21
22
  */
22
23
  hintElement?: HTMLElement;
23
24
  /**
@@ -25,7 +26,7 @@ export declare class DragTargetDragEvent extends PreventableEvent {
25
26
  */
26
27
  dragTargetId?: any;
27
28
  /**
28
- * The index of the current drag target in the collection of drag targets (applicable for the `DragTargetContainer` directive).
29
+ * The index of the current drag target in the collection of drag targets. Applies to `DragTargetContainer` directive.
29
30
  */
30
31
  dragTargetIndex?: number;
31
32
  /**
@@ -4,15 +4,16 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { NormalizedDragEvent } from '@progress/kendo-draggable-common';
6
6
  /**
7
- * Arguments for the dragReady event of the DragTarget and DragTargetContainer.
7
+ * Arguments for the dragReady event of the `DragTarget` and `DragTargetContainer`.
8
8
  */
9
9
  export declare class DragTargetDragReadyEvent {
10
10
  /**
11
- * The normalized drag event.
11
+ * The information related to the current drag event.
12
+ * This is the normalized drag event that contains details about the drag operation.
12
13
  */
13
14
  dragEvent: NormalizedDragEvent;
14
15
  /**
15
- * The DOM element that is being dragged.
16
+ * The DOM element being dragged.
16
17
  */
17
18
  dragTarget: HTMLElement;
18
19
  /**
@@ -20,7 +21,7 @@ export declare class DragTargetDragReadyEvent {
20
21
  */
21
22
  dragTargetId?: any;
22
23
  /**
23
- * The index of the current drag target in the collection of drag targets (applicable for the `DragTargetContainer` directive).
24
+ * The index of the current drag target in the collection of drag targets. Applies to `DragTargetContainer` directive.
24
25
  */
25
26
  dragTargetIndex?: number;
26
27
  /**
@@ -4,15 +4,16 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { NormalizedDragEvent } from '@progress/kendo-draggable-common';
6
6
  /**
7
- * Arguments for the dragEnd event of the DragTarget and DragTargetContainer.
7
+ * Arguments for the dragEnd event of the `DragTarget` and `DragTargetContainer`.
8
8
  */
9
9
  export declare class DragTargetDragEndEvent {
10
10
  /**
11
- * The normalized drag event.
11
+ * The information related to the current drag event.
12
+ * This is the normalized drag event that contains details about the drag operation.
12
13
  */
13
14
  dragEvent: NormalizedDragEvent;
14
15
  /**
15
- * The DOM element that is being dragged.
16
+ * The DOM element being dragged.
16
17
  */
17
18
  dragTarget: HTMLElement;
18
19
  /**
@@ -20,7 +21,7 @@ export declare class DragTargetDragEndEvent {
20
21
  */
21
22
  dragTargetId?: any;
22
23
  /**
23
- * The index of the current drag target in the collection of drag targets (applicable for the `DragTargetContainer` directive).
24
+ * The index of the current drag target in the collection of drag targets. Applies to `DragTargetContainer` directive.
24
25
  */
25
26
  dragTargetIndex?: number;
26
27
  /**
@@ -4,15 +4,16 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { NormalizedDragEvent } from '@progress/kendo-draggable-common';
6
6
  /**
7
- * Arguments for the press event of the DragTarget and DragTargetContainer.
7
+ * Arguments for the press event of the `DragTarget` and `DragTargetContainer`.
8
8
  */
9
9
  export declare class DragTargetPressEvent {
10
10
  /**
11
- * The normalized drag event.
11
+ * The information related to the current drag event.
12
+ * This is the normalized drag event that contains details about the drag operation.
12
13
  */
13
14
  dragEvent: NormalizedDragEvent;
14
15
  /**
15
- * The DOM element that is being dragged.
16
+ * The DOM element being dragged.
16
17
  */
17
18
  dragTarget: HTMLElement;
18
19
  /**
@@ -20,7 +21,7 @@ export declare class DragTargetPressEvent {
20
21
  */
21
22
  dragTargetId?: any;
22
23
  /**
23
- * The index of the current drag target in the collection of drag targets (applicable for the `DragTargetContainer` directive).
24
+ * The index of the current drag target in the collection of drag targets. Applies to `DragTargetContainer` directive.
24
25
  */
25
26
  dragTargetIndex?: number;
26
27
  /**
@@ -4,15 +4,16 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { NormalizedDragEvent } from '@progress/kendo-draggable-common';
6
6
  /**
7
- * Arguments for the release event of the DragTarget and DragTargetContainer.
7
+ * Arguments for the release event of the `DragTarget` and `DragTargetContainer`.
8
8
  */
9
9
  export declare class DragTargetReleaseEvent {
10
10
  /**
11
- * The normalized drag event.
11
+ * The information related to the current drag event.
12
+ * This is the normalized drag event that contains details about the drag operation.
12
13
  */
13
14
  dragEvent: NormalizedDragEvent;
14
15
  /**
15
- * The DOM element that is being dragged.
16
+ * The DOM element being dragged.
16
17
  */
17
18
  dragTarget: HTMLElement;
18
19
  /**
@@ -20,7 +21,7 @@ export declare class DragTargetReleaseEvent {
20
21
  */
21
22
  dragTargetId?: any;
22
23
  /**
23
- * The index of the current drag target in the collection of drag targets (applicable for the `DragTargetContainer` directive).
24
+ * The index of the current drag target in the collection of drag targets. Applies to `DragTargetContainer` directive.
24
25
  */
25
26
  dragTargetIndex?: number;
26
27
  /**