@progress/kendo-angular-inputs 15.2.0-develop.2 → 15.2.0-develop.3

package/index.d.ts

@@ -81,3 +81,8 @@ export { SignatureComponent } from './signature/signature.component';
 export { SignatureModule } from './signature.module';
 export { SignatureOpenEvent, SignatureCloseEvent } from './signature/events';
 export { SignatureCustomMessagesComponent, LocalizedSignatureMessagesDirective, SignatureMessages } from './signature/localization';
+export { RatingItemTemplateDirective } from './rating/directives/rating-item.directive';
+export { RatingHoveredItemTemplateDirective } from './rating/directives/rating-hovered-item.directive';
+export { RatingSelectedItemTemplateDirective } from './rating/directives/rating-selected-item.directive';
+export { RatingComponent } from './rating/rating.component';
+export { RatingModule } from './rating.module';

package/inputs.module.d.ts

@@ -16,6 +16,7 @@ import * as i10 from "./checkbox.module";
 import * as i11 from "./radiobutton.module";
 import * as i12 from "./formfield.module";
 import * as i13 from "./signature.module";
+import * as i14 from "./rating.module";
 /**
  * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
  * definition for the Inputs components.
@@ -50,6 +51,6 @@ import * as i13 from "./signature.module";
  */
 export declare class InputsModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<InputsModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<InputsModule, never, [typeof i1.CommonModule], [typeof i2.TextAreaModule, typeof i3.TextBoxModule, typeof i4.SliderModule, typeof i5.RangeSliderModule, typeof i6.SwitchModule, typeof i7.NumericTextBoxModule, typeof i8.MaskedTextBoxModule, typeof i9.ColorPickerModule, typeof i10.CheckBoxModule, typeof i11.RadioButtonModule, typeof i12.FormFieldModule, typeof i13.SignatureModule]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<InputsModule, never, [typeof i1.CommonModule], [typeof i2.TextAreaModule, typeof i3.TextBoxModule, typeof i4.SliderModule, typeof i5.RangeSliderModule, typeof i6.SwitchModule, typeof i7.NumericTextBoxModule, typeof i8.MaskedTextBoxModule, typeof i9.ColorPickerModule, typeof i10.CheckBoxModule, typeof i11.RadioButtonModule, typeof i12.FormFieldModule, typeof i13.SignatureModule, typeof i14.RatingModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<InputsModule>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progress/kendo-angular-inputs",
-  "version": "15.2.0-develop.2",
+  "version": "15.2.0-develop.3",
   "description": "Kendo UI for Angular Inputs Package - Everything you need to build professional form functionality (Checkbox, ColorGradient, ColorPalette, ColorPicker, FlatColorPicker, FormField, MaskedTextBox, NumericTextBox, RadioButton, RangeSlider, Slider, Switch, TextArea, and TextBox Components)",
   "license": "SEE LICENSE IN LICENSE.md",
   "author": "Progress",
@@ -34,19 +34,19 @@
     "@angular/platform-browser": "13 - 17",
     "@progress/kendo-drawing": "^1.19.0",
     "@progress/kendo-licensing": "^1.0.2",
-    "@progress/kendo-angular-buttons": "15.2.0-develop.2",
-    "@progress/kendo-angular-common": "15.2.0-develop.2",
-    "@progress/kendo-angular-dialog": "15.2.0-develop.2",
-    "@progress/kendo-angular-intl": "15.2.0-develop.2",
-    "@progress/kendo-angular-l10n": "15.2.0-develop.2",
-    "@progress/kendo-angular-popup": "15.2.0-develop.2",
-    "@progress/kendo-angular-icons": "15.2.0-develop.2",
+    "@progress/kendo-angular-buttons": "15.2.0-develop.3",
+    "@progress/kendo-angular-common": "15.2.0-develop.3",
+    "@progress/kendo-angular-dialog": "15.2.0-develop.3",
+    "@progress/kendo-angular-intl": "15.2.0-develop.3",
+    "@progress/kendo-angular-l10n": "15.2.0-develop.3",
+    "@progress/kendo-angular-popup": "15.2.0-develop.3",
+    "@progress/kendo-angular-icons": "15.2.0-develop.3",
     "rxjs": "^6.5.3 || ^7.0.0",
-    "@progress/kendo-angular-upload": "15.2.0-develop.2"
+    "@progress/kendo-angular-upload": "15.2.0-develop.3"
   },
   "dependencies": {
     "tslib": "^2.3.1",
-    "@progress/kendo-angular-schematics": "15.2.0-develop.2",
+    "@progress/kendo-angular-schematics": "15.2.0-develop.3",
     "@progress/kendo-common": "^0.2.2",
     "@progress/kendo-draggable": "^3.0.0",
     "@progress/kendo-inputs-common": "^3.1.0"

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

@@ -0,0 +1,17 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+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 %}#toc-hovered-item-template).
+ */
+export declare class RatingHoveredItemTemplateDirective {
+    templateRef: TemplateRef<any>;
+    constructor(templateRef: TemplateRef<any>);
+    static ɵfac: i0.ɵɵFactoryDeclaration<RatingHoveredItemTemplateDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RatingHoveredItemTemplateDirective, "[kendoRatingHoveredItemTemplate]", never, {}, {}, never>;
+}

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

