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

package/signature/signature.component.d.ts

@@ -12,7 +12,15 @@ import * as i0 from "@angular/core";
 /**
  * Represents the [Kendo UI Signature component for Angular]({% slug overview_signature %}).
  *
- * The Signature allows users to add a hand-drawn signature to forms.
+ * Use the Signature to let users add a hand-drawn signature to forms.
+ *
+ * @example
+ * ```html
+ * <kendo-signature [(ngModel)]="signatureValue"></kendo-signature>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SignatureCustomMessagesComponent}.
  */
 export declare class SignatureComponent implements ControlValueAccessor {
     private element;
@@ -30,29 +38,34 @@ export declare class SignatureComponent implements ControlValueAccessor {
     /**
      * Sets the read-only state of the Signature.
      *
+     * Set to `true` to prevent editing.
+     *
      * @default false
      */
     readonly: boolean;
     /**
-     * Sets the disabled state of the Signature. To disable the component in reactive forms, visit the following [article](slug:formssupport_signature#toc-managing-the-signature-disabled-state-in-reactive-forms)
+     * Sets the disabled state of the Signature.
+     *
+     * Set to `true` to disable the component and prevent any user interaction.
+     * To disable the component in reactive forms, see [Managing the Signature Disabled State in Reactive Forms](slug:formssupport_signature#toc-managing-the-signature-disabled-state-in-reactive-forms).
      *
      * @default false
      */
     disabled: boolean;
     /**
-     * Sets the width of the signature in pixels.
+     * Sets the width of the Signature in pixels.
      *
-     * The width can also be set using inline styles and CSS.
+     * You can also set the width using inline styles or CSS.
      */
     width: number;
     /**
-     * The height of the signature in pixels.
+     * Sets the height of the Signature in pixels.
      *
-     * The height can also be set using inline styles and CSS.
+     * You can also set the height using inline styles or CSS.
      */
     height: number;
     /**
-     * Gets or sets the value of the signature.
+     * Gets or sets the value of the Signature.
      *
      * The value is a Base64-encoded PNG image.
      */
@@ -70,69 +83,54 @@ export declare class SignatureComponent implements ControlValueAccessor {
     set tabindex(value: number);
     get tabindex(): number;
     /**
-     * The size property specifies the padding of the Signature internal controls
-     * ([see example]({% slug appearance_signature %}#toc-size)).
+     * Sets the padding of the Signature internal controls
+     * ([ee example]({% slug appearance_signature %}#toc-size)).
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * @default 'medium'
      */
     size: InputSize;
     /**
-     * The `rounded` property specifies the border radius of the signature
+     * Sets the border radius of the Signature
      * ([see example](slug:appearance_signature#rounded-corners)).
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `full` (not supported by the Signature)
-     * * `none`
+     * @default 'medium'
      */
     rounded: InputRounded;
     /**
-     * The `fillMode` property specifies the background and border styles of the signature
+     * Sets the background and border styles of the Signature
      * ([see example](slug:appearance_signature#toc-fill-mode)).
      *
-     * The possible values are:
-     * * `flat`
-     * * `solid` (default)
-     * * `outline`
-     * * `none`
+     * @default 'solid'
      */
     fillMode: InputFillMode;
     /**
-     * The stroke color of the signature.
+     * Sets the stroke color of the Signature.
      *
      * Accepts CSS color names and hex values.
-     *
      * The default value is determined by the theme `$kendo-input-text` variable.
      */
     color: any;
     /**
-     * The background color of the signature.
+     * Sets the background color of the Signature.
      *
      * Accepts CSS color names and hex values.
-     *
      * The default value is determined by the theme `$kendo-input-bg` variable.
      */
     backgroundColor: any;
     /**
-     * The stroke width of the signature.
+     * Sets the stroke width of the Signature.
      *
      * @default 1
      */
     strokeWidth: number;
     /**
-     * A flag indicating whether to smooth out signature lines.
+     * When set to `true`, smooths out signature lines.
      *
      * @default false
      */
     smooth: boolean;
     /**
-     * A flag indicating if the signature can be maximized.
+     * When set to `true`, allows the Signature to be maximized.
      *
      * @default true
      */
@@ -142,17 +140,17 @@ export declare class SignatureComponent implements ControlValueAccessor {
      */
     maximized: boolean;
     /**
-     * The scale factor for the popup.
+     * Sets the scale factor for the popup.
      *
-     * The Signature width and height will be multiplied by the scale when showing the popup.
+     * The Signature width and height are multiplied by this value when showing the popup.
      *
      * @default 3
      */
     popupScale: number;
     /**
-     * The scale factor for the exported image.
+     * Sets the scale factor for the exported image.
      *
-     * The Signature width and height will be multiplied by the scale when converting the signature to an image.
+     * The Signature width and height are multiplied by this value when converting the signature to an image.
      *
      * @default 2
      */
@@ -162,31 +160,33 @@ export declare class SignatureComponent implements ControlValueAccessor {
      */
     parentLocalization: LocalizationService;
     /**
-     * A flag indicating whether the dotted line should be displayed in the background.
+     * When set to `true`, hides the dotted line in the background.
      *
      * @default false
      */
     hideLine: boolean;
     /**
-     * Fires each time the signature value is changed.
+     * Fires when the signature value changes.
      */
     valueChange: EventEmitter<string>;
     /**
-     * Fires each time the popup is about to open.
-     * This event is preventable. If you cancel it, the popup will remain closed.
+     * Fires before the popup opens.
+     *
+     * This event is preventable. If you cancel it, the popup stays closed.
      */
     open: EventEmitter<SignatureOpenEvent>;
     /**
-     * Fires each time the popup is about to close.
-     * This event is preventable. If you cancel it, the popup will remain open.
+     * Fires before the popup closes.
+     *
+     * This event is preventable. If you cancel it, the popup stays open.
      */
     close: EventEmitter<SignatureCloseEvent>;
     /**
-     * Fires each time Signature is focused.
+     * Fires when the Signature receives focus.
      */
     onFocus: EventEmitter<any>;
     /**
-     * Fires each time the Signature is blurred.
+     * Fires when the Signature loses focus.
      */
     onBlur: EventEmitter<any>;
     /**
@@ -197,11 +197,11 @@ export declare class SignatureComponent implements ControlValueAccessor {
     minimizeButton: ElementRef;
     maximizeButton: ElementRef;
     /**
-     * Indicates whether the Signature wrapper is focused.
+     * Indicates if the Signature wrapper is focused.
      */
     isFocused: boolean;
     /**
-     * Indicates whether the Signature popup is open.
+     * Indicates if the Signature popup is open.
      */
     isOpen: boolean;
     /**
@@ -305,9 +305,10 @@ export declare class SignatureComponent implements ControlValueAccessor {
     reset(): void;
     /**
      * Toggles the popup of the Signature.
-     * Does not trigger the `open` and `close` events of the component.
      *
-     * @param open An optional parameter. Specifies whether the popup will be opened or closed.
+     * Does not trigger the `open` and `close` events.
+     *
+     * @param open Optional. Set to `true` to open or `false` to close the popup.
      */
     toggle(open?: boolean): void;
     /**
@@ -321,7 +322,7 @@ export declare class SignatureComponent implements ControlValueAccessor {
     private applyHostClasses;
     private readThemeColors;
     /**
-     * Focuses the wrapper of the Signature.
+     * Focuses the Signature wrapper container.
      */
     focus(): void;
     /**

package/signature.module.d.ts

@@ -6,34 +6,23 @@ import * as i0 from "@angular/core";
 import * as i1 from "./signature/signature.component";
 import * as i2 from "./signature/localization/custom-messages.component";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Signature component.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Signature component.
+ *
+ * Use this module to add the Signature component to your NgModule-based Angular application.
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Signature module
+ * ```typescript
  * import { SignatureModule } 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, SignatureModule], // import Signature module
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, SignatureModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class SignatureModule {

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

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

package/slider/slider.component.d.ts

@@ -10,6 +10,14 @@ import { SVGIcon } from '@progress/kendo-svg-icons';
 import * as i0 from "@angular/core";
 /**
  * Represents the [Kendo UI Slider component for Angular]({% slug overview_slider %}).
+ *
+ * @example
+ * ```html
+ * <kendo-slider [min]="0" [max]="10" [smallStep]="1" [(ngModel)]="value"></kendo-slider>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SliderCustomMessagesComponent}.
  */
 export declare class SliderComponent extends SliderBase implements AfterViewInit, ControlValueAccessor, OnChanges, OnDestroy {
     protected localization: LocalizationService;
@@ -23,7 +31,7 @@ export declare class SliderComponent extends SliderBase implements AfterViewInit
      */
     focusableId: string;
     /**
-     * Changes the `title` attribute of the drag handle so that it can be localized.
+     * Changes the `title` attribute of the drag handle. Use this property to localize the drag handle title.
      */
     dragHandleTitle: string;
     /**
@@ -31,8 +39,9 @@ export declare class SliderComponent extends SliderBase implements AfterViewInit
      */
     incrementTitle: string;
     /**
-     * Determines if the animation will be played on value change.
-     * Regardless of this setting, no animation will be played during the initial rendering.
+     * Determines if the component animates when the value changes.
+     * The component does not animate during initial rendering.
+     * @default true
      */
     animate: boolean;
     /**
@@ -40,13 +49,15 @@ export declare class SliderComponent extends SliderBase implements AfterViewInit
      */
     decrementTitle: string;
     /**
-     * Renders the arrow side buttons of the Slider ([see example]({% slug sidebuttons_slider %}#toc-hidden-state)).
-     * When `showButtons` is set to `false`, the buttons are not displayed.
+     * Shows or hides the arrow side buttons of the Slider ([see example]({% slug sidebuttons_slider %}#toc-hidden-state)).
+     * When you set `showButtons` to `false`, the component does not display the buttons.
+     * @default true
      */
     showButtons: boolean;
     /**
-     * The current value of the Slider when it is initially displayed.
-     * The component can use either NgModel or the `value` binding but not both of them at the same time.
+     * Sets the current value of the Slider when it first appears.
+     * Use either `ngModel` or the `value` binding, but not both at the same time.
+     * @default 0
      */
     value: number;
     /**
@@ -82,18 +93,6 @@ export declare class SliderComponent extends SliderBase implements AfterViewInit
     constructor(localization: LocalizationService, injector: Injector, renderer: Renderer2, ngZone: NgZone, changeDetector: ChangeDetectorRef, hostElement: ElementRef);
     /**
      * Focuses the Slider.
-     *
-     * @example
-     * ```ts-no-run
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     *  <button (click)="slider.focus()">Focus</button>
-     *  <kendo-slider #slider></kendo-slider>
-     * `
-     * })
-     * class AppComponent { }
-     * ```
      */
     focus(): void;
     /**

package/slider.module.d.ts

@@ -7,35 +7,24 @@ import * as i1 from "./slider/slider.component";
 import * as i2 from "./slider/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 Slider component.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Slider component.
+ *
+ * Use this module to add the Slider component to your NgModule-based Angular application.
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Inputs module
+ * ```typescript
  * import { SliderModule } 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, SliderModule], // import Slider module
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, BrowserAnimationsModule, SliderModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class SliderModule {

package/sliders-common/label-template.directive.d.ts

@@ -5,27 +5,17 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the template for the labels of the Slider.
- * To define the labels template, nest an `<ng-template>` tag with the `kendoSliderLabelTemplate` directive inside
- * the `<kendo-slider>` tag. The template context is passed to the `label` value.
+ * Represents the template for Slider labels.
+ * To define a labels template, nest an `<ng-template>` tag with the `kendoSliderLabelTemplate` directive inside
+ * the `<kendo-slider>` tag. The template context provides the `value`.
  *
  * @example
- * ```ts-no-run
- *
- * _@Component({
- *     selector: 'my-app',
- *     template: `
- *         <kendo-slider [largeStep]="2">
- *           <ng-template kendoSliderLabelTemplate let-value="value">
- *             <b>{{value}}</b>
- *           </ng-template>
- *         </kendo-slider>
- *     `
- * })
- *
- * class AppComponent {
- * }
- *
+ * ```html
+ * <kendo-slider [largeStep]="2">
+ *   <ng-template kendoSliderLabelTemplate let-value="value">
+ *     <p>{{ value }}</p>
+ *   </ng-template>
+ * </kendo-slider>
  * ```
  */
 export declare class LabelTemplateDirective {

package/sliders-common/slider-base.d.ts

@@ -20,77 +20,95 @@ export declare abstract class SliderBase {
     protected changeDetector: ChangeDetectorRef;
     protected hostElement: ElementRef;
     /**
-     * Defines the title of the ticks ([see example]({% slug ticks_slider %}#toc-titles)). The default title
-     * for each tick is its Slider value. If you use a callback function, the function accepts an argument
-     * that holds the value of the component and returns a string with the new title.
+     * Sets the title for the ticks.
+     * The default title for each tick is its Slider value.
+     * If you use a callback function, the function receives the component value and returns a string for the new title [see example]({% slug ticks_slider %}#toc-titles).
      */
     title: SliderTickTitleCallback;
     /**
-     * Denotes the location of the tick marks in the Slider ([see example]({% slug ticks_slider %}#toc-placement)).
+     * Sets the location of the tick marks in the Slider [see example]({% slug ticks_slider %}#toc-placement).
      *
-     * The available options are:
-     * * `before`—The tick marks are located to the top side of the horizontal track or to the left side of a vertical track.
-     * * `after`—The tick marks are located to the bottom side of the horizontal track or to the right side of the vertical track.
-     * * `both`— (Default) The tick marks are located on both sides of the track.
-     * * `none`—The tick marks are not visible. The actual elements are not added to the DOM tree.
+     * The options are:
+     * - `before` – Shows tick marks above a horizontal track or left of a vertical track.
+     * - `after` – Shows tick marks below a horizontal track or right of a vertical track.
+     * - `both` – Shows tick marks on both sides of the track.
+     * - `none` – Hides tick marks and removes them from the DOM.
+     *
+     * @default 'both'
      */
     tickPlacement: string;
     /**
-     * If `vertical` is set to `true`, the orientation of the Slider changes from horizontal to vertical
-     * ([see example]({% slug orientation_slider %})).
+     * When `true`. renders a vertical Slider [see example]({% slug orientation_slider %}).
+     *
+     * @default false
      */
     vertical: boolean;
     /**
-     * The minimum value of the Slider ([see example]({% slug predefinedsteps_slider %}#toc-small-steps)).
-     * The attribute accepts both integers and floating-point numbers.
+     * Sets the minimum value of the Slider.
+     * Accepts integers and floating-point numbers [see example]({% slug predefinedsteps_slider %}#toc-small-steps).
+     *
+     * @default 0
      */
     min: number;
     /**
-     * The maximum value of the Slider ([see example]({% slug predefinedsteps_slider %}#toc-small-steps)).
-     * The attribute accepts both integers and floating-point numbers.
+     * Sets the maximum value of the Slider.
+     * Accepts integers and floating-point numbers [see example]({% slug predefinedsteps_slider %}#toc-small-steps).
+     *
+     * @default 10
      */
     max: number;
     /**
-     * The step value of the Slider ([see example]({% slug predefinedsteps_slider %}#toc-small-steps)).
-     * Accepts positive values only. Can be an integer or a floating-point number.
+     * Sets the step value of the Slider.
+     * Accepts only positive values.
+     * Can be an integer or a floating-point number [see example]({% slug predefinedsteps_slider %}#toc-small-steps).
+     *
+     * @default 1
      */
     smallStep: number;
     /**
-     * Specifies that every n<sup>th</sup> tick will be large and will have a label
-     * ([see example]({% slug predefinedsteps_slider %}#toc-large-steps)).
-     * Accepts positive integer values only.
+     * Sets every n<sup>th</sup> tick as large and shows a label for it [see example]({% slug predefinedsteps_slider %}#toc-large-steps).
+     *
+     * @default null
      */
     largeStep: number;
     /**
-     * Sets the width between each two ticks along the track ([see example]({% slug ticks_slider %}#toc-width)). The value
-     * has to be set in pixels. If no `fixedTickWidth` is provided, the Slider automatically adjusts the tick width to
-     * accommodate the elements within the size of the component.
+     * Sets the width between two ticks along the track, in pixels.
+     * If you do not set `fixedTickWidth`, the Slider adjusts the tick width automatically [see example]({% slug ticks_slider %}#toc-width).
+     *
      */
     fixedTickWidth: number;
     /**
-     * Determines whether the Slider is disabled ([see example]({% slug disabledstate_slider %})). To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_slider#toc-managing-the-slider-disabled-state-in-reactive-forms).
+     * When `true`, disables the Slider.
+     * To disable the component in reactive forms, see [Forms Support](slug:formssupport_slider#toc-managing-the-slider-disabled-state-in-reactive-forms) [see example]({% slug disabledstate_slider %}).
+     *
+     * @default false
      */
     disabled: boolean;
     /**
-     * Determines whether the Slider is in its read-only state ([see example]({% slug readonly_slider %})).
+     * When `true`, sets the Slider to read-only [see example]({% slug readonly_slider %}).
      *
      * @default false
      */
     readonly: boolean;
     /**
-     * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the Slider.
+     * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the Slider.
+     *
+     * @default 0
      */
     tabindex: number;
     /**
-     * Fires each time the user focuses the component.
+     * Fires when the user focuses the component.
+     *
      */
     onFocus: EventEmitter<any>;
     /**
-     * Fires each time the component is blurred.
+     * Fires when the component is blurred.
+     *
      */
     onBlur: EventEmitter<any>;
     /**
-     * Fires each time the user selects a new value.
+     * Fires when the user selects a new value.
+     *
      */
     valueChange: EventEmitter<any>;
     direction: string;

package/sliders-common/title-callback.d.ts

@@ -3,8 +3,24 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Defines the title of the ticks ([see example]({% slug ticks_slider %}#toc-titles)). The default title
- * for each tick is its Slider value. If you use a callback function, the function accepts an argument
- * that holds the value of the component and returns a string with the new title.
+ * Sets the title for the ticks ([see example]({% slug ticks_slider %}#toc-titles)).
+ * By default, each tick uses its Slider value as the title.
+ * If you use a callback function, it receives the component value and returns a string for the title.
+ *
+ * @example
+ * ```typescript
+ * @Component({
+ *   selector: "my-app",
+ *   template: `
+ *     <kendo-slider [title]="title"></kendo-slider>
+ *   `,
+ * })
+ * export class AppComponent {
+ *   // Use a callback function to capture the 'this' execution context of the class.
+ *   public title = (value: number): string => {
+ *     return `${this.numbers[value]}`;
+ *   };
+ * }
+ * ```
  */
 export type SliderTickTitleCallback = (value: number) => string;

package/switch/events/blur-event.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the `blur` event of the Switch component.
+ * Provides arguments for the `blur` event of the Switch component.
  */
 export declare class SwitchBlurEvent {
     /**

package/switch/events/focus-event.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the `focus` event of the Switch component.
+ * Provides arguments for the `focus` event of the Switch component.
  */
 export declare class SwitchFocusEvent {
     /**

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

@@ -6,7 +6,7 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { Messages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages.
+ * Overrides the default component messages with custom component messages.
  */
 export declare class SwitchCustomMessagesComponent extends Messages {
     protected service: LocalizationService;