@progress/kendo-angular-tooltip 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 (36) hide show
  1. package/directives.d.ts +65 -3
  2. package/esm2022/directives.mjs +65 -3
  3. package/esm2022/models/events.mjs +11 -13
  4. package/esm2022/package-metadata.mjs +2 -2
  5. package/esm2022/popover/anchor.directive.mjs +2 -2
  6. package/esm2022/popover/container.directive.mjs +10 -12
  7. package/esm2022/popover/directives-base.mjs +4 -14
  8. package/esm2022/popover/popover.component.mjs +23 -34
  9. package/esm2022/popover/template-directives/actions-template.directive.mjs +10 -1
  10. package/esm2022/popover/template-directives/body-template.directive.mjs +10 -1
  11. package/esm2022/popover/template-directives/title-template.directive.mjs +10 -1
  12. package/esm2022/popover.module.mjs +3 -8
  13. package/esm2022/tooltip/tooltip.directive.mjs +29 -43
  14. package/esm2022/tooltip/tooltip.settings.mjs +19 -35
  15. package/esm2022/tooltip.module.mjs +6 -15
  16. package/esm2022/tooltips.module.mjs +5 -13
  17. package/fesm2022/progress-kendo-angular-tooltip.mjs +209 -197
  18. package/models/animation.model.d.ts +1 -1
  19. package/models/events.d.ts +11 -13
  20. package/models/functions.model.d.ts +4 -6
  21. package/models/popover-show-option.type.d.ts +7 -1
  22. package/models/position.type.d.ts +5 -5
  23. package/models/show.option.type.d.ts +4 -4
  24. package/package.json +7 -7
  25. package/popover/anchor.directive.d.ts +2 -2
  26. package/popover/container.directive.d.ts +10 -12
  27. package/popover/directives-base.d.ts +4 -14
  28. package/popover/popover.component.d.ts +23 -34
  29. package/popover/template-directives/actions-template.directive.d.ts +10 -1
  30. package/popover/template-directives/body-template.directive.d.ts +10 -1
  31. package/popover/template-directives/title-template.directive.d.ts +10 -1
  32. package/popover.module.d.ts +3 -8
  33. package/tooltip/tooltip.directive.d.ts +29 -43
  34. package/tooltip/tooltip.settings.d.ts +19 -35
  35. package/tooltip.module.d.ts +6 -15
  36. package/tooltips.module.d.ts +5 -13
@@ -63,18 +63,17 @@ const ERRORS = {
63
63
  };
64
64
 
65
65
  /**
66
- * Arguments for the `show` event. The `show` event fires when a popover is about
67
- * to be opened. If you cancel the event, the opening is prevented.
66
+ * Provides arguments for the `show` event. The event fires when a popover is about to open. Cancel the event to prevent opening.
68
67
  */
69
68
  class PopoverShowEvent extends PreventableEvent {
70
69
  /**
71
- * The host element related to the popover.
70
+ * Specifies the host element related to the Popover.
72
71
  */
73
72
  anchor;
74
73
  /**
75
74
  * @hidden
76
75
  * Constructs the event arguments for the `show` event.
77
- * @param anchor - The host element related to the popover.
76
+ * @param anchor - The host element related to the Popover.
78
77
  */
79
78
  constructor(anchor) {
80
79
  super();
@@ -82,16 +81,15 @@ class PopoverShowEvent extends PreventableEvent {
82
81
  }
83
82
  }
84
83
  /**
85
- * Arguments for the `hide` event. The `hide` event fires when a popover is about
86
- * to be closed. If you cancel the event, the popover stays open.
84
+ * Provides arguments for the `hide` event. The event fires when a popover is about to close. Cancel the event to keep it open.
87
85
  */
88
86
  class PopoverHideEvent extends PreventableEvent {
89
87
  /**
90
- * The host element related to the popover.
88
+ * Specifies the host element related to the Popover.
91
89
  */
92
90
  anchor;
93
91
  /**
94
- * The popover element.
92
+ * Specifies the Popover element.
95
93
  */
96
94
  popover;
97
95
  /**
@@ -107,15 +105,15 @@ class PopoverHideEvent extends PreventableEvent {
107
105
  }
108
106
  }
109
107
  /**
110
- * Arguments for the `shown` event. The `shown` event fires after the popover has opened and its opening animation has finished.
108
+ * Provides arguments for the `shown` event. The event fires after the Popover has opened and its opening animation has finished.
111
109
  */
112
110
  class PopoverShownEvent {
113
111
  /**
114
- * The host element related to the popover.
112
+ * Specifies the host element related to the Popover.
115
113
  */
116
114
  anchor;
117
115
  /**
118
- * The popover element.
116
+ * Specifies the Popover element.
119
117
  */
120
118
  popover;
121
119
  /**
@@ -130,11 +128,11 @@ class PopoverShownEvent {
130
128
  }
131
129
  }
132
130
  /**
133
- * Arguments for the `hidden` event. The `hidden` event fires after the popover has closed and its closing animation has finished.
131
+ * Provides arguments for the `hidden` event. The event fires after the popover has closed and its closing animation has finished.
134
132
  */
135
133
  class PopoverHiddenEvent {
136
134
  /**
137
- * The host element related to the popover.
135
+ * Specifies the host element related to the Popover.
138
136
  */
139
137
  anchor;
140
138
  /**
@@ -304,16 +302,25 @@ const packageMetadata = {
304
302
  productName: 'Kendo UI for Angular',
305
303
  productCode: 'KENDOUIANGULAR',
306
304
  productCodes: ['KENDOUIANGULAR'],
307
- publishDate: 1750157044,
308
- version: '19.1.2-develop.4',
305
+ publishDate: 1750433771,
306
+ version: '19.1.2-develop.6',
309
307
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
310
308
  };
311
309
 
312
310
  /**
313
- * Represents a template that defines the content of the Popover title.
311
+ * Represents the Kendo UI Popover title template directive for Angular.
312
+ * Use the `kendoPopoverTitleTemplate` directive to define a custom title template for the Popover component.
314
313
  *
315
314
  * To define the template, nest an `<ng-template>` tag
316
315
  * with the `kendoPopoverTitleTemplate` directive inside the `<kendo-popover>` tag.
316
+ *
317
+ * ```html
318
+ * <kendo-popover>
319
+ * <ng-template kendoPopoverTitleTemplate>
320
+ * Custom Title
321
+ * </ng-template>
322
+ * </kendo-popover>
323
+ * ```
317
324
  */
318
325
  class PopoverTitleTemplateDirective {
319
326
  templateRef;
@@ -334,10 +341,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
334
341
  }] }]; } });
