@progress/kendo-angular-progressbar 19.1.2-develop.4 → 19.1.2-develop.5

package/progressbar.module.d.ts

@@ -13,30 +13,17 @@ import * as i5 from "./progressbar.component";
  * definition for the ProgressBar components.
  *
  * @example
- *
- * ```ts-no-run
- * // Import the ProgressBar module
- * import { ProgressBarModule } from '@progress/kendo-angular-progressbar';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```typescript
  * import { NgModule } from '@angular/core';
+ * import { BrowserModule } from '@angular/platform-browser';
+ * import { ProgressBarModule } from '@progress/kendo-angular-progressbar';
  *
- * // Import the app component
- * import { AppComponent } from './app.component';
- *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, ProgressBarModule], // import ProgressBar module
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *   imports: [BrowserModule, ProgressBarModule],
+ *   declarations: [AppComponent],
+ *   bootstrap: [AppComponent]
  * })
- * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
+ * export class AppModule { }
  * ```
  */
 export declare class ProgressBarModule {

package/types/animation-end-event.d.ts

@@ -11,7 +11,7 @@ export interface AnimationEndEvent {
      */
     from: number;
     /**
-     * The value to which the animations runs.
+     * The value to which the animation runs.
      */
     to: number;
 }

package/types/label-fn-type.d.ts

@@ -3,8 +3,8 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The callback that returns the string content of the status label. The current value is available as an argument.
- * @param { number } value - The currently set value.
- * @returns { string } - The formatted string that will be displayed within the label.
+ * The callback that returns the string content of the status label. You can access the current value as an argument.
+ * @param value - The currently set value.
+ * @returns The formatted string that displays within the label.
  */
 export type LabelFn = (value: number) => string;

package/types/label-position.d.ts

@@ -3,6 +3,6 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The position in which the status label will be displayed when visible.
+ * The position where the status label displays when visible.
  */
 export type LabelPosition = 'start' | 'end' | 'center';

package/types/label-settings.interface.d.ts

@@ -6,49 +6,27 @@ import { LabelType } from './label-type';
 import { LabelFn } from './label-fn-type';
 import { LabelPosition } from './label-position';
 /**
- * Represents the settings of the label which indicates the progress status of the ProgressBar.
+ * Represents the settings of the label that shows the progress status of the ProgressBar.
  *
- * @example
- * ```ts-preview
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *        <kendo-progressbar
- *              [value]="value"
- *              [label]="label">
- *        </kendo-progressbar>
- *    `
- * })
- * class AppComponent {
- *     public value = 50;
- *     public label = {
- *          visible: true,
- *          position: 'start',
- *          format: 'percent'
- *      };
- * }
- * ```
  */
 export interface LabelSettings {
     /**
-     * Determines whether the label for the progress status will be visible.
+     * Shows or hides the label for the progress status.
      */
     visible?: boolean;
     /**
      * Sets the position of the progress status label.
-     *
-     * The accepted values are:
-     * * `start`
-     * * `center`
-     * * (Default) `end`
+     * @default 'end'
      */
     position?: LabelPosition;
     /**
-     * Sets the format that will be used when rendering the value in the label.
+     * Sets the format for rendering the value in the label.
      * The supported preset types are `value` (default) and `percent`.
-     * You can also provide a callback that will expose the current value and which has to
-     * return the formatted string that will be displayed in the label
+     * You can also provide a callback that exposes the current value and returns
+     * the formatted string to display in the label
      * ([see example]({% slug progressbar_label %}#toc-using-a-formatting-function)).
+     *
+     * @default 'value'
      */
     format?: LabelType | LabelFn;
 }

package/types/label-type.d.ts

@@ -6,8 +6,7 @@
  * The predefined label types.
  *
  * The supported values are:
- * * `value`—Represents the current display value trimmed to the third decimal.
- * * `percentage`—Represents the calculated percentage value based on the current display value
- * and the range defined by the `min` and `max` options.
+ * * `value`—Shows the current display value trimmed to the third decimal.
+ * * `percent`—Shows the calculated percentage value based on the current display value and the range defined by the `min` and `max` options.
  */
 export type LabelType = 'value' | 'percent';

package/types/progressbar-animation.interface.d.ts

@@ -3,29 +3,14 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Represents the settings of the animation which indicates the progress status of the ProgressBar.
+ * Represents the settings of the animation that indicates the progress status of the ProgressBar.
  *
- * @example
- * ```ts-preview
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *        <kendo-progressbar
- *              [value]="value"
- *              [animation]="{duration: duration}">
- *        </kendo-progressbar>
- *    `
- * })
- * class AppComponent {
- *     public value = 50;
- *     public duration = 1000;
- * }
- * ```
  */
 export interface ProgressBarAnimation {
     /**
-     * The duration of the animation in milliseconds.
-     * Defaults to `400`.
+     * Sets the duration of the animation in milliseconds.
+     *
+     * @default 400
      */
     duration: number;
 }

package/types/progressbar-orientation.d.ts

@@ -3,6 +3,6 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Specifies the orientation of the component.
+ * Represents the orientation options of the ProgressBar component.
  */
 export type ProgressBarOrientation = 'horizontal' | 'vertical';