@progress/kendo-angular-tooltip 19.1.2-develop.3 → 19.1.2-develop.5

package/esm2022/tooltip/tooltip.directive.mjs

@@ -17,12 +17,12 @@ import * as i1 from "@progress/kendo-angular-popup";
 import * as i2 from "./tooltip.settings";
 /**
  * Represents the [Kendo UI Tooltip directive for Angular]({% slug overview_tooltip %}).
- * Used to display additional information that is related to an element.
+ * Displays additional information related to an element.
  *
  * @example
- * ```ts-no-run
+ * ```html
  * <div kendoTooltip>
- *    <a title="Tooltip title" href="foo">foo</a>
+ *   <button kendoButton title="Save">Save</button>
  * </div>
  * ```
  */
@@ -32,75 +32,63 @@ export class TooltipDirective {
     renderer;
     popupService;
     /**
-     * Specifies a selector for elements within a container which will display a tooltip
+     * Specifies a selector for elements within a container that display a tooltip
      * ([see example]({% slug anchorelements_tooltip %})). The possible values include any
-     * DOM `selector`. The default value is `[title]`.
+     * DOM `selector`.
+     * @default '[title]'
      */
     filter = '[title]';
     /**
-     * Specifies the position of the Tooltip that is relative to the
+     * Specifies the position of the Tooltip relative to the
      * anchor element ([see example]({% slug positioning_tooltip %})).
      *
-     * The possible values are:
-     * * `top` (default)
-     * * `bottom`
-     * * `left`
-     * * `right`
+     * @default 'top'
      */
     position = 'top';
     /**
-     * Renders the passed template as a header title of the Tooltip
-     * ([see example]({% slug anchorelements_tooltip %})).
+     * Sets the template for the tooltip header title. [See example]({% slug anchorelements_tooltip %}).
      */
     titleTemplate;
     /**
-     * Specifies when the Тooltip will be rendered
-     * ([see example]({% slug programmaticopening_tooltip %})).
-     *
-     * The possible values are:
-     * * `hover` (default)
-     * * `click`
-     * * `none`
+     * Specifies the mouse action that triggers the Tooltip to show. [See example]({% slug programmaticopening_tooltip %}).
      */
     showOn;
     /**
      * Specifies the delay in milliseconds before the Tooltip is shown.
-     * * `100` (default) milliseconds.
+     *
+     * @default 100
      */
     showAfter = 100;
     /**
-     * Specifies if the Тooltip will display a callout arrow.
+     * Determines if the Tooltip displays a callout arrow.
      *
-     * The possible values are:
-     * * `true` (default)
-     * * `false`
+     * @default true
      */
     callout = true;
     /**
-     * Specifies if the Тooltip will display a **Close** button
-     * ([see example]({% slug closable_tooltip %})).
+     * Determines if the Tooltip displays a **Close** button. [See example]({% slug closable_tooltip %}).
      *
-     * The possible values are:
-     * * `true`
-     * * `false`
+     * @default false
      */
     closable = false;
     /**
-     * Specifies the offset in pixels between the Tooltip and the anchor. Defaults to `6` pixels.
+     * Specifies the offset in pixels between the Tooltip and the anchor.
      * If the `callout` property is set to `true`, the offset is rendered from the callout arrow.
      * If the `callout` property is set to `false`, the offset is rendered from the content of the Tooltip.
+     *
+     * @default 6
      */
     offset = 6;
     /**
-     * Specifies the width of the Тooltip ([see example]({% slug anchorelements_tooltip %})).
+     * Sets the width of the Tooltip. [See example]({% slug anchorelements_tooltip %}).
      */
     tooltipWidth;
     /**
-     * Specifies the height of the Тooltip.
+     * Sets the height of the Tooltip.
      */
     tooltipHeight;
     /**
-     * Specifies a CSS class that will be added to the Tooltip.
+     * Sets a CSS class for the Tooltip.
      */
     tooltipClass;
     /**
@@ -113,12 +101,12 @@ export class TooltipDirective {
      */
     collision;
     /**
-     * Specifies the title of the close button.
+     * Sets the title of the **Close** button.
      */
     closeTitle;
     /**
-     * Sets the content of the Tooltip as a template reference
-     * ([see example]({% slug templates_tooltip %})).
+     * Sets a custom content template for the Tooltip.
+     * The template is rendered inside the Tooltip content area. [See example]({% slug templates_tooltip %}).
      */
     set tooltipTemplate(value) {
         this.template = value;
@@ -166,8 +154,7 @@ export class TooltipDirective {
     }
     /**
      * Shows the Tooltip.
-     * @param anchor&mdash; ElementRef|Element.
-     * Specifies the element that will be used as an anchor. The Tooltip opens relative to that element.
+     * @param anchor - The element used as an anchor. The Tooltip opens relative to this element.
      */
     show(anchor) {
         if (this.popupRef) {
@@ -210,10 +197,9 @@ export class TooltipDirective {
         this.closePopup();
     }
     /**
-     * Toggle visibility of the Tooltip.
-     *
-     * @param anchor&mdash; ElementRef|Element. Specifies the element that will be used as an anchor.
-     * @param show&mdash; Optional. Boolean. Specifies if the Tooltip will be rendered.
+     * Toggles the visibility of the Tooltip.
+     * @param anchor - The element used as an anchor.
+     * @param show - Optional. Boolean. Specifies if the Tooltip is rendered.
      */
     toggle(anchor, show) {
         const previousAnchor = this.anchor && this.anchor.nativeElement;

package/esm2022/tooltip/tooltip.settings.mjs

@@ -11,66 +11,50 @@ import * as i0 from "@angular/core";
  */
 export const TOOLTIP_SETTINGS = new InjectionToken('kendo-ui-tooltip-settings');
 /**
- * Provides a global configuration for the Kendo UI Tooltip. Once injected through
- * the `AppComponent` constructor, the configuration properties can be overridden.
+ * Provides a global configuration for the Kendo UI Tooltip. Inject this class in the `AppComponent` constructor to override configuration properties.
  *
  * @example
- * ```ts-no-run
+ * ```typescript
  * import { TooltipSettings } from '@progress/kendo-angular-tooltip';
  *
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *      <div kendoTooltip>
- *          <button title="Saves the current document">Save</button>
- *      </div>`,
- *    providers: [{
- *        provide: TooltipSettings,
- *        useFactory: (): TooltipSettings => ({
- *          // Override default values of tooltips if wanted
- *          position: 'right'
- *        })
- *    }]
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `<div kendoTooltip><button title="Save">Save</button></div>`,
+ *   providers: [{
+ *     provide: TooltipSettings,
+ *     useFactory: (): TooltipSettings => ({ position: 'right' })
+ *   }]
  * })
- * export class AppComponent { }
+ * export class AppComponent {}
  * ```
  */
 export class TooltipSettings {
     /**
-     * Specifies if the Тooltip will display a callout arrow.
+     * Determines if the Tooltip displays a callout arrow.
      *
-     * The possible values are:
-     * * `true` (default)
-     * * `false`
+     * @default true
      */
     callout;
     /**
-     * Specifies the title of the close button.
+     * Sets the title of the **Close** button.
      */
     closeTitle;
     /**
-     * Specifies the position of the Tooltip that is
-     * relative to the anchor element.
+     * Specifies the position of the Tooltip relative to the anchor element.
      *
-     * The possible values are:
-     * * `top` (default)
-     * * `bottom`
-     * * `left`
-     * * `right`
+     * @default 'top'
      */
     position;
     /**
-     * Specifies when the Тooltip will be rendered.
+     * Specifies the mouse action that triggers the Tooltip to show.
      *
-     * The possible values are:
-     * * `hover` (default)
-     * * `click`
-     * * `none`
+     * @default 'hover'
      */
     showOn;
     /**
      * Specifies the delay in milliseconds before the Tooltip is shown.
-     * * `100` (default) milliseconds.
+     *
+     * @default 100
      */
     showAfter;
     /**

package/esm2022/tooltip.module.mjs

@@ -13,33 +13,24 @@ import * as i2 from "./tooltip/tooltip.content.component";
 import * as i3 from "./localization/localized-messages.directive";
 // IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
  * definition for the Tooltip component.
  *
  * The package exports:
- * - `KendoTooltipDirective`—The Tooltip directive class.
+ * - `KendoTooltipDirective` — The Tooltip directive class.
  *
  * @example
- *
- * ```ts-no-run
- * // Import the Tooltip module
+ * ```typescript
  * import { TooltipModule } from '@progress/kendo-angular-tooltip';
- *
- * // The browser platform with a compiler
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
  * import { NgModule } from '@angular/core';
  *
- * // Import the app component
- * _@NgModule{{
- *    declarations: [AppComponent], // declare app component
- *    imports:      [BrowserModule, TooltipModule], // import TooltipModule module
+ * @NgModule{{
+ *    declarations: [AppComponent],
+ *    imports:      [BrowserModule, TooltipModule],
  *    bootstrap:    [AppComponent]
  * }}
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
  * ```
  */
 export class TooltipModule {

package/esm2022/tooltips.module.mjs

@@ -19,29 +19,21 @@ import * as i8 from "./popover/anchor.directive";
 import * as i9 from "./popover/container.directive";
 // IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
  * definition for the Tooltips components.
  *
  * @example
- *
- * ```ts-no-run
+ * ```typescript
  * import { TooltipsModule } from '@progress/kendo-angular-tooltip';
- *
- * // The browser platform with a compiler
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
  * import { NgModule } from '@angular/core';
  *
- * // Import the app component
- * _@NgModule{{
- *    declarations: [AppComponent], // declare app component
- *    imports:      [BrowserModule, TooltipsModule], // import TooltipsModule module
+ * @NgModule{{
+ *    declarations: [AppComponent],
+ *    imports:      [BrowserModule, TooltipsModule],
  *    bootstrap:    [AppComponent]
  * }}
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
  * ```
  */
 export class TooltipsModule {