335
342
 
336
343
  /**
337
- * Represents a template that defines the content of the Popover body.
344
+ * Represents the Kendo UI Popover body template directive for Angular.
345
+ * Use the `kendoPopoverBodyTemplate` directive to define a custom body template for the Popover component.
338
346
  *
339
347
  * To define the template, nest an `<ng-template>` tag
340
348
  * with the `kendoPopoverBodyTemplate` directive inside the `<kendo-popover>` tag.
349
+ *
350
+ * ```html
351
+ * <kendo-popover>
352
+ * <ng-template kendoPopoverBodyTemplate>
353
+ * Custom Body Content
354
+ * </ng-template>
355
+ * </kendo-popover>
356
+ * ```
341
357
  */
342
358
  class PopoverBodyTemplateDirective {
343
359
  templateRef;
@@ -358,10 +374,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
358
374
  }] }]; } });
359
375
 
360
376
  /**
361
- * Represents a template that defines the content of the Popover actions.
377
+ * Represents the Kendo UI Popover actions template directive for Angular.
378
+ * Use the `kendoPopoverActionsTemplate` directive to define a custom actions template for the Popover component.
362
379
  *
363
380
  * To define the template, nest an `<ng-template>` tag
364
381
  * with the `kendoPopoverActionsTemplate` directive inside the `<kendo-popover>` tag.
382
+ *
383
+ * ```html
384
+ * <kendo-popover>
385
+ * <ng-template kendoPopoverActionsTemplate>
386
+ * Custom Actions
387
+ * </ng-template>
388
+ * </kendo-popover>
389
+ * ```
365
390
  */
