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

package/esm2022/upload.component.mjs

@@ -43,6 +43,11 @@ export const UPLOAD_VALUE_ACCESSOR = {
 let idx = 0;
 /**
  * Represents the [Kendo UI Upload component for Angular]({% slug overview_upload %}).
+ *
+ * @example
+ * ```html
+ * <kendo-upload> </kendo-upload>
+ * ```
  */
 export class UploadComponent extends UploadFileSelectBase {
     uploadService;
@@ -54,9 +59,11 @@ export class UploadComponent extends UploadFileSelectBase {
     cdr;
     injector;
     /**
-     * By default, the selected files are immediately uploaded
+     * Specifies whether selected files upload automatically
      * ([see example]({% slug fileprocessing_upload %}#toc-automatic-upload-of-files)).
-     * To change this behavior, set `autoUpload` to `false`.
+     * Set `autoUpload` to `false` to change this behavior.
+     *
+     * @default true
      */
     set autoUpload(autoUpload) {
         this.uploadService.async.autoUpload = autoUpload;
@@ -65,9 +72,11 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.autoUpload;
     }
     /**
-     * When enabled, all files in the selection are uploaded in one request
+     * Specifies whether all files in the selection upload in a single request
      * ([see example]({% slug fileprocessing_upload %}#toc-upload-of-batches-of-files)).
-     * Any files that are selected one after the other are uploaded in separate requests.
+     * Files selected one after the other upload in separate requests.
+     *
+     * @default false
      */
     set batch(batch) {
         this.uploadService.async.batch = batch;
@@ -76,11 +85,13 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.batch;
     }
     /**
-     * Configures whether credentials (cookies, headers) will be sent for cross-site requests
+     * Specifies whether credentials (cookies, headers) are sent for cross-site requests
      * ([see example]({% slug credentials_upload %}#toc-attaching-credentials-to-requests)).
-     * The default values is `true`. Setting `withCredentials` has no effect on same-site requests.
-     * To add credentials to the request, use the `saveHeaders` or `removeHeaders` property,
-     * or the [`upload`]({% slug api_upload_uploadevent %}) event.
+     * Set `withCredentials` has no effect on same-site requests.
+     * Use the `saveHeaders` or `removeHeaders` property to add credentials to the request.
+     * You can also use the [`upload`]({% slug api_upload_uploadevent %}) event.
+     *
+     * @default true
      */
     set withCredentials(withCredentials) {
         this.uploadService.async.withCredentials = withCredentials;
@@ -89,8 +100,8 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.withCredentials;
     }
     /**
-     * Sets the [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) key which contains the files submitted to `saveUrl`.
-     * The default value is `files`.
+     * Specifies the [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) key which contains the files submitted to `saveUrl`.
+     *
      */
     set saveField(saveField) {
         this.uploadService.async.saveField = saveField;
@@ -99,8 +110,7 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.saveField;
     }
     /**
-     * Configures the [`HttpHeaders`](https://angular.io/api/common/http/HttpHeaders)
-     * that are attached to each upload request.
+     * Specifies the [`HttpHeaders`](https://angular.io/api/common/http/HttpHeaders) attached to each upload request.
      */
     set saveHeaders(saveHeaders) {
         this.uploadService.async.saveHeaders = saveHeaders;
@@ -109,8 +119,8 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.saveHeaders;
     }
     /**
-     * Sets the [`RequestMethod`](https://angular.io/api/http/RequestMethod) of the upload request.
-     * The default value is `POST`.
+     * Specifies the [`RequestMethod`](https://angular.io/api/http/RequestMethod) of the upload request.
+     *
      */
     set saveMethod(saveMethod) {
         this.uploadService.async.saveMethod = saveMethod;
@@ -119,9 +129,9 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.saveMethod;
     }
     /**
-     * Sets the URL of the endpoint for the upload request.
-     * The request [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) key is named after the `saveField` property.
-     * It contains the list of files to be uploaded.
+     * Specifies the URL of the endpoint for the upload request.
+     * The request [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) key uses the name from the `saveField` property.
+     * This key contains the list of files to be uploaded.
      */
     set saveUrl(saveUrl) {
         this.uploadService.async.saveUrl = saveUrl;
@@ -130,8 +140,9 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.saveUrl;
     }
     /**
-     * Sets the expected [`response type`](https://angular.io/api/common/http/HttpRequest#responseType) of the server.
-     * It is used to parse the response appropriately.
+     * Specifies the expected [`response type`](https://angular.io/api/common/http/HttpRequest#responseType) of the server.
+     * The response type determines how the response is parsed.
+     *
      * @default 'json'
      */
     set responseType(responseType) {
@@ -141,15 +152,13 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.responseType;
     }
     /**
-     * Sets the [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) key
-     * which contains the list of file names that are submitted to `removeUrl`.
-     * The default value is `fileNames`.
+     * Specifies the [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) key which contains the list of file names submitted to `removeUrl`.
+     *
      */
     set removeField(removeField) { this.uploadService.async.removeField = removeField; }
     get removeField() { return this.uploadService.async.removeField; }
     /**
-     * Configures the [`HttpHeaders`](https://angular.io/api/common/http/HttpHeaders)
-     * that are attached to each `remove` request.
+     * Specifies the [`HttpHeaders`](https://angular.io/api/common/http/HttpHeaders) attached to each `remove` request.
      */
     set removeHeaders(removeHeaders) {
         this.uploadService.async.removeHeaders = removeHeaders;
@@ -158,8 +167,8 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.removeHeaders;
     }
     /**
-     * Sets the [`RequestMethod`](https://angular.io/api/http/RequestMethod) of the `remove` request.
-     * The default value is `POST`.
+     * Specifies the [`RequestMethod`](https://angular.io/api/http/RequestMethod) of the `remove` request.
+     *
      */
     set removeMethod(removeMethod) {
         this.uploadService.async.removeMethod = removeMethod;
@@ -168,9 +177,9 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.removeMethod;
     }
     /**
-     * Sets the URL of the endpoint for the `remove` request.
-     * The [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) request key is named after the `removeField` property.
-     * It contains the list of file names which will be removed.
+     * Specifies the URL of the endpoint for the `remove` request.
+     * The [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) request key uses the name from the `removeField` property.
+     * This key contains the list of file names to be removed.
      */
     set removeUrl(removeUrl) {
         this.uploadService.async.removeUrl = removeUrl;
@@ -179,13 +188,13 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.removeUrl;
     }
     /**
-     * Enables the chunk functionality of the Upload.
+     * Specifies whether the chunk functionality of the Upload is enabled.
      *
      * @default false
      */
     chunkable = false;
     /**
-     * Specifies if the selected files are uploaded simultaneously or one by one.
+     * Specifies whether selected files upload simultaneously or one by one.
      *
      * @default true
      */
@@ -196,7 +205,8 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.uploadService.async.concurrent;
     }
     /**
-     * Toggles the visibility of the file list.
+     * Specifies whether the file list is visible.
+     *
      * @default true
      */
     showFileList = true;
@@ -210,7 +220,9 @@ export class UploadComponent extends UploadFileSelectBase {
         return this.tabindex;
     }
     /**
-     * Specifies the possible layout of the action buttons.
+     * Specifies the layout of the action buttons.
+     *
+     * @default 'end'
      */
     actionsLayout = 'end';
     fileSelectInput;
@@ -219,39 +231,41 @@ export class UploadComponent extends UploadFileSelectBase {
      */
     cancel = new EventEmitter();
     /**
-     * Fires when the file list is about to be cleared. If prevented, the files will not be cleared.
+     * Fires when the file list is about to be cleared.
+     * Prevent this event to keep the files in the list.
      */
     clear = new EventEmitter();
     /**
-     * Fires when all active uploads are completed either successfully or with errors.
+     * Fires when all active uploads complete successfully or with errors.
      */
     complete = new EventEmitter();
     /**
-     * Fires when an `upload` or `remove` operation has failed.
+     * Fires when an `upload` or `remove` operation fails.
      */
     error = new EventEmitter();
     /**
-     * Fires when the upload of a file has been paused.
+     * Fires when the upload of a file is paused.
      */
     pause = new EventEmitter();
     /**
-     * Fires when the upload of a file has been resumed.
+     * Fires when the upload of a file is resumed.
      */
     resume = new EventEmitter();
     /**
-     * Fires when an `upload` or `remove` operation is successfully completed.
+     * Fires when an `upload` or `remove` operation completes successfully.
      */
     success = new EventEmitter();
     /**
-     * Fires when one or more files are about to be uploaded. If prevented, the files will neither be uploaded, nor added to the file list.
+     * Fires when one or more files are about to be uploaded.
+     * Prevent this event to stop the files from uploading and being added to the file list.
      */
     upload = new EventEmitter();
     /**
-     * Fires when one or more files are being uploaded.
+     * Fires when one or more files are uploading.
      */
     uploadProgress = new EventEmitter();
     /**
-     * Fires when the value of the component has changed as a result of a successful `upload`, `remove` or `clear` operation.
+     * Fires when the component value changes after a successful `upload`, `remove`, or `clear` operation.
      */
     valueChange = new EventEmitter();
     get dir() {
@@ -390,45 +404,48 @@ export class UploadComponent extends UploadFileSelectBase {
     }
     /**
      * Pauses the upload process of a file that is currently uploading.
-     * The `pauseFileByUid` method requires the `chunkable` option of the Upload to be enabled.
+     * This method requires the `chunkable` option of the Upload to be enabled.
      *
-     * @param uid - The `uid` of the file that will be paused.
+     * @param uid The `uid` of the file that will be paused.
      */
     pauseFileByUid(uid) {
         this.uploadService.pauseFile(uid);
     }
     /**
-     * Resumes the upload process for a file that has been previously paused.
-     * The `resumeFileByUid` method requires the `chunkable` option of the Upload to be enabled.
+     * Resumes the upload process for a file that was previously paused.
+     * This method requires the `chunkable` option of the Upload to be enabled.
      *
-     * @param uid - The `uid` of the file that will be resumed.
+     * @param uid The `uid` of the file that will be resumed.
      */
     resumeFileByUid(uid) {
         this.uploadService.resumeFile(uid);
     }
     /**
-     * Triggers the removal of a file or a batch of files.
-     * @param uid - The `uid` of the file or a batch of files that will be removed.
+     * Removes a file or a batch of files.
+     *
+     * @param uid The `uid` of the file or a batch of files that will be removed.
      */
     removeFilesByUid(uid) {
         this.uploadService.removeFiles(uid);
     }
     /**
-     * Triggers another upload attempt of an unsuccessfully uploaded file or a batch of files.
-     * @param uid - The `uid` of the file or a batch of files to be retried.
+     * Retries the upload of a file or batch of files that failed to upload.
+     *
+     * @param uid The `uid` of the file or a batch of files to be retried.
      */
     retryUploadByUid(uid) {
         this.uploadService.retryFiles(uid);
     }
     /**
      * Cancels the upload of a file or a batch of files.
-     * @param uid - The `uid` of the file or a batch of files that will be canceled.
+     *
+     * @param uid The `uid` of the file or a batch of files that will be canceled.
      */
     cancelUploadByUid(uid) {
         this.uploadService.cancelFiles(uid);
     }
     /**
-     * Uploads the currently selected files which pass the set restrictions.
+     * Uploads the currently selected files that pass the set restrictions.
      */
     uploadFiles() {
         if (this.fileList.filesToUpload.length) {
@@ -436,7 +453,7 @@ export class UploadComponent extends UploadFileSelectBase {
         }
     }
     /**
-     * Visually clears all files from the UI without issuing requests to the remove handler.
+     * Clears all files from the UI without sending requests to the remove handler.
      */
     clearFiles() {
         this.uploadService.clearFiles();
@@ -626,7 +643,7 @@ export class UploadComponent extends UploadFileSelectBase {
         [disabled]="disabled"
     >
         <div class="k-upload-button-wrap">
-            <button 
+            <button
                 kendoButton
                 #fileSelectButton
                 class="k-upload-button"
@@ -759,7 +776,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
         [disabled]="disabled"
     >
         <div class="k-upload-button-wrap">
-            <button 
+            <button
                 kendoButton
                 #fileSelectButton
                 class="k-upload-button"

package/events/cancel-event.d.ts

@@ -5,33 +5,24 @@
 import { FileInfo } from '../types';
 /**
  * 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 declare class CancelEvent {
     /**
-     * The list of the files that were going to be uploaded.
+     * The files that you canceled during the upload process.
      */
     files: Array<FileInfo>;
     /**

package/events/clear-event.d.ts

@@ -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 declare class ClearEvent extends PreventableEvent {

package/events/error-event.d.ts

@@ -8,38 +8,32 @@ import { FileInfo, OperationType } from '../types';
  * 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 declare 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: Array<FileInfo>;
     /**
-     * The operation type (`upload` or `remove`).
+     * The operation type that failed (`upload` or `remove`).
      */
     operation: OperationType;
     /**
-     * The response object returned by the server.
+     * The HTTP response returned by the server containing error details.
      */
     response: HttpResponse<any>;
     /**

package/events/pause-event.d.ts

@@ -4,35 +4,28 @@
 *-------------------------------------------------------------------------------------------*/
 import { FileInfo } from '../types';
 /**
- * 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 declare class PauseEvent {
     /**
-     * The file that is going to be paused.
+     * The file that you paused during the upload process.
      */
     file: FileInfo;
     /**

package/events/remove-event.d.ts

@@ -6,25 +6,19 @@ import { HttpHeaders } from '@angular/common/http';
 import { PreventableEvent } from './preventable-event';
 import { FileInfo } from '../types';
 /**
- * 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');
  *    }
  *  }
@@ -32,15 +26,17 @@ import { FileInfo } from '../types';
  */
 export declare 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: Object;
     /**
-     * The list of the files that will be removed.
+     * The files that you will remove from the server.
      */
     files: Array<FileInfo>;
     /**
      * The headers of the request.
+     * You can use this to add custom headers to the remove request.
      */
     headers: HttpHeaders;
     /**

package/events/resume-event.d.ts

@@ -4,35 +4,28 @@
 *-------------------------------------------------------------------------------------------*/
 import { FileInfo } from '../types';
 /**
- * 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 declare class ResumeEvent {
     /**
-     * The file that is going to be resumed.
+     * The file that you resumed during the upload process.
      */
     file: FileInfo;
     /**

package/events/select-event.d.ts

@@ -5,25 +5,19 @@
 import { PreventableEvent } from './preventable-event';
 import { FileInfo } from '../types';
 /**
- * Arguments for the `select` event. The `select` event fires when the user
- * selects a file or multiple files for upload. If you cancel the event, the selection is prevented.
+ * Arguments for the `select` event. The `select` event fires when
+ * a file or multiple files are selected for upload. The event can be canceled to prevent selection.
  *
- * ```ts-no-run
+ * ```typescript
  *  @Component({
- *    selector: 'my-upload',
  *    template: `
  *    <kendo-upload
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (select)="selectEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    selectEventHandler(e: SelectEvent) {
+ *    public selectEventHandler(e: SelectEvent) {
  *      console.log('File selected');
  *    }
  *  }
@@ -31,7 +25,7 @@ import { FileInfo } from '../types';
  */
 export declare class SelectEvent extends PreventableEvent {
     /**
-     * The list of the selected files.
+     * The files that are selected for upload.
      */
     files: Array<FileInfo>;
     /**