@@ -0,0 +1,17 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+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 %}#toc-item-template).
+ */
+export declare class RatingItemTemplateDirective {
+    templateRef: TemplateRef<any>;
+    constructor(templateRef: TemplateRef<any>);
+    static ɵfac: i0.ɵɵFactoryDeclaration<RatingItemTemplateDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RatingItemTemplateDirective, "[kendoRatingItemTemplate]", never, {}, {}, never>;
+}

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

@@ -0,0 +1,17 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+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 %}#toc-selected-item-template).
+ */
+export declare class RatingSelectedItemTemplateDirective {
+    templateRef: TemplateRef<any>;
+    constructor(templateRef: TemplateRef<any>);
+    static ɵfac: i0.ɵɵFactoryDeclaration<RatingSelectedItemTemplateDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RatingSelectedItemTemplateDirective, "[kendoRatingSelectedItemTemplate]", never, {}, {}, never>;
+}

package/rating/models/precision.d.ts

@@ -0,0 +1,13 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Specifies the precision with which an item is selected.
+ *
+ * The available values are:
+ * * `item` (default)
+ * * `half`
+ *
+ */
+export declare type RatingPrecision = 'item' | 'half';

package/rating/models/rating-item.interface.d.ts

@@ -0,0 +1,32 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * An interface for the rating items in the Rating component
+ *
+ * @hidden
+ *
+ */
+export interface RatingItem {
+    /**
+     * Specifies the rating item title.
+     */
+    title?: string;
+    /**
+     * Specifies whether the rating item is selected.
+     */
+    selected?: boolean;
+    /**
+     * Specifies whether the rating item should be indicated as selected (if the `k-selected` class should be rendered).
+     */
+    selectedIndicator?: boolean;
+    /**
+     * Specifies whether the rating item is hovered.
+     */
+    hovered?: boolean;
+    /**
+     * Specifies whether the value represents half icon or whole icon.
+     */
+    half?: boolean;
+}

package/rating/models/selection.d.ts

@@ -0,0 +1,13 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* 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 %})).
+ *
+ * The available values are:
+ * * `continuous` (default)
+ * * `single`
+ *
+ */
+export declare type RatingSelectionMode = 'continuous' | 'single';

package/rating/rating.component.d.ts