366
391
  class PopoverActionsTemplateDirective {
367
392
  templateRef;
@@ -384,14 +409,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
384
409
  /* eslint-disable @typescript-eslint/no-explicit-any */
385
410
  /**
386
411
  * Represents the [Kendo UI Popover component for Angular]({% slug overview_popover %}).
387
- * Used to display additional information that is related to a target element.
412
+ * Displays additional information related to a target element.
388
413
  *
389
414
  * @example
390
- * ```ts-no-run
415
+ * ```html
391
416
  * <kendo-popover>
392
- * <ng-template kendoPopoverTitleTemplate>Foo Title</ng-template>
393
- * <ng-template kendoPopoverBodyTemplate>Foo Body</ng-template>
394
- * <ng-template kendoPopoverActionsTemplate>Foo Actions</ng-template>
417
+ * <ng-template kendoPopoverTitleTemplate>Title</ng-template>
418
+ * <ng-template kendoPopoverBodyTemplate>Body</ng-template>
419
+ * <ng-template kendoPopoverActionsTemplate>Actions</ng-template>
395
420
  * </kendo-popover>
396
421
  * ```
397
422
  */
@@ -405,19 +430,15 @@ class PopoverComponent {
405
430
  */
406
431
  anchor;
407
432
  /**
408
- * Specifies the position of the Popover in relation to its anchor element. [See example]({% slug positioning_popover %})
433
+ * Specifies the position of the Popover relative to its anchor element. [See example]({% slug positioning_popover %}).
409
434
  *
410
- * The possible options are:
411
- * `top`
412
- * `bottom`
413
- * `right` (Default)
414
- * `left`
435
+ * @default 'right'
415
436
  */
416
437
  position = 'right';
417
438
  /**
418
439
  * Specifies the distance from the Popover to its anchor element in pixels.
419
440
  *
420
- * @default `6`
441
+ * @default 6
421
442
  */
422
443
  set offset(value) {
423
444
  this._offset = value;
@@ -429,7 +450,8 @@ class PopoverComponent {
429
450
  : this._offset;
430
451
  }
431
452
  /**
432
- * Determines the width of the popover. Numeric values are treated as pixels.
453
+ * Determines the width of the Popover. Numeric values are treated as pixels.
454
+ *
433
455
  * @default 'auto'
434
456
  */
435
457
  set width(value) {
@@ -439,7 +461,8 @@ class PopoverComponent {
439
461
  return this._width;
440
462
  }
441
463
  /**
442
- * Determines the height of the popover. Numeric values are treated as pixels.
464
+ * Determines the height of the Popover. Numeric values are treated as pixels.
465
+ *
443
466
  * @default 'auto'
444
467
  */
445
468
  set height(value) {
@@ -453,9 +476,7 @@ class PopoverComponent {
453
476
  */
454
477
  direction;
455
478
  /**
456
- * Specifies the main header text of the Popover.
457
- *
458
- * If a `titleTemplate` is provided it would take precedence over the title.
479
+ * Specifies the main header text of the Popover. If a `titleTemplate` is provided, it takes precedence.
459
480
  */
460
481
  title;
461
482
  /**
@@ -466,31 +487,26 @@ class PopoverComponent {
466
487
  */
467
488
  subtitle;
468
489
  /**
469
- * Represents the text that will be rendered in the Popover body section.
470
- *
471
- * If a `bodyTemplate` is provided it would take precedence over this text.
490
+ * Represents the text rendered in the Popover body section. If a `bodyTemplate` is provided, it takes precedence.
472
491
  */
473
492
  body;
474
493
  /**
475
- * Determines whether a callout will be rendered along the Popover. [See example]({% slug callout_popover %})
494
+ * Determines whether a callout is rendered along the Popover. [See example]({% slug callout_popover %}).
476
495
  *
477
496
  * @default true
478
497
  */
479
498
  callout = true;
480
499
  /**
481
- * Enables and configures the Popover animation. [See example]({% slug animations_popover %})
482
- *
483
- * The possible options are:
500
+ * Enables and configures the Popover animation. [See example]({% slug animations_popover %}).
484
501
  *
485
- * * `boolean`&mdash;Enables the default animation
486
- * * `PopoverAnimation`&mdash;A configuration object which allows setting the `direction`, `duration` and `type` of the animation.
502
+ * Accepts a boolean to enable the default animation, or a `PopoverAnimation` object for custom settings.
487
503
  *
488
504
  * @default false
489
505
  */
490
506
  animation = false;
491
507
  /**
492
- * Defines a callback function which returns custom data passed to the Popover templates.
493
- * It exposes the current anchor element as an argument. [See example](slug:templates_popover#toc-passing-data-to-templates)
508
+ * Defines a callback function that returns custom data for the Popover templates.
509
+ * The function exposes the `anchor` element as an argument and returns an object that can be used in the templates. [See example](slug:templates_popover#toc-passing-data-to-templates).
494
510
  */
495
511
  set templateData(fn) {
496
512
  if (isDevMode && typeof fn !== 'function') {
@@ -519,21 +535,19 @@ class PopoverComponent {
519
535
  return !this.visible;
520
536
  }
521
537
  /**
522
- * Fires before the Popover is about to be shown ([see example]({% slug events_popover %})).
523
- * The event is preventable. If canceled, the Popover will not be displayed. [See example]({% slug events_popover %})
538
+ * Fires before the Popover is shown. The event is preventable. If canceled, the Popover will not display. [See example]({% slug events_popover %}).
524
539
  */
525
540
  show = new EventEmitter();
526
541
  /**
527
- * Fires after the Popover has been shown and the animation has ended. [See example]({% slug events_popover %})
542
+ * Fires after the Popover has been shown and the animation has ended. [See example]({% slug events_popover %}).
528
543
  */
529
544
  shown = new EventEmitter();
530
545
  /**
531
- * Fires when the Popover is about to be hidden ([see example]({% slug events_popover %})).
532
- * The event is preventable. If canceled, the Popover will remain visible.
546
+ * Fires when the Popover is about to be hidden. The event is preventable. If canceled, the Popover remains visible. [See example]({% slug events_popover %}).
533
547
  */
534
548
  hide = new EventEmitter();
535
549
  /**
536
- * Fires after the Popover has been hidden and the animation has ended. [See example]({% slug events_popover %})
550
+ * Fires after the Popover has been hidden and the animation has ended. [See example]({% slug events_popover %}).
537
551
  */
538
552
  hidden = new EventEmitter();
539
553
  /**
@@ -845,12 +859,8 @@ class PopoverDirectivesBase {
845
859
  popupService;
846
860
  renderer;
847
861
  /**
848
- * Specifies the popover instance that will be rendered.
849
- * Accepts a [`PopoverComponent`]({% slug api_tooltip_popovercomponent %}) instance or
850
- * a [`PopoverFn`]({% slug api_tooltip_popoverfn %}) callback which returns a [`PopoverComponent`]({% slug api_tooltip_popovercomponent %}) instance
851
- * depending on the current anchor element.
852
- *
853
- * [See example](slug:templates_popover#toc-passing-data-to-templates)
862
+ * Specifies the popover instance to render.
863
+ * Accepts a [`PopoverComponent`]({% slug api_tooltip_popovercomponent %}) instance or a [`PopoverFn`]({% slug api_tooltip_popoverfn %}) callback that returns a [`PopoverComponent`]({% slug api_tooltip_popovercomponent %}) instance for the current anchor element. [See example](slug:templates_popover#toc-passing-data-to-templates).
854
864
  */
855
865
  set popover(value) {
856
866
  if (value instanceof PopoverComponent || typeof value === `function`) {
@@ -866,13 +876,7 @@ class PopoverDirectivesBase {
866
876
  return this._popover;
867
877
  }
868
878
  /**
869
- * The event on which the Popover will be shown
870
- *
871
- * The supported values are:
872
- * - `click` (default) &mdash;The Popover will be shown when its `anchor` element is clicked.
873
- * - `hover`&mdash;The Popover will be shown when its `anchor` element is hovered.
874
- * - `focus`&mdash;The Popover will be shown when its `anchor` element is focused.
875
- * - `none`&mdash;The Popover will not be shown on user interaction. It could be rendered via the Popover API methods.
879
+ * Specifies the mouse action that triggers the popover to show. [See example]({% slug programmaticcontrol_popover %}).
876
880
  */
877
881
  set showOn(value) {
878
882
  if (isDevMode && !containsItem(validShowOptions, value)) {
@@ -941,7 +945,7 @@ class PopoverDirectivesBase {
941
945
  }
942
946
  }
943
947
  /**
944
- * Hides the Popover ([See example]({% slug programmaticcontrol_popover %})).
948
+ * Hides the Popover. [See example]({% slug programmaticcontrol_popover %}).
945
949
  */
946
950
  hide() {
947
951
  this.closePopup();
@@ -1217,10 +1221,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1217
1221
  /* eslint-disable @typescript-eslint/no-explicit-any */
1218
1222
  /**
1219
1223
  * Represents the [`kendoPopoverAnchor`](slug:configuration_popover#toc-popover-anchor) directive.
1220
- * It is used to target an element, which should display a popover on interaction.
1224
+ * Targets an element to display a popover on user interaction.
1221
1225
  *
1222
1226
  * @example
1223
- * ```ts-no-run
1227
+ * ```html
1224
1228
  * <button kendoPopoverAnchor [popover]="myPopover">Show Popover</button>
1225
1229
  * ```
1226
1230
  */
@@ -1376,14 +1380,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1376
1380
  /* eslint-disable @typescript-eslint/no-explicit-any */
1377
1381
  /**
1378
1382
  * Represents the [`kendoPopoverContainer`](slug:configuration_popover#toc-popover-container) directive.
1379
- * It is used to filter and target multiple elements, which should display a popover on interaction.
1383
+ * Filters and targets multiple elements to display a popover on user interaction.
1380
1384
  *
1381
1385
  * @example
1382
- * ```ts-no-run
1386
+ * ```html
1383
1387
  * <div kendoPopoverContainer [popover]="myPopover" filter=".has-popover">
1384
- * <button class="has-popover">Show Popover</button>
1385
- * <button>Button Without Popover</button>
1386
- * <button class="has-popover">Show Popover</button>
1388
+ * <button class="has-popover">Show Popover</button>
1389
+ * <button>Button Without Popover</button>
1390
+ * <button class="has-popover">Show Popover</button>
1387
1391
  * </div>
1388
1392
  * ```
1389
1393
  */
@@ -1394,10 +1398,8 @@ class PopoverContainerDirective extends PopoverDirectivesBase {
1394
1398
  renderer;
1395
1399
  popoverService;
1396
1400
  /**
1397
- * Specifies a selector for the elements that should display a popover.
1398
- *
1399
- * The possible values include any valid query selector.
1400
- * [See example](slug:configuration_popover#toc-popover-container)
1401
+ * Specifies a selector for the elements that display a popover. Accepts a CSS selector string similar to a [querySelector method](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector).
1402
+ * [See example](slug:configuration_popover#toc-popover-container).
1401
1403
  */
1402
1404
  filter;
1403
1405
  constructor(wrapperEl, ngZone, popupService, renderer, popoverService) {
@@ -1412,7 +1414,7 @@ class PopoverContainerDirective extends PopoverDirectivesBase {
1412
1414
  /**
1413
1415
  * Shows the Popover.
1414
1416
  *
1415
- * @param anchor&mdash;Specifies the element that will be used as an anchor. The Popover opens relative to that element. [See example]({% slug programmaticcontrol_popover %})
1417
+ * @param anchor - The element used as an anchor. The Popover opens relative to this element. [See example]({% slug programmaticcontrol_popover %}).
1416
1418
  */
1417
1419
  show(anchor) {
1418
1420
  if (this.popupRef) {
@@ -1426,9 +1428,9 @@ class PopoverContainerDirective extends PopoverDirectivesBase {
1426
1428
  .subscribe(() => this.hide());
1427
1429
  }
1428
1430
  /**
1429
- * Toggles the visibility of the Popover. [See example]({% slug programmaticcontrol_popover %})
1431
+ * Toggles the visibility of the Popover. [See example]({% slug programmaticcontrol_popover %}).
1430
1432
  *
1431
- * @param anchor&mdash;Specifies the element that will be used as an anchor. The Popover opens relative to that element.
1433
+ * @param anchor - The element used as an anchor. The Popover opens relative to this element.
1432
1434
  */
1433
1435
  toggle(anchor) {
1434
1436
  const previousAnchor = this.popupRef && this.popupRef.content.instance.anchor;
@@ -1819,66 +1821,50 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1819
1821
  */
1820
1822
  const TOOLTIP_SETTINGS = new InjectionToken('kendo-ui-tooltip-settings');
1821
1823
  /**
1822
- * Provides a global configuration for the Kendo UI Tooltip. Once injected through
1823
- * the `AppComponent` constructor, the configuration properties can be overridden.
1824
+ * Provides a global configuration for the Kendo UI Tooltip. Inject this class in the `AppComponent` constructor to override configuration properties.
1824
1825
  *
1825
1826
  * @example
1826
- * ```ts-no-run
1827
+ * ```typescript
1827
1828
  * import { TooltipSettings } from '@progress/kendo-angular-tooltip';
1828
1829
  *
1829
- * _@Component({
1830
- * selector: 'my-app',
1831
- * template: `
1832
- * <div kendoTooltip>
1833
- * <button title="Saves the current document">Save</button>
1834
- * </div>`,
1835
- * providers: [{
1836
- * provide: TooltipSettings,
1837
- * useFactory: (): TooltipSettings => ({
1838
- * // Override default values of tooltips if wanted
1839
- * position: 'right'
1840
- * })
1841
- * }]
1830
+ * @Component({
1831
+ * selector: 'my-app',
1832
+ * template: `<div kendoTooltip><button title="Save">Save</button></div>`,
1833
+ * providers: [{
1834
+ * provide: TooltipSettings,
1835
+ * useFactory: (): TooltipSettings => ({ position: 'right' })
1836
+ * }]
1842
1837
  * })
1843
- * export class AppComponent { }
1838
+ * export class AppComponent {}
1844
1839
  * ```
1845
1840
  */
1846
1841
  class TooltipSettings {
1847
1842
  /**
1848
- * Specifies if the Тooltip will display a callout arrow.
1843
+ * Determines if the Tooltip displays a callout arrow.
1849
1844
  *
1850
- * The possible values are:
1851
- * * `true` (default)
1852
- * * `false`
1845
+ * @default true
1853
1846
  */
1854
1847
  callout;
1855
1848
  /**
1856
- * Specifies the title of the close button.
1849
+ * Sets the title of the **Close** button.
1857
1850
  */
1858
1851
  closeTitle;
1859
1852
  /**
1860
- * Specifies the position of the Tooltip that is
1861
- * relative to the anchor element.
1853
+ * Specifies the position of the Tooltip relative to the anchor element.
1862
1854
  *
1863
- * The possible values are:
1864
- * * `top` (default)
1865
- * * `bottom`
1866
- * * `left`
1867
- * * `right`
1855
+ * @default 'top'
1868
1856
  */
1869
1857
  position;
1870
1858
  /**
1871
- * Specifies when the Тooltip will be rendered.
1859
+ * Specifies the mouse action that triggers the Tooltip to show.
1872
1860
  *
1873
- * The possible values are:
1874
- * * `hover` (default)
1875
- * * `click`
1876
- * * `none`
1861
+ * @default 'hover'
1877
1862
  */
1878
1863
  showOn;
1879
1864
  /**
1880
1865
  * Specifies the delay in milliseconds before the Tooltip is shown.
1881
- * * `100` (default) milliseconds.
1866
+ *
1867
+ * @default 100
1882
1868
  */
1883
1869
  showAfter;
1884
1870
  /**
@@ -1895,12 +1881,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1895
1881
 
1896
1882
  /**
1897
1883
  * Represents the [Kendo UI Tooltip directive for Angular]({% slug overview_tooltip %}).
1898
- * Used to display additional information that is related to an element.
1884
+ * Displays additional information related to an element.
1899
1885
  *
1900
1886
  * @example
1901
- * ```ts-no-run
1887
+ * ```html
1902
1888
  * <div kendoTooltip>
1903
- * <a title="Tooltip title" href="foo">foo</a>
1889
+ * <button kendoButton title="Save">Save</button>
1904
1890
  * </div>
1905
1891
  * ```
1906
1892
  */
@@ -1910,75 +1896,63 @@ class TooltipDirective {
1910
1896
  renderer;
1911
1897
  popupService;
1912
1898
  /**
1913
- * Specifies a selector for elements within a container which will display a tooltip
1899
+ * Specifies a selector for elements within a container that display a tooltip
1914
1900
  * ([see example]({% slug anchorelements_tooltip %})). The possible values include any
1915
- * DOM `selector`. The default value is `[title]`.
1901
+ * DOM `selector`.
1902
+ * @default '[title]'
1916
1903
  */
1917
1904
  filter = '[title]';
1918
1905
  /**
1919
- * Specifies the position of the Tooltip that is relative to the
1906
+ * Specifies the position of the Tooltip relative to the
1920
1907
  * anchor element ([see example]({% slug positioning_tooltip %})).
1921
1908
  *
1922
- * The possible values are:
1923
- * * `top` (default)
1924
- * * `bottom`
1925
- * * `left`
1926
- * * `right`
1909
+ * @default 'top'
1927
1910
  */
1928
1911
  position = 'top';
1929
1912
  /**
1930
- * Renders the passed template as a header title of the Tooltip
1931
- * ([see example]({% slug anchorelements_tooltip %})).
1913
+ * Sets the template for the tooltip header title. [See example]({% slug anchorelements_tooltip %}).
1932
1914
  */
1933
1915
  titleTemplate;
1934
1916
  /**
1935
- * Specifies when the Тooltip will be rendered
1936
- * ([see example]({% slug programmaticopening_tooltip %})).
1937
- *
1938
- * The possible values are:
1939
- * * `hover` (default)
1940
- * * `click`
1941
- * * `none`
1917
+ * Specifies the mouse action that triggers the Tooltip to show. [See example]({% slug programmaticopening_tooltip %}).
1942
1918
  */
1943
1919
  showOn;
1944
1920
  /**
1945
1921
  * Specifies the delay in milliseconds before the Tooltip is shown.
1946
- * * `100` (default) milliseconds.
1922
+ *
1923
+ * @default 100
1947
1924
  */
1948
1925
  showAfter = 100;
1949
1926
  /**
1950
- * Specifies if the Тooltip will display a callout arrow.
1927
+ * Determines if the Tooltip displays a callout arrow.
1951
1928
  *
1952
- * The possible values are:
1953
- * * `true` (default)
1954
- * * `false`
1929
+ * @default true
1955
1930
  */
1956
1931
  callout = true;
1957
1932
  /**
1958
- * Specifies if the Тooltip will display a **Close** button
1959
- * ([see example]({% slug closable_tooltip %})).
1933
+ * Determines if the Tooltip displays a **Close** button. [See example]({% slug closable_tooltip %}).
1960
1934
  *
1961
- * The possible values are:
1962
- * * `true`
1963
- * * `false`
1935
+ * @default false
1964
1936
  */
1965
1937
  closable = false;
1966
1938
  /**
1967
- * Specifies the offset in pixels between the Tooltip and the anchor. Defaults to `6` pixels.
1939
+ * Specifies the offset in pixels between the Tooltip and the anchor.
1968
1940
  * If the `callout` property is set to `true`, the offset is rendered from the callout arrow.
1969
1941
  * If the `callout` property is set to `false`, the offset is rendered from the content of the Tooltip.
1942
+ *
1943
+ * @default 6
1970
1944
  */
1971
1945
  offset = 6;
1972
1946
  /**
1973
- * Specifies the width of the Тooltip ([see example]({% slug anchorelements_tooltip %})).
1947
+ * Sets the width of the Tooltip. [See example]({% slug anchorelements_tooltip %}).
1974
1948
  */
1975
1949
  tooltipWidth;
1976
1950
  /**
1977
- * Specifies the height of the Тooltip.
1951
+ * Sets the height of the Tooltip.
1978
1952
  */
1979
1953
  tooltipHeight;
1980
1954
  /**
1981
- * Specifies a CSS class that will be added to the Tooltip.
1955
+ * Sets a CSS class for the Tooltip.
1982
1956
  */
1983
1957
  tooltipClass;
1984
1958
  /**
@@ -1991,12 +1965,12 @@ class TooltipDirective {
1991
1965
  */
1992
1966
  collision;
1993
1967
  /**
1994
- * Specifies the title of the close button.
1968
+ * Sets the title of the **Close** button.
1995
1969
  */
1996
1970
  closeTitle;
1997
1971
  /**
1998
- * Sets the content of the Tooltip as a template reference
1999
- * ([see example]({% slug templates_tooltip %})).
1972
+ * Sets a custom content template for the Tooltip.
1973
+ * The template is rendered inside the Tooltip content area. [See example]({% slug templates_tooltip %}).
2000
1974
  */
2001
1975
  set tooltipTemplate(value) {
2002
1976
  this.template = value;
@@ -2044,8 +2018,7 @@ class TooltipDirective {
2044
2018
  }
2045
2019
  /**
2046
2020
  * Shows the Tooltip.
2047
- * @param anchor&mdash; ElementRef|Element.
2048
- * Specifies the element that will be used as an anchor. The Tooltip opens relative to that element.
2021
+ * @param anchor - The element used as an anchor. The Tooltip opens relative to this element.
2049
2022
  */
2050
2023
  show(anchor) {
2051
2024
  if (this.popupRef) {
@@ -2088,10 +2061,9 @@ class TooltipDirective {
2088
2061
  this.closePopup();
2089
2062
  }
2090
2063
  /**
2091
- * Toggle visibility of the Tooltip.
2092
- *
2093
- * @param anchor&mdash; ElementRef|Element. Specifies the element that will be used as an anchor.
2094
- * @param show&mdash; Optional. Boolean. Specifies if the Tooltip will be rendered.
2064
+ * Toggles the visibility of the Tooltip.
2065
+ * @param anchor - The element used as an anchor.
2066
+ * @param show - Optional. Boolean. Specifies if the Tooltip is rendered.
2095
2067
  */
2096
2068
  toggle(anchor, show) {
2097
2069
  const previousAnchor = this.anchor && this.anchor.nativeElement;
@@ -2382,7 +2354,25 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2382
2354
  }] } });
2383
2355
 
2384
2356
  /**
2385
- * Utility array that contains all `Tooltip` related components and directives
2357
+ * Use this utility array to access all Tooltip-related components and directives in a standalone Angular component.
2358
+ *
2359
+ * @example
2360
+ * ```typescript
2361
+ * import { Component } from '@angular/core';
2362
+ * import { KENDO_TOOLTIP } from '@progress/kendo-angular-tooltip';
2363
+ *
2364
+ * @Component({
2365
+ * selector: 'my-app',
2366
+ * standalone: true,
2367
+ * imports: [KENDO_TOOLTIP],
2368
+ * template: `
2369
+ * <div kendoTooltip>
2370
+ * <button kendoButton title="Save">Save</button>
2371
+ * </div>
2372
+ * `
2373
+ * })
2374
+ * export class AppComponent {}
2375
+ * ```
2386
2376
  */
2387
2377
  const KENDO_TOOLTIP = [
2388
2378
  TooltipDirective,
@@ -2390,7 +2380,27 @@ const KENDO_TOOLTIP = [
2390
2380
  LocalizedMessagesDirective
2391
2381
  ];
2392
2382
  /**
2393
- * Utility array that contains all `Popover` related components and directives
2383
+ * Use this utility array to access all Popover-related components and directives in a standalone Angular component.
2384
+ *
2385
+ * @example
2386
+ * ```typescript
2387
+ * import { Component } from '@angular/core';
2388
+ * import { KENDO_POPOVER } from '@progress/kendo-angular-tooltip';
2389
+ *
2390
+ * @Component({
2391
+ * selector: 'my-app',
2392
+ * standalone: true,
2393
+ * imports: [KENDO_POPOVER],
2394
+ * template: `
2395
+ * <div kendoPopoverAnchor [popover]="myPopover">
2396
+ * <button kendoButton>Open Popover</button>
2397
+ * </div>
2398
+ * <kendo-popover #myPopover title="Popover Title" body="Popover Body">
2399
+ * </kendo-popover>
2400
+ * `
2401
+ * })
2402
+ * export class AppComponent {}
2403
+ * ```
2394
2404
  */
2395
2405
  const KENDO_POPOVER = [
2396
2406
  PopoverComponent,
@@ -2401,7 +2411,31 @@ const KENDO_POPOVER = [
2401
2411
  PopoverContainerDirective
2402
2412
  ];
2403
2413
  /**
2404
- * Utility array that contains all `@progress/kendo-angular-tooltip` related components and directives
2414
+ * Use this utility array to access all `@progress/kendo-angular-tooltip`-related components and directives in a standalone Angular component.
2415
+ *
2416
+ * @example
2417
+ * ```typescript
2418
+ * import { Component } from '@angular/core';
2419
+ * import { KENDO_TOOLTIPS } from '@progress/kendo-angular-tooltip';
2420
+ *
2421
+ * @Component({
2422
+ * selector: 'my-app',
2423
+ * standalone: true,
2424
+ * imports: [KENDO_TOOLTIPS],
2425
+ * template: `
2426
+ * <div kendoTooltip>
2427
+ * <button kendoButton title="Save">Save</button>
2428
+ * </div>
2429
+ *
2430
+ * <div kendoPopoverAnchor [popover]="myPopover">
2431
+ * <button kendoButton>Open Popover</button>
2432
+ * </div>
2433
+ * <kendo-popover #myPopover title="Popover Title" body="Popover Body">
2434
+ * </kendo-popover>
2435
+ * `
2436
+ * })
2437
+ * export class AppComponent {}
2438
+ * ```
2405
2439
  */
2406
2440
  const KENDO_TOOLTIPS = [
2407
2441
  ...KENDO_TOOLTIP,
@@ -2410,33 +2444,24 @@ const KENDO_TOOLTIPS = [
2410
2444
 
2411
2445
  // IMPORTANT: NgModule export kept for backwards compatibility
2412
2446
  /**
2413
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
2447
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
2414
2448
  * definition for the Tooltip component.
2415
2449
  *
2416
2450
  * The package exports:
2417
- * - `KendoTooltipDirective`&mdash;The Tooltip directive class.
2451
+ * - `KendoTooltipDirective` — The Tooltip directive class.
2418
2452
  *
2419
2453
  * @example
2420
- *
2421
- * ```ts-no-run
2422
- * // Import the Tooltip module
2454
+ * ```typescript
2423
2455
  * import { TooltipModule } from '@progress/kendo-angular-tooltip';
2424
- *
2425
- * // The browser platform with a compiler
2426
2456
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
2427
- *
2428
2457
  * import { NgModule } from '@angular/core';
2429
2458
  *
2430
- * // Import the app component
2431
- * _@NgModule{{
2432
- * declarations: [AppComponent], // declare app component
2433
- * imports: [BrowserModule, TooltipModule], // import TooltipModule module
2459
+ * @NgModule{{
2460
+ * declarations: [AppComponent],
2461
+ * imports: [BrowserModule, TooltipModule],
2434
2462
  * bootstrap: [AppComponent]
2435
2463
  * }}
2436
2464
  * export class AppModule {}
2437
- *
2438
- * // Compile and launch the module
2439
- * platformBrowserDynamic().bootstrapModule(AppModule);
2440
2465
  * ```
2441
2466
  */
2442
2467
  class TooltipModule {
@@ -2455,28 +2480,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2455
2480
 
2456
2481
  // IMPORTANT: NgModule export kept for backwards compatibility
2457
2482
  /**
2458
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
2483
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
2459
2484
  * definition for the Popover component.
2460
2485
  *
2461
2486
  * @example
2462
- *
2463
- * ```ts-no-run
2487
+ * ```typescript
2464
2488
  * import { PopoverModule } from '@progress/kendo-angular-tooltip';
2465
2489
  *
2466
2490
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
2467
2491
  * import { NgModule } from '@angular/core';
2468
- *
2469
2492
  * import { AppComponent } from './app.component';
2470
2493
  *
2471
- * _@NgModule({
2494
+ * @NgModule({
2472
2495
  * declarations: [AppComponent],
2473
2496
  * imports: [BrowserModule, PopoverModule],
2474
2497
  * bootstrap: [AppComponent]
2475
2498
  * })
2476
2499
  * export class AppModule {}
2477
- *
2478
- * platformBrowserDynamic().bootstrapModule(AppModule);
2479
- *
2480
2500
  * ```
2481
2501
  */
2482
2502
  class PopoverModule {
@@ -2495,29 +2515,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2495
2515
 
2496
2516
  // IMPORTANT: NgModule export kept for backwards compatibility
2497
2517
  /**
2498
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
2518
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
2499
2519
  * definition for the Tooltips components.
2500
2520
  *
2501
2521
  * @example
2502
- *
2503
- * ```ts-no-run
2522
+ * ```typescript
2504
2523
  * import { TooltipsModule } from '@progress/kendo-angular-tooltip';
2505
- *
2506
- * // The browser platform with a compiler
2507
2524
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
2508
- *
2509
2525
  * import { NgModule } from '@angular/core';
2510
2526
  *
2511
- * // Import the app component
2512
- * _@NgModule{{
2513
- * declarations: [AppComponent], // declare app component
2514
- * imports: [BrowserModule, TooltipsModule], // import TooltipsModule module
2527
+ * @NgModule{{
2528
+ * declarations: [AppComponent],
2529
+ * imports: [BrowserModule, TooltipsModule],
2515
2530
  * bootstrap: [AppComponent]
2516
2531
  * }}
2517
2532
  * export class AppModule {}
2518
- *
2519
- * // Compile and launch the module
2520
- * platformBrowserDynamic().bootstrapModule(AppModule);
2521
2533
  * ```
2522
2534
  */
2523
2535
  class TooltipsModule {