@progress/kendo-angular-upload 19.1.2-develop.1 → 19.1.2-develop.3

package/common/action-buttons-layout.d.ts

@@ -3,6 +3,6 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Specifies the layout of the Upload action buttons.
+ * Specifies the layout options for the Upload action buttons.
  */
 export type ActionsLayout = 'start' | 'center' | 'end' | 'stretched';

package/common/base.d.ts

@@ -43,18 +43,21 @@ export declare abstract class UploadFileSelectBase {
      */
     disabled: boolean;
     /**
-     * Enables the selection of multiple files
-     * If set to `false`, only one file can be selected at a time.
+     * Allows you to select multiple files.
+     * When you set this to `false`, you can select only one file at a time.
+     *
      * @default true
      */
     multiple: boolean;
     /**
-     * Toggles the visibility of the file list.
+     * Controls the visibility of the file list.
+     *
      * @default true
      */
     showFileList: boolean;
     /**
-     * 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
      */
     tabindex: number;
@@ -64,7 +67,8 @@ export declare abstract class UploadFileSelectBase {
     set restrictions(restrictions: FileRestrictions);
     get restrictions(): FileRestrictions;
     /**
-     * Specifies the id of the external drop zone to associate with the component.
+     * Sets the `id` of the external drop zone that you want to associate with the component.
+     *
      */
     zoneId: string;
     /**
@@ -80,19 +84,19 @@ export declare abstract class UploadFileSelectBase {
      */
     get hostDisabledClass(): boolean;
     /**
-     * Fires when the user navigates outside the component.
+     * Fires when you navigate outside the component.
      */
     onBlur: EventEmitter<any>;
     /**
-     * Fires when the component is focused.
+     * Fires when you focus the component.
      */
     onFocus: EventEmitter<any>;
     /**
-     * Fires when files are selected. If prevented, the selected files will not be added to the list.
+     * Fires when you select files. If you prevent this event, the component will not add the selected files to the list.
      */
     select: EventEmitter<SelectEvent>;
     /**
-     * Fires when a file is about to be removed. If prevented, the file will remain in the list.
+     * Fires when you are about to remove a file. If you prevent this event, the file will remain in the list.
      */
     remove: EventEmitter<RemoveEvent>;
     /**
@@ -139,7 +143,7 @@ export declare abstract class UploadFileSelectBase {
      */
     onFileSelectButtonFocus(): void;
     /**
-     * Focuses the component's `Select files` button.
+     * Focuses the component's **Select files** button.
      */
     focus(): void;
     /**
@@ -148,7 +152,7 @@ export declare abstract class UploadFileSelectBase {
      */
     focusComponent(): void;
     /**
-     * Blurs the component if it was previously focused.
+     * Blurs the component if you previously focused it.
      */
     blur(): void;
     /**

package/directives.d.ts

@@ -12,14 +12,14 @@ import { FileInfoTemplateDirective } from "./templates/file-info-template.direct
 import { FileTemplateDirective } from "./templates/file-template.directive";
 import { UploadComponent } from "./upload.component";
 /**
- * Utility array that contains all `FileSelect` related components and directives
+ * Use the KENDO_FILESELECT utility array to add all FileSelect-related components and directives to a standalone Angular component.
  */
 export declare const KENDO_FILESELECT: readonly [typeof FileSelectComponent, typeof FileTemplateDirective, typeof FileInfoTemplateDirective, typeof CustomMessagesComponent, typeof UploadDropZoneDirective, typeof UploadDropZoneComponent];
 /**
- * Utility array that contains all `Upload` related components and directives
+ * Use the KENDO_UPLOAD utility array to add all Upload-related components and directives to a standalone Angular component.
  */
 export declare const KENDO_UPLOAD: readonly [typeof UploadComponent, typeof UploadActionButtonsComponent, typeof UploadStatusTotalComponent, typeof FileTemplateDirective, typeof FileInfoTemplateDirective, typeof CustomMessagesComponent, typeof UploadDropZoneDirective, typeof UploadDropZoneComponent];
 /**
- * Utility array that contains all `@progress/kendo-angular-upload` related components and directives
+ * Use the KENDO_UPLOADS utility array to add all `@progress/kendo-angular-upload`-related components and directives to a standalone Angular component.
  */
 export declare const KENDO_UPLOADS: readonly [typeof FileSelectComponent, typeof FileTemplateDirective, typeof FileInfoTemplateDirective, typeof CustomMessagesComponent, typeof UploadDropZoneDirective, typeof UploadDropZoneComponent, typeof UploadComponent, typeof UploadActionButtonsComponent, typeof UploadStatusTotalComponent, typeof FileTemplateDirective, typeof FileInfoTemplateDirective, typeof CustomMessagesComponent, typeof UploadDropZoneDirective, typeof UploadDropZoneComponent];

package/dropzone-external.directive.d.ts

@@ -6,16 +6,24 @@ import { DropZoneService } from './dropzone.service';
 import { UploadComponent } from './upload.component';
 import { FileSelectComponent } from './fileselect.component';
 import * as i0 from "@angular/core";
+/**
+ * Represents the [Kendo UI UploadDropZone directive for Angular]({% slug overview_upload %}).
+ * Use this directive to create external drop zones for Upload and FileSelect components.
+ *
+ * @example
+ * ```html
+ * <div kendoUploadDropZone="upload1">Drop files here</div>
+ * <kendo-upload [saveUrl]="uploadSaveUrl" zoneId="upload1"></kendo-upload>
+ * ```
+ */
 export declare class UploadDropZoneDirective {
     private dropZoneService;
     /**
-     * Specifies the id of the drop zone used to associate it with
-     * an existing Upload component.
+     * The id of the drop zone to associate with an existing Upload component.
      */
     zoneId: string;
     /**
-     * Specifies the id of the drop zone used to associate it with
-     * an existing FileSelect component.
+     * The id of the drop zone to associate with an existing FileSelect component.
      */
     fileSelectZoneId: string;
     constructor(dropZoneService: DropZoneService);

package/dropzone.component.d.ts

@@ -9,30 +9,37 @@ import { SVGIcon } from '@progress/kendo-svg-icons';
 import * as i0 from "@angular/core";
 /**
  * Represents the [Kendo UI UploadDropZone component for Angular]({% slug overview_upload %}).
+ *
+ * @example
+ * ```html
+ * <kendo-uploaddropzone zoneId="upload1">
+ *   Drop files here to upload
+ * </kendo-uploaddropzone>
+ * <kendo-upload [saveUrl]="uploadSaveUrl" zoneId="upload1"></kendo-upload>
+ * ```
  */
 export declare class UploadDropZoneComponent extends DropZoneBase {
     private localization;
     hostClass: boolean;
     get dirAttribute(): string;
     /**
-     * Defines the id of the component.
-     * It is used to associate it with an existing Upload or FileSelect component.
+     * Specifies the id of the component.
+     * Use this id to associate the DropZone with an existing Upload or FileSelect component.
      */
     zoneId: string;
     /**
-     * Defines the name for an existing icon in a Kendo UI theme.
-     * The icon is rendered inside the DropZone.
+     * Specifies the name for an existing icon in a Kendo UI theme.
+     * The icon renders inside the DropZone.
      */
     icon: string;
     /**
-     * Defines a CSS class or multiple classes separated by spaces,
-     * which are applied to a span element.
-     * Allows the usage of custom icons.
+     * Specifies a CSS class or multiple classes separated by spaces which apply to a span element.
+     * Use this property to apply custom icons.
      */
     iconClass: string;
     /**
-     * Defines an SVGIcon to be rendered inside the DropZone.
-     * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
+     * Specifies an SVGIcon to render inside the DropZone.
+     * The input accepts either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
      */
     set svgIcon(icon: SVGIcon);
     get svgIcon(): SVGIcon;

package/esm2022/common/base.mjs

@@ -44,18 +44,21 @@ export class UploadFileSelectBase {
      */
     disabled = false;
     /**
-     * Enables the selection of multiple files
-     * If set to `false`, only one file can be selected at a time.
+     * Allows you to select multiple files.
+     * When you set this to `false`, you can select only one file at a time.
+     *
      * @default true
      */
     multiple = true;
     /**
-     * Toggles the visibility of the file list.
+     * Controls the visibility of the file list.
+     *
      * @default true
      */
     showFileList = true;
     /**
-     * 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
      */
     tabindex = 0;
@@ -70,7 +73,8 @@ export class UploadFileSelectBase {
         return this._restrictions;
     }
     /**
-     * Specifies the id of the external drop zone to associate with the component.
+     * Sets the `id` of the external drop zone that you want to associate with the component.
+     *
      */
     zoneId;
     /**
@@ -88,19 +92,19 @@ export class UploadFileSelectBase {
         return this.disabled;
     }
     /**
-     * Fires when the user navigates outside the component.
+     * Fires when you navigate outside the component.
      */
     onBlur = new EventEmitter();
     /**
-     * Fires when the component is focused.
+     * Fires when you focus the component.
      */
     onFocus = new EventEmitter();
     /**
-     * Fires when files are selected. If prevented, the selected files will not be added to the list.
+     * Fires when you select files. If you prevent this event, the component will not add the selected files to the list.
      */
     select = new EventEmitter();
     /**
-     * Fires when a file is about to be removed. If prevented, the file will remain in the list.
+     * Fires when you are about to remove a file. If you prevent this event, the file will remain in the list.
      */
     remove = new EventEmitter();
     /**
@@ -193,7 +197,7 @@ export class UploadFileSelectBase {
         }
     }
     /**
-     * Focuses the component's `Select files` button.
+     * Focuses the component's **Select files** button.
      */
     focus() {
         this.zone.runOutsideAngular(() => {
@@ -211,7 +215,7 @@ export class UploadFileSelectBase {
         this.focus();
     }
     /**
-     * Blurs the component if it was previously focused.
+     * Blurs the component if you previously focused it.
      */
     blur() {
         if (this.navigation.focused) {

package/esm2022/directives.mjs

@@ -12,7 +12,7 @@ import { FileInfoTemplateDirective } from "./templates/file-info-template.direct
 import { FileTemplateDirective } from "./templates/file-template.directive";
 import { UploadComponent } from "./upload.component";
 /**
- * Utility array that contains all `FileSelect` related components and directives
+ * Use the KENDO_FILESELECT utility array to add all FileSelect-related components and directives to a standalone Angular component.
  */
 export const KENDO_FILESELECT = [
     FileSelectComponent,
@@ -23,7 +23,7 @@ export const KENDO_FILESELECT = [
     UploadDropZoneComponent
 ];
 /**
- * Utility array that contains all `Upload` related components and directives
+ * Use the KENDO_UPLOAD utility array to add all Upload-related components and directives to a standalone Angular component.
  */
 export const KENDO_UPLOAD = [
     UploadComponent,
@@ -36,7 +36,7 @@ export const KENDO_UPLOAD = [
     UploadDropZoneComponent
 ];
 /**
- * Utility array that contains all `@progress/kendo-angular-upload` related components and directives
+ * Use the KENDO_UPLOADS utility array to add all `@progress/kendo-angular-upload`-related components and directives to a standalone Angular component.
  */
 export const KENDO_UPLOADS = [
     ...KENDO_FILESELECT,

package/esm2022/dropzone-external.directive.mjs

@@ -9,16 +9,24 @@ import { DropZoneService } from './dropzone.service';
 import { UploadComponent } from './upload.component';
 import * as i0 from "@angular/core";
 import * as i1 from "./dropzone.service";
+/**
+ * Represents the [Kendo UI UploadDropZone directive for Angular]({% slug overview_upload %}).
+ * Use this directive to create external drop zones for Upload and FileSelect components.
+ *
+ * @example
+ * ```html
+ * <div kendoUploadDropZone="upload1">Drop files here</div>
+ * <kendo-upload [saveUrl]="uploadSaveUrl" zoneId="upload1"></kendo-upload>
+ * ```
+ */
 export class UploadDropZoneDirective {
     dropZoneService;
     /**
-     * Specifies the id of the drop zone used to associate it with
-     * an existing Upload component.
+     * The id of the drop zone to associate with an existing Upload component.
      */
     zoneId;
     /**
-     * Specifies the id of the drop zone used to associate it with
-     * an existing FileSelect component.
+     * The id of the drop zone to associate with an existing FileSelect component.
      */
     fileSelectZoneId;
     constructor(dropZoneService) {

package/esm2022/dropzone.component.mjs

@@ -13,6 +13,14 @@ import * as i0 from "@angular/core";
 import * as i1 from "@progress/kendo-angular-l10n";
 /**
  * Represents the [Kendo UI UploadDropZone component for Angular]({% slug overview_upload %}).
+ *
+ * @example
+ * ```html
+ * <kendo-uploaddropzone zoneId="upload1">
+ *   Drop files here to upload
+ * </kendo-uploaddropzone>
+ * <kendo-upload [saveUrl]="uploadSaveUrl" zoneId="upload1"></kendo-upload>
+ * ```
  */
 export class UploadDropZoneComponent extends DropZoneBase {
     localization;
@@ -21,24 +29,23 @@ export class UploadDropZoneComponent extends DropZoneBase {
         return this.direction;
     }
     /**
-     * Defines the id of the component.
-     * It is used to associate it with an existing Upload or FileSelect component.
+     * Specifies the id of the component.
+     * Use this id to associate the DropZone with an existing Upload or FileSelect component.
      */
     zoneId;
     /**
-     * Defines the name for an existing icon in a Kendo UI theme.
-     * The icon is rendered inside the DropZone.
+     * Specifies the name for an existing icon in a Kendo UI theme.
+     * The icon renders inside the DropZone.
      */
     icon;
     /**
-     * Defines a CSS class or multiple classes separated by spaces,
-     * which are applied to a span element.
-     * Allows the usage of custom icons.
+     * Specifies a CSS class or multiple classes separated by spaces which apply to a span element.
+     * Use this property to apply custom icons.
      */
     iconClass;
     /**
-     * Defines an SVGIcon to be rendered inside the DropZone.
-     * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
+     * Specifies an SVGIcon to render inside the DropZone.
+     * The input accepts either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
      */
     set svgIcon(icon) {
         if (isDevMode() && icon && this.icon && this.iconClass) {

package/esm2022/events/cancel-event.mjs

@@ -4,33 +4,24 @@
 *-------------------------------------------------------------------------------------------*/
 /**
  * Arguments for the `cancel` event. The `cancel` event fires when
- * the user cancels the process of uploading a file or a batch of files.
+ * you cancel the upload of a file or batch of files.
  *
- * ```ts-no-run
- *  @Component({
- *    selector: 'my-upload',
+ * ```typescript
+ * @Component({
  *    template: `
- *    <p>Click the <span class='k-icon k-font-icon k-i-cancel'></span> icon during upload to trigger the event</p>
- *    <kendo-upload
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
- *      (cancel)="cancelEventHandler($event)">
- *    </kendo-upload>
+ *    <kendo-upload  (cancel)="cancelEventHandler($event)">   </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    cancelEventHandler(e: CancelEvent) {
+ *    public cancelEventHandler(e: CancelEvent) {
  *      console.log('Canceling file upload', e.files);
  *    }
- *  }
+ * }
  * ```
  */
 export class CancelEvent {
     /**
-     * The list of the files that were going to be uploaded.
+     * The files that you canceled during the upload process.
      */
     files;
     /**

package/esm2022/events/clear-event.mjs

@@ -5,28 +5,21 @@
 import { PreventableEvent } from './preventable-event';
 /**
  * Arguments for the `clear` event. The `clear` event fires when
- * the **Clear** button is clicked. At this point, the selected files are about to be cleared.
+ * the **Clear** button is clicked and selected files are about to be cleared.
  *
- * ```ts-no-run
- *  @Component({
- *    selector: 'my-upload',
+ * ```typescript
+ * @Component({
  *    template: `
  *    <kendo-upload
- *      [autoUpload]="false"
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (clear)="clearEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    clearEventHandler(e: ClearEvent) {
+ *    public clearEventHandler(e: ClearEvent) {
  *      console.log('Clearing the file upload');
  *    }
- *  }
+ * }
  * ```
  */
 export class ClearEvent extends PreventableEvent {

package/esm2022/events/error-event.mjs

@@ -6,38 +6,32 @@
  * Arguments for the `error` event. The `error` event fires when
  * an `upload` or `remove` operation fails.
  *
- * ```ts-no-run
- *  @Component({
- *    selector: 'my-upload',
+ * ```typescript
+ * @Component({
  *    template: `
  *    <kendo-upload
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (error)="errorEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    errorEventHandler(e: ErrorEvent) {
+ *   public errorEventHandler(e: ErrorEvent) {
  *      console.log('An error occurred');
  *    }
- *  }
+ * }
  * ```
  */
 export class ErrorEvent {
     /**
-     * The list of the files that failed to be uploaded or removed.
+     * The array of files that failed to be uploaded or removed.
      */
     files;
     /**
-     * The operation type (`upload` or `remove`).
+     * The operation type that failed (`upload` or `remove`).
      */
     operation;
     /**
-     * The response object returned by the server.
+     * The HTTP response returned by the server containing error details.
      */
     response;
     /**

package/esm2022/events/pause-event.mjs

@@ -3,35 +3,28 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the `pause` event. The `pause` event fires when the user
- * pauses a file that is currently uploading.
+ * Arguments for the `pause` event. The `pause` event fires when
+ * you pause a file that is currently uploading.
  *
- * ```ts-no-run
+ * ```typescript
  *  @Component({
- *    selector: 'my-upload',
  *    template: `
  *    <kendo-upload
  *      [chunkable]="true"
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (pause)="pauseEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    pauseEventHandler(ev: PauseEvent) {
+ *    public pauseEventHandler(ev: PauseEvent) {
  *      console.log('File paused');
  *    }
  *  }
  * ```
- *
  */
 export class PauseEvent {
     /**
-     * The file that is going to be paused.
+     * The file that you paused during the upload process.
      */
     file;
     /**

package/esm2022/events/remove-event.mjs

@@ -4,25 +4,19 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `remove` event. The `remove` event fires when an uploaded
- * or selected file is about to be removed. If you cancel the event, the removal is prevented.
+ * Arguments for the `remove` event. The `remove` event fires when you are about to remove an uploaded
+ * or selected file. You can cancel this event to prevent removal.
  *
- * ```ts-no-run
+ * ```typescript
  *  @Component({
- *    selector: 'my-upload',
  *    template: `
  *    <kendo-upload
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (remove)="removeEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    removeEventHandler(e: RemoveEvent) {
+ *    public removeEventHandler(e: RemoveEvent) {
  *      console.log('Removing a file');
  *    }
  *  }
@@ -30,15 +24,17 @@ import { PreventableEvent } from './preventable-event';
  */
 export class RemoveEvent extends PreventableEvent {
     /**
-     * An optional object that is sent to the `remove` handler in the form of a key/value pair.
+     * An optional object that you send to the `remove` handler as key/value pairs.
+     *
      */
     data;
     /**
-     * The list of the files that will be removed.
+     * The files that you will remove from the server.
      */
     files;
     /**
      * The headers of the request.
+     * You can use this to add custom headers to the remove request.
      */
     headers;
     /**

package/esm2022/events/resume-event.mjs

@@ -3,35 +3,28 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the `resume` event. The `resume` event fires when the user
- * resumes the upload of a file that has been previously paused.
+ * Arguments for the `resume` event. The `resume` event fires when
+ * you resume a previously paused file upload.
  *
- * ```ts-no-run
+ * ```typescript
  *  @Component({
- *    selector: 'my-upload',
  *    template: `
  *    <kendo-upload
  *      [chunkable]="true"
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (resume)="resumeEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    resumeEventHandler(ev: ResumeEvent) {
+ *    public resumeEventHandler(ev: ResumeEvent) {
  *      console.log('File resumed');
  *    }
  *  }
  * ```
- *
  */
 export class ResumeEvent {
     /**
-     * The file that is going to be resumed.
+     * The file that you resumed during the upload process.
      */
     file;
     /**