@@ -0,0 +1,180 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, OnInit, Renderer2 } from '@angular/core';
+import { ControlValueAccessor } from '@angular/forms';
+import { LocalizationService } from '@progress/kendo-angular-l10n';
+import { SVGIcon } from '@progress/kendo-svg-icons';
+import { RatingSelectionMode } from './models/selection';
+import { RatingItem } from './models/rating-item.interface';
+import { RatingItemTemplateDirective } from './directives/rating-item.directive';
+import { RatingHoveredItemTemplateDirective } from './directives/rating-hovered-item.directive';
+import { RatingSelectedItemTemplateDirective } from './directives/rating-selected-item.directive';
+import { RatingPrecision } from './models/precision';
+import * as i0 from "@angular/core";
+/**
+ * Represents the [Kendo UI Rating component for Angular]({% slug overview_rating %}).
+ */
+export declare class RatingComponent implements OnInit, AfterViewInit, OnDestroy, ControlValueAccessor {
+    element: ElementRef;
+    private renderer;
+    private localizationService;
+    private cdr;
+    private zone;
+    itemTemplate: RatingItemTemplateDirective;
+    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).
+     *
+     * @default false
+     *
+     */
+    disabled: boolean;
+    /**
+     * Determines whether the Rating is in its read-only state ([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.
+     *
+     * @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.
+     *
+     */
+    set value(value: number);
+    get value(): number;
+    /**
+     * 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 %})).
+     *
+     * @default 'item'
+     *
+     */
+    set precision(precision: RatingPrecision);
+    get precision(): RatingPrecision;
+    /**
+     * Sets the Rating label. It is not the native HMTL `label` element, it is just a `span` element with the provided text ([see example]({% slug label_rating %})).
+     */
+    label: string;
+    /**
+     * Sets custom Rating font icon [see example]({% slug icon_rating %}).
+     */
+    icon: string;
+    /**
+     * Sets custom Rating SVG icon. It is the icon that is used for not selected/hovered state. [see example]({% slug icon_rating %}).
+     */
+    svgIcon: SVGIcon;
+    /**
+     * Sets custom Rating SVG icon. It is the icon that is used for selected/hovered state. [see example]({% slug icon_rating %}).
+     */
+    svgIconOutline: SVGIcon;
+    /**
+     * Fires each time the user selects a new value.
+     */
+    valueChange: EventEmitter<number>;
+    hostClass: boolean;
+    direction: string;
+    get isControlInvalid(): string;
+    valueMin: number;
+    get valueMax(): number;
+    get valueNow(): number;
+    ariaRole: string;
+    /**
+     * @hidden
+     */
+    ratingItems: RatingItem[];
+    private control;
+    private ngChange;
+    private ngTouched;
+    private rect;
+    private _value;
+    private _selection;
+    private _precision;
+    private subscriptions;
+    constructor(element: ElementRef, renderer: Renderer2, localizationService: LocalizationService, cdr: ChangeDetectorRef, zone: NgZone);
+    ngOnInit(): void;
+    ngAfterViewInit(): void;
+    ngOnDestroy(): void;
+    /**
+     * Focuses the Rating component.
+     */
+    focus(): void;
+    /**
+     * Blurs the Rating component.
+     */
+    blur(): void;
+    /**
+     * @hidden
+     */
+    private createRatingItems;
+    /**
+     * @hidden
+     */
+    onMouseEnter(event: any): void;
+    /**
+     * @hidden
+     */
+    onMouseMove(value: number, event: any): void;
+    /**
+     * @hidden
+     */
+    onMouseOut(): void;
+    /**
+     * @hidden
+     * Called when the status of the component changes to or from `disabled`.
+     * Depending on the value, it enables or disables the appropriate DOM element.
+     *
+     * @param isDisabled
+     */
+    setDisabledState(isDisabled: boolean): void;
+    /**
+     * @hidden
+     */
+    changeValue(index: number, event: any): void;
+    /**
+     * @hidden
+     */
+    updateRatingItems(): void;
+    /**
+     * @hidden
+     */
+    writeValue(value: number): void;
+    /**
+     * @hidden
+     */
+    registerOnChange(fn: () => any): void;
+    /**
+     * @hidden
+     */
+    registerOnTouched(fn: () => any): void;
+    private isSelected;
+    private isHalf;
+    private isFirstHalf;
+    private onKeyDown;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RatingComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<RatingComponent, "kendo-rating", ["kendoRating"], { "disabled": "disabled"; "readonly": "readonly"; "tabindex": "tabindex"; "itemsCount": "itemsCount"; "value": "value"; "selection": "selection"; "precision": "precision"; "label": "label"; "icon": "icon"; "svgIcon": "svgIcon"; "svgIconOutline": "svgIconOutline"; }, { "valueChange": "valueChange"; }, ["itemTemplate", "hoveredItemTemplate", "selectedItemTemplate"], never>;
+}

package/rating.module.d.ts

@@ -0,0 +1,47 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as i0 from "@angular/core";
+import * as i1 from "./rating/rating.component";
+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";
+import * as i5 from "@angular/common";
+import * as i6 from "@progress/kendo-angular-icons";
+/**
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
+ * definition for the Rating component.
+ *
+ * @example
+ *
+ * ```ts-no-run
+ * // Import the Rating module
+ * 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
+ *     bootstrap:    [AppComponent]
+ * })
+ * export class AppModule {}
+ *
+ * // Compile and launch the module
+ * platformBrowserDynamic().bootstrapModule(AppModule);
+ *
+ * ```
+ */
+export declare class RatingModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<RatingModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<RatingModule, [typeof i1.RatingComponent, typeof i2.RatingItemTemplateDirective, typeof i3.RatingHoveredItemTemplateDirective, typeof i4.RatingSelectedItemTemplateDirective], [typeof i5.CommonModule, typeof i6.IconsModule], [typeof i1.RatingComponent, typeof i2.RatingItemTemplateDirective, typeof i3.RatingHoveredItemTemplateDirective, typeof i4.RatingSelectedItemTemplateDirective]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<RatingModule>;
+}