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

package/upload.component.d.ts

@@ -22,6 +22,11 @@ import * as i0 from "@angular/core";
 export declare const UPLOAD_VALUE_ACCESSOR: any;
 /**
  * Represents the [Kendo UI Upload component for Angular]({% slug overview_upload %}).
+ *
+ * @example
+ * ```html
+ * <kendo-upload> </kendo-upload>
+ * ```
  */
 export declare class UploadComponent extends UploadFileSelectBase implements OnInit, OnDestroy, ControlValueAccessor {
     protected uploadService: UploadService;
@@ -33,101 +38,106 @@ export declare class UploadComponent extends UploadFileSelectBase implements OnI
     protected cdr: ChangeDetectorRef;
     protected injector: 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: boolean);
     get autoUpload(): boolean;
     /**
-     * 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: boolean);
     get batch(): boolean;
     /**
-     * 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: boolean);
     get withCredentials(): boolean;
     /**
-     * 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: string);
     get saveField(): string;
     /**
-     * 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: HttpHeaders);
     get saveHeaders(): HttpHeaders;
     /**
-     * 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: string);
     get saveMethod(): string;
     /**
-     * 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: string);
     get saveUrl(): string;
     /**
-     * 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: 'arraybuffer' | 'blob' | 'json' | 'text');
     get responseType(): 'arraybuffer' | 'blob' | 'json' | 'text';
     /**
-     * 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: string);
     get removeField(): string;
     /**
-     * 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: HttpHeaders);
     get removeHeaders(): HttpHeaders;
     /**
-     * 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: string);
     get removeMethod(): string;
     /**
-     * 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: string);
     get removeUrl(): string;
     /**
-     * Enables the chunk functionality of the Upload.
+     * Specifies whether the chunk functionality of the Upload is enabled.
      *
      * @default false
      */
     chunkable: ChunkSettings | boolean;
     /**
-     * Specifies if the selected files are uploaded simultaneously or one by one.
+     * Specifies whether selected files upload simultaneously or one by one.
      *
      * @default true
      */
     set concurrent(concurrent: boolean);
     get concurrent(): boolean;
     /**
-     * Toggles the visibility of the file list.
+     * Specifies whether the file list is visible.
+     *
      * @default true
      */
     showFileList: boolean;
@@ -137,7 +147,9 @@ export declare class UploadComponent extends UploadFileSelectBase implements OnI
     set tabIndex(tabIndex: number);
     get tabIndex(): number;
     /**
-     * Specifies the possible layout of the action buttons.
+     * Specifies the layout of the action buttons.
+     *
+     * @default 'end'
      */
     actionsLayout: ActionsLayout;
     fileSelectInput: ElementRef;
@@ -146,39 +158,41 @@ export declare class UploadComponent extends UploadFileSelectBase implements OnI
      */
     cancel: EventEmitter<CancelEvent>;
     /**
-     * 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: EventEmitter<ClearEvent>;
     /**
-     * Fires when all active uploads are completed either successfully or with errors.
+     * Fires when all active uploads complete successfully or with errors.
      */
     complete: EventEmitter<any>;
     /**
-     * Fires when an `upload` or `remove` operation has failed.
+     * Fires when an `upload` or `remove` operation fails.
      */
     error: EventEmitter<ErrorEvent>;
     /**
-     * Fires when the upload of a file has been paused.
+     * Fires when the upload of a file is paused.
      */
     pause: EventEmitter<any>;
     /**
-     * Fires when the upload of a file has been resumed.
+     * Fires when the upload of a file is resumed.
      */
     resume: EventEmitter<any>;
     /**
-     * Fires when an `upload` or `remove` operation is successfully completed.
+     * Fires when an `upload` or `remove` operation completes successfully.
      */
     success: EventEmitter<SuccessEvent>;
     /**
-     * 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: EventEmitter<UploadEvent>;
     /**
-     * Fires when one or more files are being uploaded.
+     * Fires when one or more files are uploading.
      */
     uploadProgress: EventEmitter<UploadProgressEvent>;
     /**
-     * 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: EventEmitter<Array<FileInfo>>;
     get dir(): string;
@@ -220,39 +234,42 @@ export declare class UploadComponent extends UploadFileSelectBase implements OnI
     };
     /**
      * 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: string): void;
     /**
-     * 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: string): void;
     /**
-     * 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: string): void;
     /**
-     * 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: string): void;
     /**
      * 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: string): void;
     /**
-     * Uploads the currently selected files which pass the set restrictions.
+     * Uploads the currently selected files that pass the set restrictions.
      */
     uploadFiles(): void;
     /**
-     * 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(): void;
     /**