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

package/checkbox/checkbox.component.d.ts

@@ -8,6 +8,15 @@ import { CheckBoxRounded } from '../common/models';
 import { CheckBoxState } from './checked-state';
 import { RadioCheckBoxBase } from '../common/radio-checkbox.base';
 import * as i0 from "@angular/core";
+/**
+ * Represents the Kendo UI CheckBox component for Angular.
+ * Use this component to create a styled checkbox with support for indeterminate state.
+ *
+ * @example
+ * ```html
+ * <kendo-checkbox [(checkedState)]="value"></kendo-checkbox>
+ * ```
+ */
 export declare class CheckBoxComponent extends RadioCheckBoxBase implements ControlValueAccessor, OnInit, AfterViewInit {
     protected renderer: Renderer2;
     hostElement: ElementRef;
@@ -18,31 +27,24 @@ export declare class CheckBoxComponent extends RadioCheckBoxBase implements Cont
     /**
      * Sets the checked state of the component.
      *
+     * Use `true`, `false`, or `'indeterminate'` to control the state.
+     *
      * @default false
      */
     set checkedState(value: CheckBoxState);
     get checkedState(): CheckBoxState;
     /**
-     * The rounded property specifies the border radius of the CheckBox
+     * Sets the `rounded` property to specify the border radius of the CheckBox
      * ([see example](slug:appearance_checkboxdirective#toc-roundness)).
      *
      * @default 'medium'
-     *
-     * The possible values are:
-     * * `small`
-     * * `medium`
-     * * `large`
-     * * `none`
      */
     set rounded(rounded: CheckBoxRounded);
     get rounded(): CheckBoxRounded;
     /**
-     * Fires each time the inner input's checked state is changed.
-     * When the state of the component is programmatically changed to `ngModel` or `formControl`
-     * through its API or form binding, the `checkedStateChange` event is not triggered because it
-     * might cause a mix-up with the built-in mechanisms of the `ngModel` or `formControl` bindings.
-     *
-     * Used to provide a two-way binding for the `checkedState` property.
+     * Fires when the inner input's checked state changes.
+     * This event does not fire when you change the state programmatically using `ngModel` or `formControl`.
+     * Use this event for two-way binding with the `checkedState` property.
      */
     checkedStateChange: EventEmitter<CheckBoxState>;
     /**

package/checkbox/checkbox.directive.d.ts

@@ -6,11 +6,11 @@ import { ElementRef, Renderer2 } from '@angular/core';
 import { CheckBoxRounded, InputSize } from '../common/models';
 import * as i0 from "@angular/core";
 /**
- * Represents the directive that renders the [Kendo UI CheckBox]({% slug overview_checkbox %}) input component.
- * The directive is placed on input type="checkbox" elements.
+ * Renders the [Kendo UI CheckBox]({% slug overview_checkbox %}) input component.
+ * Apply this directive to `input type="checkbox"` HTML elements.
  *
  * @example
- * ```ts-no-run
+ * ```html
  * <input type="checkbox" kendoCheckBox />
  * ```
  */
@@ -19,26 +19,19 @@ export declare class CheckBoxDirective {
     private hostElement;
     kendoClass: boolean;
     /**
-     * The size property specifies the width and height of the CheckBox
+     * Sets the `size` property to specify the width and height of the CheckBox
      * ([see example]({% slug appearance_checkboxdirective %}#toc-size)).
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * @default 'medium'
      */
     set size(size: InputSize);
     get size(): InputSize;
     /**
-     * The rounded property specifies the border radius of the CheckBox
+     * Sets the `rounded` property to specify the border radius of the CheckBox
      * ([see example](slug:appearance_checkboxdirective#toc-roundness)).
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * @default 'medium'
+     *
      */
     set rounded(rounded: CheckBoxRounded);
     get rounded(): CheckBoxRounded;

package/checkbox/checked-state.d.ts

@@ -3,10 +3,14 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Represents the options for the `checkedState` input of the CheckBox component.
+ * Defines the options for the `checkedState` input of the CheckBox component.
+ *
+ * Use this type to set the checked state to `true`, `false`, or `'indeterminate'`.
  *
  * @example
  * ```html
+ * <kendo-checkbox [checkedState]="true"></kendo-checkbox>
+ * <kendo-checkbox [checkedState]="false"></kendo-checkbox>
  * <kendo-checkbox checkedState="indeterminate"></kendo-checkbox>
  * ```
  */

package/checkbox.module.d.ts

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

package/colorpicker/color-gradient.component.d.ts

@@ -13,8 +13,17 @@ import { SVGIcon } from '@progress/kendo-angular-icons';
 import { InputSize } from '../common/models';
 import * as i0 from "@angular/core";
 /**
- * The ColorGradient component enables smooth color transitions and provides options for selecting specific colors over the drag handle.
- * The ColorGradient is independently used by `kendo-colorpicker` and can be directly added to the page.
+ * Represents the Kendo UI ColorGradient component.
+ *
+ * The ColorGradientComponent lets you select a color by moving a drag handle over a gradient area. You can use it directly or as part of the `kendo-colorpicker`.
+ *
+ * @example
+ * ```html
+ * <kendo-colorgradient [(ngModel)]="color"></kendo-colorgradient>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link ColorPickerMessages}.
  */
 export declare class ColorGradientComponent implements OnInit, OnChanges, OnDestroy, ControlValueAccessor {
     private host;
@@ -53,24 +62,20 @@ export declare class ColorGradientComponent implements OnInit, OnChanges, OnDest
      */
     id: string;
     /**
-     * Defines whether the alpha slider will be displayed.
+     * Shows or hides the alpha slider.
      *
      * @default true
      */
     opacity: boolean;
     /**
-     * The size property specifies the padding of the ColorGradient internal elements.
+     * Sets the size of the ColorGradient internal elements.
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * @default 'medium'
      */
     set size(size: InputSize);
     get size(): InputSize;
     /**
-     * Sets the disabled state of the ColorGradient. To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_colorgradient#toc-managing-the-colorgradient-disabled-state-in-reactive-forms).
+     * Disables the ColorGradient. To disable it in reactive forms, see [Forms Support](slug:formssupport_colorgradient#toc-managing-the-colorgradient-disabled-state-in-reactive-forms).
      *
      * @default false
      */
@@ -82,47 +87,42 @@ export declare class ColorGradientComponent implements OnInit, OnChanges, OnDest
      */
     readonly: boolean;
     /**
-     * Specifies whether the ColorGradient should display a 'Clear color' button.
+     * Shows or hides the **Clear color** button.
      *
      * @default false
      */
     clearButton: boolean;
     /**
-     * Determines the delay time (in milliseconds) before the value is changed on handle drag. A value of 0 indicates no delay.
+     * Sets the delay (in milliseconds) before the value changes on handle drag.
      *
      * @default 0
      */
     delay: number;
     /**
-     * Specifies the value of the initially selected color.
+     * Sets the value of the selected color.
      */
     set value(value: string);
     get value(): string;
     /**
-     * Enables the color contrast tool. Accepts the background color that will be compared to the selected value.
-     * The tool will calculate the contrast ratio between the two colors.
+     * Enables the color contrast tool that checks the contrast ratio of the selected color against a predefined background color. [See example](slug:contrasttool_colorgradient).
      */
     set contrastTool(value: string);
     get contrastTool(): string;
     /**
-     * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
+     * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
      *
      * @default 0
      */
     set tabindex(value: number);
     get tabindex(): number;
     /**
-     * Specifies the output format of the ColorGradientComponent.
-     * The input value may be in a different format, but it will be parsed into the output `format`
-     * after the component processes it.
+     * Sets the output format of the ColorGradient. The input value may be in a different format, but it will be parsed into the output format after the component processes it.
      *
-     * The supported values are:
-     * * (Default) `rgba`
-     * * `hex`
+     * @default 'rgba'
      */
     format: OutputFormat;
     /**
-     * Fires each time the user selects a new color.
+     * Fires when the user selects a new color..
      */
     valueChange: EventEmitter<string>;
     /**
@@ -138,7 +138,7 @@ export declare class ColorGradientComponent implements OnInit, OnChanges, OnDest
      */
     hsva: BehaviorSubject<HSVA>;
     /**
-     * Indicates whether the ColorGradient or any of its content is focused.
+     * Returns `true` if the component or its content is focused.
      */
     get isFocused(): boolean;
     /**
@@ -146,13 +146,13 @@ export declare class ColorGradientComponent implements OnInit, OnChanges, OnDest
      */
     get alphaSliderValue(): number;
     /**
-     * Determines the step (in pixels) when moving the gradient drag handle using the keyboard arrow keys.
+     * Sets the step (in pixels) for moving the gradient drag handle with the arrow keys.
      *
      * @default 5
      */
     gradientSliderStep: number;
     /**
-     * Determines the step (in pixels) when moving the gradient drag handle using the keyboard arrow keys while holding the shift key.
+     * Sets the step (in pixels) for moving the gradient drag handle with `Shift+arrow keys`.
      *
      * @default 2
      */

package/colorpicker/color-input.component.d.ts

@@ -18,38 +18,38 @@ export declare class ColorInputComponent implements AfterViewInit, OnChanges {
     private cdr;
     localizationService: LocalizationService;
     /**
-     * The id of the hex input.
+     * Sets the `id` of the hex input.
      */
     focusableId: string;
     /**
-     * The color format view.
+     * Sets the color format view.
      */
     formatView: string;
     /**
-     * The size property specifies the padding of the ColorInput.
+     * Sets the size of the ColorInput.
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * @default 'medium'
      */
     size: InputSize;
     /**
-     * The inputs tabindex.
+     * Sets the `tabindex` of the inputs.
+     * @default -1
      */
     tabindex: number;
     /**
-     * The color value that will be parsed and populate the hex & rgba inputs.
-     * Required input property.
+     * Sets the color value to parse and populate the hex and RGBA inputs.
      */
     value: string;
     /**
-     * Sets whether the alpha slider will be shown.
+     * Shows or hides the alpha slider.
+     *
+     * @default true
      */
     opacity: boolean;
     /**
-     * Sets the disabled state of the ColorInput.
+     * Disables the ColorInput.
+     *
+     * @default false
      */
     disabled: boolean;
     /**
@@ -59,11 +59,11 @@ export declare class ColorInputComponent implements AfterViewInit, OnChanges {
      */
     readonly: boolean;
     /**
-     * Emits a parsed rgba string color.
+     * Emits a parsed RGBA string color.
      */
     valueChange: EventEmitter<string>;
     /**
-     * Emits when the user tabs out of the last focusable input.
+     * Fires when the user tabs out of the last focusable input.
      */
     tabOut: EventEmitter<any>;
     colorInputClass: boolean;
@@ -72,16 +72,16 @@ export declare class ColorInputComponent implements AfterViewInit, OnChanges {
     blueInput: NumericTextBoxComponent;
     toggleFormatButton: ElementRef;
     /**
-     * The rgba inputs values.
+     * Holds the RGBA input values.
      */
     rgba: RGBA;
     hex: string;
     /**
-     * Indicates whether any of the inputs are focused.
+     * Returns `true` if any of the inputs are focused.
      */
     private get isFocused();
     /**
-     * Indicates whether any of the rgba inputs have value.
+     * Returns `true` if all RGBA inputs have values.
      */
     private get rgbaInputValid();
     /**

package/colorpicker/color-palette.component.d.ts

@@ -10,8 +10,17 @@ import { ColorPaletteService } from './services/color-palette.service';
 import { InputSize } from '../common/models';
 import * as i0 from "@angular/core";
 /**
- * The ColorPalette component provides a set of predefined palette presets and enables you to implement a custom color palette.
- * The ColorPalette is independently used by `kendo-colorpicker` and can be directly added to the page.
+ * Represents the Kendo UI ColorPalette component.
+ *
+ * The `ColorPaletteComponent` provides a set of predefined palette presets and lets you implement a custom color palette. You can use it directly or as part of the `kendo-colorpicker`.
+ *
+ * @example
+ * ```html
+ * <kendo-colorpalette [palette]="['#fff', '#000']" [(value)]="selectedColor"></kendo-colorpalette>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link ColorPickerMessages}.
  */
 export declare class ColorPaletteComponent implements OnInit, AfterViewInit, OnDestroy, OnChanges, ControlValueAccessor {
     host: ElementRef;
@@ -41,55 +50,45 @@ export declare class ColorPaletteComponent implements OnInit, AfterViewInit, OnD
      */
     id: string;
     /**
-     * Specifies the output format of the ColorPaletteComponent.
-     * The input value may be in a different format. However, it will be parsed into the output `format`
-     * after the component processes it.
+     * Specifies the output format of the `ColorPaletteComponent`.
+     * The input value may be in a different format. The component parses it into the output `format`.
      *
-     * The supported values are:
-     * * (Default) `hex`
-     * * `rgba`
-     * * `name`
+     * @default 'hex'
      */
     format: OutputFormat;
     /**
-     * Specifies the value of the initially selected color.
+     * Sets the value of the selected color.
      */
     set value(value: string);
     get value(): string;
     /**
-     * Specifies the number of columns that will be displayed.
-     * Defaults to `10`.
+     * Sets the number of columns to display.
+     *
+     * @default 10
      */
     set columns(value: number);
     get columns(): number;
     /**
-     * The color palette that will be displayed.
-     *
-     * The supported values are:
-     * * The name of the predefined palette preset (for example, `office`, `basic`, and `apex`).
-     * * A string with comma-separated colors.
-     * * A string array.
+     * Sets the color palette to display. You can use a predefined palette preset (such as `office`, `basic`, or `apex`), string with comma-separated colors, or an array of string colors.
      */
     set palette(value: string | Array<string>);
     get palette(): string | Array<string>;
     /**
-     * The size property specifies the padding of the ColorPalette internal elements.
+     * Sets the size of the ColorPalette internal elements.
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * @default 'medium'
      */
     set size(size: InputSize);
     get size(): InputSize;
     /**
-     * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
+     * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
+     *
+     * @default 0
      */
     set tabindex(value: number);
     get tabindex(): number;
     /**
-     * Sets the disabled state of the ColorPalette. To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_colorpalette#toc-managing-the-colorpalette-disabled-state-in-reactive-forms).
+     * Disables the ColorPalette. To disable it in reactive forms, see [Forms Support](slug:formssupport_colorpalette#toc-managing-the-colorpalette-disabled-state-in-reactive-forms).
      */
     disabled: boolean;
     /**
@@ -99,7 +98,7 @@ export declare class ColorPaletteComponent implements OnInit, AfterViewInit, OnD
      */
     readonly: boolean;
     /**
-     * Specifies the size of a color cell. The default tile size depends on the `size` of the component.
+     * Sets the size of a color cell. The default tile size depends on the `size` of the component.
      */
     tileSize: number | TileSize;
     /**
@@ -107,11 +106,11 @@ export declare class ColorPaletteComponent implements OnInit, AfterViewInit, OnD
      */
     get tileLayout(): TileSize;
     /**
-     * Fires each time the color selection is changed.
+     * Fires when the color selection changes.
      */
     selectionChange: EventEmitter<string>;
     /**
-     * Fires each time the value is changed.
+     * Fires when the value changes.
      */
     valueChange: EventEmitter<string>;
     /**