@progress/kendo-angular-inputs 19.1.1-develop.2 → 19.1.2-develop.1

package/radiobutton/radiobutton.directive.d.ts

@@ -6,11 +6,11 @@ import { ElementRef, Renderer2 } from '@angular/core';
 import { InputSize } from '../common/models';
 import * as i0 from "@angular/core";
 /**
- * Represents the directive that renders the [Kendo UI RadioButton]({% slug overview_checkbox %}) input component.
- * The directive is placed on input type="radio" elements.
+ * Represents the directive that renders the Kendo UI RadioButton input component.
+ * Place the directive on `input type="radio"` HTML elements.
  *
  * @example
- * ```ts-no-run
+ * ```html
  * <input type="radio" kendoRadioButton />
  * ```
  */
@@ -19,13 +19,9 @@ export declare class RadioButtonDirective {
     private hostElement;
     kendoClass: boolean;
     /**
-     * The size property specifies the width and height of the RadioButton
-     * ([see example]({% slug appearance_radiobuttondirective %}#toc-size)).
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * Specifies the `size` of the RadioButton. The `size` property changes the width and height of the RadioButton ([see example]({% slug appearance_radiobuttondirective %}#toc-size)).
+     *
+     * @default "medium"
      */
     set size(size: InputSize);
     get size(): InputSize;

package/radiobutton.module.d.ts

@@ -6,34 +6,24 @@ import * as i0 from "@angular/core";
 import * as i1 from "./radiobutton/radiobutton.component";
 import * as i2 from "./radiobutton/radiobutton.directive";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the RadioButton directive and RadioButtonComponent.
+ * Defines the [NgModule](link:site.data.urls.angular['ngmoduleapi']) for the RadioButton directive and RadioButton component.
+ *
+ * Use this module to add the RadioButton directive and component to your NgModule-based Angular application.
  *
  * @example
  *
- * ```ts-no-run
- * // Import the RadioButton module
+ * ```typescript
  * import { RadioButtonModule } from '@progress/kendo-angular-inputs';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from '@angular/platform-browser';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, RadioButtonModule], // import RadioButton module
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, RadioButtonModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class RadioButtonModule {

package/rangeslider/localization/custom-messages.component.d.ts

@@ -6,7 +6,17 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { RangeSliderMessages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages.
+ * Lets you override the default messages of the RangeSlider component.
+ *
+ * @example
+ *
+ * ```html
+ * <kendo-rangeslider-messages
+ *     decreaseHandle="Decrease handle"
+ *     increaseHandle="Increase handle"
+ *     decreaseRange="Decrease range">
+ * </kendo-rangeslider-messages>
+ * ```
  */
 export declare class RangeSliderCustomMessagesComponent extends RangeSliderMessages {
     protected service: LocalizationService;

package/rangeslider/rangeslider-value.type.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The value type of the RangeSlider - an array of two numbers `[number, number]`,
- * representing the start and the end of the range.
+ * Defines the value type of the RangeSlider as an array of two numbers `[number, number]`.
+ * The array represents the start and end of the range.
  */
 export type RangeSliderValue = [number, number];

package/rangeslider/rangeslider.component.d.ts

@@ -9,7 +9,16 @@ import { SliderBase } from '../sliders-common/slider-base';
 import { RangeSliderValue } from './rangeslider-value.type';
 import * as i0 from "@angular/core";
 /**
- * Represents the [Kendo UI RangeSlider component for Angular]({% slug overview_rangeslider %}).
+ * Represents the Kendo UI RangeSlider component for Angular.
+ * Use this component to let users select a range of values.
+ *
+ * @example
+ * ```html
+ * <kendo-rangeslider [value]="[10, 50]" [min]="0" [max]="100"></kendo-rangeslider>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link RangeSliderCustomMessagesComponent}.
  */
 export declare class RangeSliderComponent extends SliderBase implements AfterViewInit, ControlValueAccessor, OnChanges, OnDestroy {
     protected localization: LocalizationService;
@@ -20,7 +29,7 @@ export declare class RangeSliderComponent extends SliderBase implements AfterVie
     protected hostElement: ElementRef;
     /**
      * Sets the range value of the RangeSlider.
-     * The component can use either NgModel or the `value` binding but not both of them at the same time.
+     * Use either `ngModel` or the `value` binding, but not both at the same time.
      */
     value: RangeSliderValue;
     draghandleStart: ElementRef;
@@ -46,23 +55,10 @@ export declare class RangeSliderComponent extends SliderBase implements AfterVie
     /**
      * Focuses the RangeSlider.
      *
-     * @example
-     * ```ts-no-run
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     *     <div>
-     *         <button class="k-button" (click)="slider.focus()">Focus</button>
-     *     </div>
-     *     <kendo-rangeslider #slider></kendo-rangeslider>
-     * `
-     * })
-     * class AppComponent { }
-     * ```
      */
     focus(): void;
     /**
-     * Blurs the RangeSlider.
+     * Removes focus from the RangeSlider.
      */
     blur(): void;
     ngOnInit(): void;

package/rangeslider.module.d.ts

@@ -7,35 +7,24 @@ import * as i1 from "./rangeslider/rangeslider.component";
 import * as i2 from "./rangeslider/localization/custom-messages.component";
 import * as i3 from "./sliders-common/label-template.directive";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the RangeSlider component.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the RangeSlider component.
+ *
+ * Use this module to add the RangeSlider component to your NgModule-based Angular application.
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Inputs module
+ * ```typescript
  * import { RangeSliderModule } from '@progress/kendo-angular-inputs';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
  * import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
- *
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, BrowserAnimationsModule, RangeSliderModule], // import RangeSlider module
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, BrowserAnimationsModule, RangeSliderModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class RangeSliderModule {

package/rating/directives/rating-hovered-item.directive.d.ts

@@ -5,10 +5,18 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Renders the hovered rating item content. To define an item template, nest an `<ng-template>` tag
- * with the `kendoRatingHoveredItemTemplate` directive inside the `<kendo-rating>` tag
- * [see example](slug:templates_rating).
+ * Renders the hovered rating item content.
+ * To define an item template, nest an `<ng-template>` tag with the `kendoRatingHoveredItemTemplate` directive inside the `<kendo-rating>` tag ([see example](slug:templates_rating)).
+ *
  * The index of the currently hovered item is available as an implicit context using the `let-index="index"` syntax.
+ * * @example
+ * ```html
+ * <kendo-rating [value]="ratingValue">
+ *   <ng-template kendoRatingHoveredItemTemplate let-index="index">
+ *     <span>Hovered item: {{ index }}</span>
+ *   </ng-template>
+ * </kendo-rating>
+ * ```
  */
 export declare class RatingHoveredItemTemplateDirective {
     templateRef: TemplateRef<any>;

package/rating/directives/rating-item.directive.d.ts

@@ -5,10 +5,17 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Renders the rating item content. To define an item template, nest an `<ng-template>` tag
- * with the `kendoRatingItemTemplate` directive inside the `<kendo-rating>` tag
- * [see example](slug:templates_rating).
+ * Renders the rating item content.
+ * To define an item template, nest an `<ng-template>` tag with the `kendoRatingItemTemplate` directive inside the `<kendo-rating>` tag ([see example](slug:templates_rating)).
  * The index of the current item is available as an implicit context using the `let-index="index"` syntax.
+ * * @example
+ * ```html
+ * <kendo-rating [value]="ratingValue">
+ *   <ng-template kendoRatingItemTemplate let-index="index">
+ *     <span>Item: {{ index }}</span>
+ *   </ng-template>
+ * </kendo-rating>
+ * ```
  */
 export declare class RatingItemTemplateDirective {
     templateRef: TemplateRef<any>;

package/rating/directives/rating-selected-item.directive.d.ts

@@ -5,10 +5,19 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Renders the selected rating item content. To define an item template, nest an `<ng-template>` tag
- * with the `kendoRatingSelectedItemTemplate` directive inside the `<kendo-rating>` tag
- * [see example](slug:templates_rating).
+ * Renders the selected rating item content.
+ * To define an item template, nest an `<ng-template>` tag with the `kendoRatingSelectedItemTemplate` directive inside the `<kendo-rating>` tag ([see example](slug:templates_rating)).
+ *
  * The index of the currently selected item is available as an implicit context using the `let-index="index"` syntax.
+ *
+ * @example
+ * ```html
+ * <kendo-rating [value]="ratingValue">
+ *   <ng-template kendoRatingSelectedItemTemplate let-index="index">
+ *     <span>Selected item: {{ index }}</span>
+ *   </ng-template>
+ * </kendo-rating>
+ * ```
  */
 export declare class RatingSelectedItemTemplateDirective {
     templateRef: TemplateRef<any>;

package/rating/models/precision.d.ts

@@ -3,11 +3,10 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Specifies the precision with which an item is selected.
+ * Sets the precision with which an item is selected.
  *
  * The available values are:
  * * `item` (default)
  * * `half`
- *
  */
 export type RatingPrecision = 'item' | 'half';

package/rating/models/selection.d.ts

@@ -3,11 +3,10 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Sets the selection mode of the Rating ([see example]({% slug selection_rating %})).
+ * Sets the `selection` mode of the Rating ([see example]({% slug selection_rating %})).
  *
  * The available values are:
  * * `continuous` (default)
  * * `single`
- *
  */
 export type RatingSelectionMode = 'continuous' | 'single';

package/rating/rating.component.d.ts

@@ -14,7 +14,13 @@ import { RatingSelectedItemTemplateDirective } from './directives/rating-selecte
 import { RatingPrecision } from './models/precision';
 import * as i0 from "@angular/core";
 /**
- * Represents the [Kendo UI Rating component for Angular]({% slug overview_rating %}).
+ * Represents the Kendo UI Rating component for Angular.
+ * Use this component to let users select a rating value.
+ *
+ * @example
+ * ```html
+ * <kendo-rating [itemsCount]="5" [(value)]="ratingValue"></kendo-rating>
+ * ```
  */
 export declare class RatingComponent implements OnInit, AfterViewInit, OnDestroy, ControlValueAccessor {
     element: ElementRef;
@@ -26,37 +32,36 @@ export declare class RatingComponent implements OnInit, AfterViewInit, OnDestroy
     hoveredItemTemplate: RatingHoveredItemTemplateDirective;
     selectedItemTemplate: RatingSelectedItemTemplateDirective;
     /**
-     * Determines whether the Rating is disabled ([see example]({% slug disabledstate_rating %})). To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_rating#toc-managing-the-rating-disabled-state-in-reactive-forms).
+     * When `true`, disables the Rating ([see example]({% slug disabledstate_rating %})).
+
+     * To disable the component in reactive forms, see [Forms Support](slug:formssupport_rating#toc-managing-the-rating-disabled-state-in-reactive-forms).
      *
      * @default false
-     *
      */
     disabled: boolean;
     /**
-     * Determines whether the Rating is in its read-only state ([see example]({% slug readonly_rating %})).
+     * When `true`, sets the Rating to read-only ([see example]({% slug readonly_rating %})).
+
      *
      * @default false
-     *
      */
     readonly: boolean;
     /**
-     * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the Rating.
+     * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the Rating.
+
      *
      * @default 0
-     *
      */
     tabindex: number;
     /**
      * Sets the number of Rating items ([see example]({% slug itemscount_rating %})).
      *
      * @default 5
-     *
      */
     itemsCount: number;
     /**
-     * The initial value of the Rating component.
-     * The component can use either NgModel or the `value` binding but not both of them at the same time.
-     *
+     * Sets the initial value of the Rating component.
+     * Use either `ngModel` or the `value` binding, but not both at the same time.
      */
     set value(value: number);
     get value(): number;
@@ -64,20 +69,18 @@ export declare class RatingComponent implements OnInit, AfterViewInit, OnDestroy
      * Sets the selection mode of the Rating ([see example]({% slug selection_rating %})).
      *
      * @default 'continuous'
-     *
      */
     set selection(selection: RatingSelectionMode);
     get selection(): RatingSelectionMode;
     /**
-     * Determines the precision of the Rating ([see example]({% slug precision_rating %})).
+     * Sets the precision of the Rating ([see example]({% slug precision_rating %})).
      *
      * @default 'item'
-     *
      */
     set precision(precision: RatingPrecision);
     get precision(): RatingPrecision;
     /**
-     * Sets the Rating label to the provided text. The text is rendered in a `<span>` element, instead of the native HTML `<label>` element ([see example]({% slug label_rating %})).
+     * Sets the label text for the Rating. The text renders in a `<span>` element ([see example]({% slug label_rating %})).
      */
     label: string;
     /**
@@ -85,15 +88,15 @@ export declare class RatingComponent implements OnInit, AfterViewInit, OnDestroy
      */
     icon: string;
     /**
-     * Sets a custom SVG icon for the selected/hovered state of the Rating items ([see example]({% slug icon_rating %})).
+     * Sets a custom SVG icon for the selected or hovered state of the Rating items ([see example]({% slug icon_rating %})).
      */
     svgIcon: SVGIcon;
     /**
-     * Sets a custom SVG icon for the default state of the Rating items when they are not hovered or selected ([see example]({% slug icon_rating %})).
+     * Sets a custom SVG icon for the default state of the Rating items when not hovered or selected ([see example]({% slug icon_rating %})).
      */
     svgIconOutline: SVGIcon;
     /**
-     * Fires each time the user selects a new value.
+     * Fires when the user selects a new value.
      */
     valueChange: EventEmitter<number>;
     hostClass: boolean;

package/rating.module.d.ts

@@ -8,34 +8,23 @@ import * as i2 from "./rating/directives/rating-item.directive";
 import * as i3 from "./rating/directives/rating-hovered-item.directive";
 import * as i4 from "./rating/directives/rating-selected-item.directive";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Rating component.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Rating component.
+ *
+ * Use this module to add the Rating component to your NgModule-based Angular application.
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Rating module
+ * ```typescript
  * import { RatingModule } from '@progress/kendo-angular-inputs';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, RatingModule], // import Rating module
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, RatingModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class RatingModule {

package/shared/input-separator.component.d.ts

@@ -5,26 +5,21 @@
 import { SeparatorOrientation } from '@progress/kendo-angular-common';
 import * as i0 from "@angular/core";
 /**
- * Specifies a separator in the content of components like the TextArea and the TextBox. ([see examples]({% slug adornments_textbox %}#toc-separator)).
+ * Represents a separator in the content of components like TextArea and TextBox. ([see examples]({% slug adornments_textbox %}#toc-separator)).
+ *
  * @example
- * ```ts-no-run
- * _@Component({
- * selector: 'my-app',
- * template: `
- *  <kendo-textbox>
- *    <ng-template kendoTextBoxSuffixTemplate>
- *        <kendo-input-separator></kendo-input-separator>
- *        <button kendoButton look="clear" icon="image"></button>
- *    </ng-template>
- *  </kendo-textbox>
- * `
- * })
- * class AppComponent {}
+ * ```html
+ * <kendo-textbox>
+ *   <ng-template kendoTextBoxSuffixTemplate>
+ *     <kendo-input-separator></kendo-input-separator>
+ *     <button kendoButton icon="image"></button>
+ *   </ng-template>
+ * </kendo-textbox>
  * ```
  */
 export declare class InputSeparatorComponent {
     /**
-     * Specifies the orientation of the separator. Applicable for the adornments of the [`TextAreaComponent`](slug:api_inputs_textareacomponent).
+     * Sets the orientation of the separator. Use this for the adornments of the [`TextAreaComponent`](slug:api_inputs_textareacomponent).
      *
      * @default 'vertical'
      */

package/shared/textarea.directive.d.ts

@@ -6,11 +6,10 @@ import { ElementRef, EventEmitter, OnDestroy, Renderer2, OnChanges, OnInit, NgZo
 import { ControlValueAccessor } from '@angular/forms';
 import * as i0 from "@angular/core";
 /**
- * Represents the [Kendo UI TextArea directive for the Inputs components for Angular]({% slug overview_textarea %}).
- * Provides floating labels to `textarea` elements.
+ * Represents the Kendo UI TextArea directive for the Inputs components for Angular.
  *
  * @example
- * ```ts-no-run
+ * ```html
  * <textarea kendoTextArea></textarea>
  * ```
  */
@@ -24,18 +23,18 @@ export declare class TextAreaDirective implements OnInit, OnDestroy, OnChanges,
     autofillClass: boolean;
     direction: string;
     /**
-     * Fires each time the textarea value is changed.
+     * Fires when the TextArea value changes.
      */
     valueChange: EventEmitter<any>;
     /**
-     * Specifies if the `textarea` element will resize its height automatically
+     * Sets whether the `textarea` element resizes its height automatically
      * ([see example](slug:textarea_sizing#toc-auto-resizing)).
      *
      * @default false
      */
     autoSize: boolean;
     /**
-     * Specifies the textarea value.
+     * Sets the textarea value.
      */
     value: string;
     /**

package/signature/events/close-event.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from "@progress/kendo-angular-common";
 /**
- * Arguments for the `close` event of the Signature component.
+ * Provides arguments for the `close` event of the Signature component.
  */
 export declare class SignatureCloseEvent extends PreventableEvent {
 }

package/signature/localization/custom-messages.component.d.ts

@@ -6,7 +6,7 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { SignatureMessages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages.
+ * Use this component to override the default Signature messages.
  */
 export declare class SignatureCustomMessagesComponent extends SignatureMessages {
     protected service: LocalizationService;