Work for surveyjs/survey-creator#5124 - implemented file chooser func…

…tionality for survey

packages/survey-angular-ui/src/components/file/choose-file.component.html

@@ -1,6 +1,7 @@
 <ng-template #template>
     <label tabindex="0" [class]="question.getChooseFileCss()"
-        [attr.for]="question.inputId" [attr.aria-label]="question.chooseButtonText" [key2click]>
+        [attr.for]="question.inputId" [attr.aria-label]="question.chooseButtonText" [key2click]
+        (click)="question.chooseFile()">
         <svg *ngIf="question.cssClasses.chooseFileIconId" [title]="question.chooseButtonText"
             [iconName]="question.cssClasses.chooseFileIconId" [size]="'auto'" sv-ng-svg-icon></svg>
         <span>{{ question.chooseButtonText }}</span>

packages/survey-vue3-ui/src/components/file/FileChooseButton.vue

@@ -5,6 +5,7 @@
     :for="question.inputId"
     v-bind:aria-label="question.chooseButtonText"
     v-key2click
+    v-on:click="function() { question.chooseFile(); }"
   >
     <sv-svg-icon
       v-if="question.cssClasses.chooseFileIconId"

src/base-interfaces.ts

@@ -234,6 +234,7 @@ export interface ISurvey extends ITextProcessor, ISurveyErrorOwner {
   elementContentVisibilityChanged(element: ISurveyElement): void;
   onCorrectQuestionAnswer(question: IQuestion, options: any): void;
   processPopupVisiblityChanged(question: IQuestion, popupModel: PopupModel, visible: boolean): void;
+  chooseFiles(input: HTMLInputElement, callback: (files: File[]) => void, context?: { element: ISurveyElement, item?: any }): void;
 }
 export interface ISurveyImpl {
   getSurveyData(): ISurveyData;

src/knockout/components/file/choose-file.html

@@ -1,4 +1,4 @@
-<label tabindex="0" data-bind="css: question.koChooseFileCss, key2click, attr: { for: question.inputId, 'aria-label': question.koGetChooseButtonText() }">
+<label tabindex="0" data-bind="css: question.koChooseFileCss, key2click, click: function() { question.chooseFile(); }, attr: { for: question.inputId, 'aria-label': question.koGetChooseButtonText() }">
   <!-- ko if: question.cssClasses.chooseFileIconId -->
     <!-- ko component: { name: 'sv-svg-icon', params: { title: question.koGetChooseButtonText(), iconName: question.cssClasses.chooseFileIconId, size: 'auto' } } --><!-- /ko -->
   <!-- /ko -->

src/question_file.ts

@@ -147,9 +147,11 @@ export class QuestionFileModel extends QuestionFileModelBase {
   @propertyArray({}) public previewValue: any[];
 
   @property({ defaultValue: 0 }) indexToShow: number;
-  @property({ defaultValue: 1, onSet: (_, target) => {
-    target.updateFileNavigator();
-  } }) pageSize: number;
+  @property({
+    defaultValue: 1, onSet: (_, target) => {
+      target.updateFileNavigator();
+    }
+  }) pageSize: number;
   @property({ defaultValue: false }) containsMultiplyFiles: boolean;
   @property() allowCameraAccess: boolean;
   /**
@@ -164,11 +166,13 @@ export class QuestionFileModel extends QuestionFileModelBase {
    * @see photoPlaceholder
    * @see fileOrPhotoPlaceholder
    */
-  @property({ onSet: (val: string, obj: QuestionFileModel) => {
-    if(!obj.isLoadingFromJson) {
-      obj.updateCurrentMode();
+  @property({
+    onSet: (val: string, obj: QuestionFileModel) => {
+      if (!obj.isLoadingFromJson) {
+        obj.updateCurrentMode();
+      }
     }
-  } }) sourceType: string;
+  }) sourceType: string;
 
   public fileNavigator: ActionContainer = new ActionContainer();
   protected prevFileAction: Action;
@@ -300,7 +304,7 @@ export class QuestionFileModel extends QuestionFileModelBase {
   public get hasFileUI(): boolean { return this.currentMode !== "camera"; }
   private videoStream: MediaStream;
   public startVideo(): void {
-    if(this.currentMode === "file" || this.isDesignMode || this.isPlayingVideo) return;
+    if (this.currentMode === "file" || this.isDesignMode || this.isPlayingVideo) return;
     this.setIsPlayingVideo(true);
     setTimeout(() => {
       this.startVideoInCamera();
@@ -310,7 +314,7 @@ export class QuestionFileModel extends QuestionFileModelBase {
   private startVideoInCamera(): void {
     this.camera.startVideo(this.videoId, (stream: MediaStream) => {
       this.videoStream = stream;
-      if(!stream) {
+      if (!stream) {
         this.stopVideo();
       }
     }, getRenderedSize(this.imageWidth), getRenderedSize(this.imageHeight));
@@ -320,9 +324,9 @@ export class QuestionFileModel extends QuestionFileModelBase {
     this.closeVideoStream();
   }
   public snapPicture(): void {
-    if(!this.isPlayingVideo) return;
+    if (!this.isPlayingVideo) return;
     const blobCallback = (blob: Blob | null): void => {
-      if(blob) {
+      if (blob) {
         const file = new File([blob], "snap_picture.png", { type: "image/png" });
         this.loadFiles([file]);
       }
@@ -332,21 +336,21 @@ export class QuestionFileModel extends QuestionFileModelBase {
   }
   @property() private canFlipCameraValue: boolean = undefined;
   public canFlipCamera(): boolean {
-    if(this.canFlipCameraValue === undefined) {
+    if (this.canFlipCameraValue === undefined) {
       this.canFlipCameraValue = this.camera.canFlip((res: boolean) => {
         this.canFlipCameraValue = res;
       });
     }
     return this.canFlipCameraValue;
   }
   public flipCamera(): void {
-    if(!this.canFlipCamera()) return;
+    if (!this.canFlipCamera()) return;
     this.closeVideoStream();
     this.camera.flip();
     this.startVideoInCamera();
   }
   private closeVideoStream(): void {
-    if(!!this.videoStream) {
+    if (!!this.videoStream) {
       this.videoStream.getTracks().forEach(track => {
         track.stop();
       });
@@ -372,9 +376,9 @@ export class QuestionFileModel extends QuestionFileModelBase {
   }
   private prevPreviewLength = 0;
   private previewValueChanged() {
-    if(this.previewValue.length !== this.prevPreviewLength) {
-      if(this.previewValue.length > 0) {
-        if(this.prevPreviewLength > this.previewValue.length) {
+    if (this.previewValue.length !== this.prevPreviewLength) {
+      if (this.previewValue.length > 0) {
+        if (this.prevPreviewLength > this.previewValue.length) {
           this.indexToShow = this.indexToShow >= this.pagesCount && this.indexToShow > 0 ? this.pagesCount - 1 : this.indexToShow;
         } else {
           this.indexToShow = Math.floor(this.prevPreviewLength / this.pageSize);
@@ -385,7 +389,7 @@ export class QuestionFileModel extends QuestionFileModelBase {
     }
     this.fileIndexAction.title = this.getFileIndexCaption();
     this.containsMultiplyFiles = this.previewValue.length > 1;
-    if(this.previewValue.length > 0 && !this.calculatedGapBetweenItems && !this.calculatedItemWidth) {
+    if (this.previewValue.length > 0 && !this.calculatedGapBetweenItems && !this.calculatedItemWidth) {
       setTimeout(() => {
         this.processResponsiveness(0, this._width);
       });
@@ -471,6 +475,16 @@ export class QuestionFileModel extends QuestionFileModelBase {
   public set maxSize(val: number) {
     this.setPropertyValue("maxSize", val);
   }
+  public chooseFile(): void {
+    const inputElement = document.getElementById(this.inputId) as HTMLInputElement;
+    if (inputElement) {
+      if (this.survey) {
+        this.survey.chooseFiles(inputElement, files => this.loadFiles(files), { element: this });
+      } else {
+        inputElement.click();
+      }
+    }
+  }
   /**
    * Specifies whether users should confirm file deletion.
    *
@@ -518,19 +532,19 @@ export class QuestionFileModel extends QuestionFileModelBase {
 
   @property() locRenderedPlaceholderValue: LocalizableString;
   public get locRenderedPlaceholder(): LocalizableString {
-    if(this.locRenderedPlaceholderValue === undefined) {
+    if (this.locRenderedPlaceholderValue === undefined) {
       this.locRenderedPlaceholderValue = <LocalizableString><unknown>(new ComputedUpdater<LocalizableString>(() => {
         const isReadOnly = this.isReadOnly;
         const hasFileUI = (!this.isDesignMode && this.hasFileUI) || (this.isDesignMode && this.sourceType != "camera");
         const hasVideoUI = (!this.isDesignMode && this.hasVideoUI) || (this.isDesignMode && this.sourceType != "file");
         let renderedPlaceholder: LocalizableString;
-        if(isReadOnly) {
+        if (isReadOnly) {
           renderedPlaceholder = this.locNoFileChosenCaption;
         }
-        else if(hasFileUI && hasVideoUI) {
+        else if (hasFileUI && hasVideoUI) {
           renderedPlaceholder = this.locFileOrPhotoPlaceholder;
         }
-        else if(hasFileUI) {
+        else if (hasFileUI) {
           renderedPlaceholder = this.locFilePlaceholder;
         }
         else {
@@ -551,8 +565,8 @@ export class QuestionFileModel extends QuestionFileModelBase {
     this.setPropertyValue("isPlayingVideo", show);
   }
   private updateCurrentMode(): void {
-    if(!this.isDesignMode) {
-      if(this.sourceType !== "file") {
+    if (!this.isDesignMode) {
+      if (this.sourceType !== "file") {
         this.camera.hasCamera((res: boolean) => {
           this.setPropertyValue("currentMode", res && this.isDefaultV2Theme ? this.sourceType : "file");
         });
@@ -573,7 +587,7 @@ export class QuestionFileModel extends QuestionFileModelBase {
     return " ";
   }
 
-  public get chooseButtonText () {
+  public get chooseButtonText() {
     return this.isEmpty() || this.allowMultiple ? this.chooseButtonCaption : this.replaceButtonCaption;
   }
 
@@ -719,7 +733,7 @@ export class QuestionFileModel extends QuestionFileModelBase {
   private cameraValue: Camera;
 
   protected get camera(): Camera {
-    if(!this.cameraValue) {
+    if (!this.cameraValue) {
       this.cameraValue = new Camera();
     }
     return this.cameraValue;
@@ -887,7 +901,7 @@ export class QuestionFileModel extends QuestionFileModelBase {
   protected onChangeQuestionValue(newValue: any): void {
     super.onChangeQuestionValue(newValue);
     this.stateChanged(this.isEmpty() ? "empty" : "loaded");
-    if(!this.isLoadingFromJson) {
+    if (!this.isLoadingFromJson) {
       this.loadPreview(newValue);
     }
   }
@@ -933,28 +947,28 @@ export class QuestionFileModel extends QuestionFileModelBase {
   private calculatedItemWidth: number;
   private _width: number;
   public triggerResponsiveness(hard?: boolean): void {
-    if(hard) {
+    if (hard) {
       this.calculatedGapBetweenItems = undefined;
       this.calculatedItemWidth = undefined;
     }
     super.triggerResponsiveness();
   }
   protected processResponsiveness(_: number, availableWidth: number): boolean {
     this._width = availableWidth;
-    if(this.rootElement) {
-      if((!this.calculatedGapBetweenItems || !this.calculatedItemWidth) && this.allowMultiple) {
+    if (this.rootElement) {
+      if ((!this.calculatedGapBetweenItems || !this.calculatedItemWidth) && this.allowMultiple) {
         const fileListSelector = this.getFileListSelector();
         const fileListElement = fileListSelector ? this.rootElement.querySelector(this.getFileListSelector()) : undefined;
-        if(fileListElement) {
+        if (fileListElement) {
           this.calculatedGapBetweenItems = Math.ceil(Number.parseFloat(window.getComputedStyle(fileListElement).gap));
           const firstVisibleItem = Array.from(fileListElement.children).filter((_, index) => this.isPreviewVisible(index))[0];
-          if(firstVisibleItem) {
+          if (firstVisibleItem) {
             this.calculatedItemWidth = Math.ceil(Number.parseFloat(window.getComputedStyle(firstVisibleItem).width));
           }
         }
       }
     }
-    if(this.calculatedGapBetweenItems && this.calculatedItemWidth) {
+    if (this.calculatedGapBetweenItems && this.calculatedItemWidth) {
       this.pageSize = this.calcAvailableItemsCount(availableWidth, this.calculatedItemWidth, this.calculatedGapBetweenItems);
       return true;
     }
@@ -973,7 +987,7 @@ export class QuestionFileModel extends QuestionFileModelBase {
     if (this.canDragDrop()) {
       event.preventDefault();
       this.isDragging = true;
-      this.dragCounter ++;
+      this.dragCounter++;
     }
   }
   onDragOver = (event: any) => {
@@ -995,8 +1009,8 @@ export class QuestionFileModel extends QuestionFileModelBase {
   }
   onDragLeave = (event: any) => {
     if (this.canDragDrop()) {
-      this.dragCounter --;
-      if(this.dragCounter === 0) {
+      this.dragCounter--;
+      if (this.dragCounter === 0) {
         this.isDragging = false;
       }
     }
@@ -1013,9 +1027,9 @@ export class QuestionFileModel extends QuestionFileModelBase {
     this.clearFilesCore();
   }
   private clearFilesCore(): void {
-    if(this.rootElement) {
+    if (this.rootElement) {
       const input = this.rootElement.querySelectorAll("input")[0];
-      if(input) {
+      if (input) {
         input.value = "";
       }
     }
@@ -1103,7 +1117,7 @@ export class FileLoader {
               name: value.name,
               type: value.type,
             };
-            downloadedCount ++;
+            downloadedCount++;
             if (downloadedCount === files.length) {
               this.callback("loaded", this.loaded);
             }

src/react/components/file/file-choose-button.tsx

@@ -19,6 +19,7 @@ export class SurveyFileChooseButton extends ReactSurveyElement {
         className={this.question.getChooseFileCss()}
         htmlFor={this.question.inputId}
         aria-label={this.question.chooseButtonText}
+        onClick={() => this.question.chooseFile()}
       >
         {(!!this.question.cssClasses.chooseFileIconId) ? <SvgIcon title={this.question.chooseButtonText} iconName={this.question.cssClasses.chooseFileIconId} size={"auto"}></SvgIcon>: null }
         <span>{this.question.chooseButtonText}</span>

src/survey-events-api.ts

@@ -504,6 +504,25 @@ export interface UploadFilesEvent extends LoadFilesEvent {
    */
   files: Array<File>;
 }
+export interface OpenFileChooserEvent {
+  /**
+   * A file input HTML element.
+   */
+  input: HTMLInputElement;
+  /**
+   * A question, panel, page, or survey for which this event is raised.
+   */
+  element: Base;
+  /**
+   * A choice item for which the event is raised. This parameter has a value only when the dialog window is opened to select images for an [Image Picker](https://surveyjs.io/form-library/documentation/api-reference/image-picker-question-model) question.
+   */
+  item: ItemValue;
+  /**
+   * A callback function to which you should pass selected files.
+   * @param files An array of selected files.
+   */
+  callback: (files: Array<File>) => void;
+}
 export interface DownloadFileEvent extends LoadFilesEvent {
   /**
    * A callback function that you should call when a file is downloaded successfully or when deletion fails. Pass `"success"` or `"error"` as the first argument to indicate the operation status. As the second argument, you can pass the downloaded file's data as a Base64 string if file download was successful or an error message if file download failed.

src/survey.ts

@@ -44,7 +44,7 @@ import {
 } from "./expressionItems";
 import { ExpressionRunner, ConditionRunner } from "./conditions";
 import { settings } from "./settings";
-import { isContainerVisible, isMobile, mergeValues, scrollElementByChildId, navigateToUrl, getRenderedStyleSize, getRenderedSize, wrapUrlForBackgroundImage } from "./utils/utils";
+import { isContainerVisible, isMobile, mergeValues, scrollElementByChildId, navigateToUrl, getRenderedStyleSize, getRenderedSize, wrapUrlForBackgroundImage, chooseFiles } from "./utils/utils";
 import { SurveyError } from "./survey-error";
 import { IAction, Action } from "./actions/action";
 import { ActionContainer } from "./actions/container";
@@ -64,7 +64,7 @@ import {
   MatrixCellValidateEvent, DynamicPanelModifiedEvent, DynamicPanelRemovingEvent, TimerPanelInfoTextEvent, DynamicPanelItemValueChangedEvent, DynamicPanelGetTabTitleEvent,
   DynamicPanelCurrentIndexChangedEvent, IsAnswerCorrectEvent, DragDropAllowEvent, ScrollingElementToTopEvent, GetQuestionTitleActionsEvent, GetPanelTitleActionsEvent,
   GetPageTitleActionsEvent, GetPanelFooterActionsEvent, GetMatrixRowActionsEvent, ElementContentVisibilityChangedEvent, GetExpressionDisplayValueEvent,
-  ServerValidateQuestionsEvent, MultipleTextItemAddedEvent, MatrixColumnAddedEvent, GetQuestionDisplayValueEvent, PopupVisibleChangedEvent, ChoicesSearchEvent
+  ServerValidateQuestionsEvent, MultipleTextItemAddedEvent, MatrixColumnAddedEvent, GetQuestionDisplayValueEvent, PopupVisibleChangedEvent, ChoicesSearchEvent, OpenFileChooserEvent
 } from "./survey-events-api";
 import { QuestionMatrixDropdownModelBase } from "./question_matrixdropdownbase";
 import { QuestionMatrixDynamicModel } from "./question_matrixdynamic";
@@ -443,6 +443,12 @@ export class SurveyModel extends SurveyElementCore
    * @see getResult
    */
   public onGetResult: EventBase<SurveyModel, GetResultEvent> = this.addEvent<SurveyModel, GetResultEvent>();
+  /**
+   * An event that is raised when Survey Creator opens a dialog window for users to select files.
+   * @see onUploadFile
+   * @see uploadFiles
+   */
+  public onOpenFileChooser: EventBase<SurveyModel, OpenFileChooserEvent> = this.addEvent<SurveyModel, OpenFileChooserEvent>();
   /**
    * An event that is raised when a File Upload or Signature Pad question starts to upload a file. Applies only if [`storeDataAsText`](https://surveyjs.io/form-library/documentation/api-reference/file-model#storeDataAsText) is `false`. Use this event to upload files to your server.
    *
@@ -5124,6 +5130,29 @@ export class SurveyModel extends SurveyElementCore
     }
   }
 
+  /**
+   * Opens a dialog window for users to select files.
+   * @param input A [file input HTML element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
+   * @param callback A callback function that you can use to process selected files. Accepts an array of JavaScript <a href="https://developer.mozilla.org/en-US/docs/Web/API/File" target="_blank">File</a> objects.
+   * @see onOpenFileChooser
+   * @see onUploadFile
+   */
+  public chooseFiles(
+    input: HTMLInputElement,
+    callback: (files: File[]) => void,
+    context?: { element: ISurveyElement, item?: any }
+  ) {
+    if (this.onOpenFileChooser.isEmpty) {
+      chooseFiles(input, callback);
+    } else {
+      this.onOpenFileChooser.fire(this, {
+        input: input,
+        element: context && context.element || this.survey,
+        item: context && context.item,
+        callback: callback
+      });
+    }
+  }
   /**
    * Uploads files to a server.
    *
@@ -6058,7 +6087,7 @@ export class SurveyModel extends SurveyElementCore
   }
   startLoadingFromJson(json?: any): void {
     super.startLoadingFromJson(json);
-    if(json && json.locale) {
+    if (json && json.locale) {
       this.locale = json.locale;
     }
   }