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

package/esm2022/sliders-common/label-template.directive.mjs

@@ -5,27 +5,17 @@
 import { Directive, TemplateRef, Optional } 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 class LabelTemplateDirective {

package/esm2022/sliders-common/slider-base.mjs

@@ -24,77 +24,95 @@ export class SliderBase {
     changeDetector;
     hostElement;
     /**
-     * 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 = identity;
     /**
-     * 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 = 'both';
     /**
-     * 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 = false;
     /**
-     * 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 = 0;
     /**
-     * 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 = 10;
     /**
-     * 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 = 1;
     /**
-     * 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 = null;
     /**
-     * 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;
     /**
-     * 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 = false;
     /**
-     * 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 = false;
     /**
-     * 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 = 0;
     /**
-     * Fires each time the user focuses the component.
+     * Fires when the user focuses the component.
+     *
      */
     onFocus = new EventEmitter();
     /**
-     * Fires each time the component is blurred.
+     * Fires when the component is blurred.
+     *
      */
     onBlur = new EventEmitter();
     /**
-     * Fires each time the user selects a new value.
+     * Fires when the user selects a new value.
+     *
      */
     valueChange = new EventEmitter();
     direction;

package/esm2022/switch/events/blur-event.mjs

@@ -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 class SwitchBlurEvent {
     /**

package/esm2022/switch/events/focus-event.mjs

@@ -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 class SwitchFocusEvent {
     /**

package/esm2022/switch/localization/custom-messages.component.mjs

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

package/esm2022/switch/switch.component.mjs

@@ -19,6 +19,14 @@ const DEFAULT_THUMB_ROUNDED = 'full';
 const DEFAULT_TRACK_ROUNDED = 'full';
 /**
  * Represents the [Kendo UI Switch component for Angular]({% slug overview_switch %}).
+ *
+ * @example
+ * ```html
+ * <kendo-switch [(ngModel)]="checked"></kendo-switch>`
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SwitchCustomMessagesComponent}.
  */
 export class SwitchComponent {
     renderer;
@@ -37,17 +45,19 @@ export class SwitchComponent {
         return `k-${guid()}`;
     }
     /**
-     * Sets the **On** label ([see example]({% slug labels_switch %})).
-     * Takes precedence over the [custom messages component]({% slug api_inputs_switchcustommessagescomponent %}).
+     * Set the **On** label.
+     * This label takes precedence over the [custom messages component]({% slug api_inputs_switchcustommessagescomponent %}).
+     * [See example]({% slug labels_switch %}).
      */
     onLabel;
     /**
-     * Sets the **Off** label ([see example]({% slug labels_switch %})).
-     * Takes precedence over the [custom messages component]({% slug api_inputs_switchcustommessagescomponent %}).
+     * Set the **Off** label.
+     * This label takes precedence over the [custom messages component]({% slug api_inputs_switchcustommessagescomponent %}).
+     * [See example]({% slug labels_switch %}).
      */
     offLabel;
     /**
-     * Sets the value of the Switch when it is initially displayed.
+     * Sets the value of the Switch when it first appears.
      */
     set checked(value) {
         this.setHostClasses(value);
@@ -57,27 +67,27 @@ export class SwitchComponent {
         return this._checked;
     }
     /**
-     * Determines whether the Switch is disabled ([see example]({% slug disabled_switch %})). To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_switch#toc-managing-the-switch-disabled-state-in-reactive-forms).
+     * When `true`, disables the Switch.
+     * [See example]({% slug disabled_switch %}).
+     * To disable the component in reactive forms, see [Forms Support](slug:formssupport_switch#toc-managing-the-switch-disabled-state-in-reactive-forms).
+     * @default false
      */
     disabled = false;
     /**
-     * Determines whether the Switch is in its read-only state ([see example]({% slug readonly_switch %})).
-     *
+     * When `true`, sets the Switch to read-only.
+     * [See example]({% slug readonly_switch %}).
      * @default false
      */
     readonly = false;
     /**
-     * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the Switch.
+     * Set the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the Switch.
+     * @default 0
      */
     tabindex = 0;
     /**
-     * Specifies the width and height of the Switch.
+     * Sets the size of the Switch.
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * @default "medium"
      */
     set size(size) {
         const newSize = size ? size : DEFAULT_SIZE;
@@ -88,14 +98,9 @@ export class SwitchComponent {
         return this._size;
     }
     /**
-     * Specifies the border radius of the Switch thumb.
+     * Sets the border radius of the Switch.
      *
-     * The possible values are:
-     * * `full` (default)
-     * * `small`
-     * * `medium`
-     * * `large`
-     * * `none`
+     * @default "full"
      */
     set thumbRounded(thumbRounded) {
         const newThumbRounded = thumbRounded ? thumbRounded : DEFAULT_THUMB_ROUNDED;
@@ -106,14 +111,9 @@ export class SwitchComponent {
         return this._thumbRounded;
     }
     /**
-     * Specifies the border radius of the Switch track.
+     * Sets the border radius of the Switch track.
      *
-     * The possible values are:
-     * * `full` (default)
-     * * `small`
-     * * `medium`
-     * * `large`
-     * * `none`
+     * @default "full"
      */
     set trackRounded(trackRounded) {
         const newTrackRounded = trackRounded ? trackRounded : DEFAULT_TRACK_ROUNDED;
@@ -133,15 +133,15 @@ export class SwitchComponent {
         return this.tabindex;
     }
     /**
-     * Fires each time the Switch component is focused as a result of user interaction.
+     * Fires when the user focuses the Switch.
      */
     onFocus = new EventEmitter();
     /**
-     * Fires each time the Switch component is blurred as a result of user interaction.
+     * Fires when the user blurs the Switch.
      */
     onBlur = new EventEmitter();
     /**
-     * Fires each time the user selects a new value.
+     * Fires when the value of the Switch changes.
      */
     valueChange = new EventEmitter();
     direction;
@@ -247,17 +247,6 @@ export class SwitchComponent {
     /**
      * Focuses the Switch.
      *
-     * @example
-     * ```ts-no-run
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     *  <button (click)="switch.focus()">Focus</button>
-     *  <kendo-switch #switch></kendo-switch>
-     * `
-     * })
-     * class AppComponent { }
-     * ```
      */
     focus() {
         if (!this.hostElement) {

package/esm2022/switch.module.mjs

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

package/esm2022/textarea/textarea-prefix.component.mjs

@@ -5,19 +5,17 @@
 import { Component, HostBinding, Input } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Specifies the adornments in the prefix container ([see example]({% slug textarea_adornments %})).
- * ```ts-no-run
- * _@Component({
- * selector: 'my-app',
- * template: `
- *  <kendo-textarea>
- *    <kendo-textarea-prefix>
- *        <button kendoButton look="clear" icon="image"></button>
- *    </kendo-textarea-prefix>
- *  </kendo-textarea>
- * `
- * })
- * class AppComponent {}
+ * Represents the prefix adornments container for the TextArea component.
+ *
+ * Nest the `<kendo-textarea-prefix>` component inside `<kendo-textarea>` to add elements before the input.
+ *
+ * @example
+ * ```html
+ * <kendo-textarea>
+ *   <kendo-textarea-prefix>
+ *     <button kendoButton look="clear" icon="image"></button>
+ *   </kendo-textarea-prefix>
+ * </kendo-textarea>
  * ```
  */
 export class TextAreaPrefixComponent {

package/esm2022/textarea/textarea-suffix.component.mjs

@@ -5,19 +5,17 @@
 import { Component, HostBinding, Input } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Specifies the adornments in the suffix container ([see example]({% slug textarea_adornments %})).
- * ```ts-no-run
- * _@Component({
- * selector: 'my-app',
- * template: `
- *  <kendo-textarea>
- *    <kendo-textarea-suffix>
- *        <button kendoButton look="clear" icon="image"></button>
- *    </kendo-textarea-suffix>
- *  </kendo-textarea>
- * `
- * })
- * class AppComponent {}
+ * Represents the suffix adornments container for the TextArea component.
+ *
+ * Nest the `<kendo-textarea-suffix>` component inside `<kendo-textarea>` to add elements after the input.
+ *
+ * @example
+ * ```html
+ * <kendo-textarea>
+ *   <kendo-textarea-suffix>
+ *     <button kendoButton look="clear" icon="image"></button>
+ *   </kendo-textarea-suffix>
+ * </kendo-textarea>
  * ```
  */
 export class TextAreaSuffixComponent {