survey-react 1.9.53 → 1.9.54

package/survey.react.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey JavaScript library for React v1.9.53
+* Type definition for Survey JavaScript library for React v1.9.54
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
@@ -891,11 +891,11 @@ export declare class Base {
   protected runConditionCore(values: any, properties: any): void;
   protected canRunConditions(): boolean;
   /*
-  * Register a function that will be called on a property value changed from the propertyNames list.
+  * Registers a function to call when a property value changes.
   */
   registerPropertyChangedHandlers(propertyNames: any, handler: any, key?: string): void;
   /*
-  * Unregister notification on property value changed for all properties in the propetyNames list.
+  * Unregisters value change event handlers for the specified properties.
   */
   unregisterPropertyChangedHandlers(propertyNames: any, key?: string): void;
   registerFunctionOnPropertyValueChanged(name: string, func: any, key?: string): void;
@@ -3725,7 +3725,7 @@ export declare class SurveyCustomWidget extends SurveyQuestionElementBase {
 /*
 * A base class for all survey elements.
 */
-export declare class SurveyElement extends SurveyElementCore implements ISurveyElement {
+export declare class SurveyElement<E = any> extends SurveyElementCore implements ISurveyElement {
   constructor(name: string);
   stateChangedCallback: any;
   static getProgressInfoByElements(children: any, isRequired: boolean): IProgressInfo;
@@ -3733,7 +3733,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   surveyDataValue: ISurveyData;
   surveyValue: ISurvey;
   textProcessorValue: ITextProcessor;
-  selectedElementInDesignValue: SurveyElement;
+  selectedElementInDesignValue: any;
   dragTypeOverMe: DragTypeOverMeEnum;
   isDragMe: boolean;
   readOnlyChangedCallback: any;
@@ -3744,6 +3744,15 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   disableDesignActions: boolean;
   protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
   protected getSkeletonComponentNameCore(): string;
+  parentQuestionValue: any;
+  /*
+  * A Dynamic Panel, Dynamic Matrix, or Dropdown Matrix that includes the current question.
+  * 
+  * This property is `null` for standalone questions.
+  */
+  get parentQuestion(): any;
+  setParentQuestion(val: any): void;
+  protected onParentQuestionChanged(): void;
   get skeletonComponentName(): string;
   /*
   * Gets and sets the survey element's expand state.
@@ -3863,8 +3872,8 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   get containsErrors(): boolean;
   updateContainsErrors(): void;
   protected getContainsErrors(): boolean;
-  get selectedElementInDesign(): SurveyElement;
-  set selectedElementInDesign(val: SurveyElement);
+  get selectedElementInDesign(): any;
+  set selectedElementInDesign(val: any);
   updateCustomWidgets(): void;
   onSurveyLoad(): void;
   onFirstRendering(): void;
@@ -3913,6 +3922,8 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   protected get isDefaultV2Theme(): boolean;
   get isErrorsModeTooltip(): boolean;
   protected getIsErrorsModeTooltip(): boolean;
+  protected getIsTooltipErrorSupportedByParent(): boolean;
+  protected getIsTooltipErrorInsideSupported(): boolean;
   get hasParent(): boolean;
   isSingleInRow: boolean;
   protected get hasFrameV2(): boolean;
@@ -6287,7 +6298,7 @@ export declare class MultiSelectListModel extends ListModel {
 /*
 * A base class for a Panel and Page objects.
 */
-export declare class PanelModelBase extends SurveyElement implements IPanel, IConditionRunner, ISurveyErrorOwner, ITitleOwner {
+export declare class PanelModelBase extends SurveyElement<Question> implements IPanel, IConditionRunner, ISurveyErrorOwner, ITitleOwner {
   constructor(name?: string);
   static panelCounter: number;
   elementsValue: any;
@@ -6419,7 +6430,7 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
   protected hasErrorsCore(rec: any): void;
   protected getContainsErrors(): boolean;
   updateElementVisibility(): void;
-  getFirstQuestionToFocus(withError?: boolean): Question;
+  getFirstQuestionToFocus(withError?: boolean, ignoreCollapseState?: boolean): Question;
   /*
   * Call it to focus the input on the first question
   */
@@ -6549,7 +6560,7 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
 /*
 * A base class for all questions.
 */
-export declare class Question extends SurveyElement implements IQuestion, IConditionRunner, IValidatorOwner, ITitleOwner {
+export declare class Question extends SurveyElement<Question> implements IQuestion, IConditionRunner, IValidatorOwner, ITitleOwner {
   constructor(name: string);
   static TextPreprocessorValuesMap: any;
   static questionCounter: number;
@@ -6696,15 +6707,6 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   */
   get parent(): IPanel;
   set parent(val: IPanel);
-  parentQuestionValue: Question;
-  /*
-  * A Dynamic Panel, Dynamic Matrix, or Dropdown Matrix that includes the current question.
-  * 
-  * This property is `null` for standalone questions.
-  */
-  get parentQuestion(): Question;
-  setParentQuestion(val: Question): void;
-  protected onParentQuestionChanged(): void;
   protected onParentChanged(): void;
   /*
   * Returns `false` if the `titleLocation` property is set to `"hidden"` or if the question cannot have a title (for example, an [HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel) question).
@@ -6771,13 +6773,13 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   set requiredErrorText(val: string);
   get locRequiredErrorText(): LocalizableString;
   /*
-  * Specifies a caption displayed above the comment area. Applies when the `hasComment` property is `true`.
+  * Specifies a caption displayed above the comment area. Applies when the `showCommentArea` property is `true`.
   */
   get commentText(): string;
   set commentText(val: string);
   get locCommentText(): LocalizableString;
   /*
-  * A placeholder for the comment area. Applies when the `hasComment` property is `true`.
+  * A placeholder for the comment area. Applies when the `showCommentArea` property is `true`.
   */
   get commentPlaceholder(): string;
   set commentPlaceholder(val: string);
@@ -6828,6 +6830,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   showErrorOnCore(location: string): boolean;
   get showErrorOnTop(): boolean;
   get showErrorOnBottom(): boolean;
+  protected getIsTooltipErrorSupportedByParent(): boolean;
   get showErrorsAboveQuestion(): boolean;
   get showErrorsBelowQuestion(): boolean;
   get cssError(): string;
@@ -6883,7 +6886,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   get ariaTitleId(): string;
   get ariaRole(): string;
   /*
-  * Specifies whether to display the "Other" choice item. Incompatible with the `hasComment` property.
+  * Specifies whether to display the "Other" choice item. Incompatible with the `showCommentArea` property.
   */
   get showOtherItem(): boolean;
   set showOtherItem(val: boolean);
@@ -7017,7 +7020,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   protected isValueExpression(val: any): boolean;
   protected setValueAndRunExpression(runner: ExpressionRunner, defaultValue: any, setFunc: (val: any) => void, values?: any, properties?: any): void;
   /*
-  * A comment to the selected question value. Enable the `hasComment` property to allow users to leave comments.
+  * A comment to the selected question value. Enable the `showCommentArea` property to allow users to leave comments.
   */
   get comment(): string;
   set comment(val: string);
@@ -7256,6 +7259,7 @@ export declare class SurveyTriggerComplete extends SurveyTrigger {
 */
 export declare class SurveyTriggerCopyValue extends SurveyTrigger {
   constructor();
+  protected canBeExecuted(isOnNextPage: boolean): boolean;
   get setToName(): string;
   set setToName(val: string);
   get fromName(): string;
@@ -7281,6 +7285,7 @@ export declare class SurveyTriggerRunExpression extends SurveyTrigger {
 export declare class SurveyTriggerSetValue extends SurveyTrigger {
   constructor();
   getType(): string;
+  protected canBeExecuted(isOnNextPage: boolean): boolean;
   protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
   get setToName(): string;
   set setToName(val: string);
@@ -7511,9 +7516,6 @@ export declare class QuestionBooleanModel extends Question {
   */
   get booleanValue(): any;
   set booleanValue(val: any);
-  /*
-  * Obsolete, please use booleanValue property
-  */
   get checkedValue(): any;
   set checkedValue(val: any);
   get defaultValue(): any;
@@ -7580,7 +7582,7 @@ export declare class QuestionCustomModelBase extends Question implements ISurvey
   itemValuePropertyChanged(item: ItemValue, name: string, oldValue: any, newValue: any): void;
   onFirstRendering(): void;
   protected getElement(): SurveyElement;
-  protected initElement(el: SurveyElement): void;
+  protected initElement(el: any): void;
   setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
   onSurveyLoad(): void;
   afterRenderQuestionElement(el: any): void;
@@ -7701,16 +7703,21 @@ export declare class QuestionExpressionModel extends Question {
   protected getValueAsStr(val: any): string;
 }
 /*
-* A Model for a file question
+* A class that describes the File question type.
+* 
+* [View Demo](https://surveyjs.io/form-library/examples/questiontype-file/ (linkStyle))
 */
 export declare class QuestionFileModel extends Question {
   constructor(name: string);
   isUploading: boolean;
   isDragging: boolean;
   /*
-  * The event is fired after question state has been changed.
-  * sender the question object that fires the event
-  * options.state new question state value.
+  * An event that is raised after the upload state has changed.
+  * 
+  * Parameters:
+  * 
+  * - `sender` - A question instance that raised the event.
+  * - `options.state` - Current upload state: `"empty"`, `"loading"`, `"loaded"`, or `"error"`.
   */
   onStateChanged: EventBase<QuestionFileModel>;
   previewValue: any;
@@ -7718,21 +7725,25 @@ export declare class QuestionFileModel extends Question {
   indexToShow: number;
   containsMultiplyFiles: boolean;
   mobileFileNavigator: any;
-  prevFileAction: Action;
-  nextFileAction: Action;
-  fileIndexAction: Action;
+  protected prevFileAction: Action;
+  protected nextFileAction: Action;
+  protected fileIndexAction: Action;
   get mobileFileNavigatorVisible(): boolean;
   protected updateElementCssCore(cssClasses: any): void;
   isPreviewVisible(index: number): boolean;
   getType(): string;
   clearOnDeletingContainer(): void;
   /*
-  * Set it to true, to show the preview for the image files.
+  * Disable this property only to implement a custom preview.
+  * 
+  * [View "Custom Preview" Demo](https://surveyjs.io/form-library/examples/file-custom-preview/ (linkStyle))
   */
   get showPreview(): boolean;
   set showPreview(val: boolean);
   /*
-  * Set it to true, to allow select multiple files.
+  * Specifies whether users can upload multiple files.
+  * 
+  * Default value: `false`
   */
   get allowMultiple(): boolean;
   set allowMultiple(val: boolean);
@@ -7747,98 +7758,72 @@ export declare class QuestionFileModel extends Question {
   get imageWidth(): string;
   set imageWidth(val: string);
   /*
-  * Accepted file types. Passed to the 'accept' attribute of the file input tag. See https://www.w3schools.com/tags/att_input_accept.asp for more details.
+  * An [accept](https://www.w3schools.com/tags/att_input_accept.asp) attribute value for the underlying `<input>` element.
   */
   get acceptedTypes(): string;
   set acceptedTypes(val: string);
   /*
-  * Set it to false if you do not want to serialize file content as text in the survey.data.
-  * In this case, you have to write the code onUploadFiles event to store the file content.
+  * Specifies whether to store file content as text in `SurveyModel`'s [`data`](https://surveyjs.io/form-library/documentation/surveymodel#data) property.
+  * 
+  * If you disable this property, implement `SurveyModel`'s [`onUploadFiles`](https://surveyjs.io/form-library/documentation/surveymodel#onUploadFiles) event handler to specify how to store file content.
   */
   get storeDataAsText(): boolean;
   set storeDataAsText(val: boolean);
   /*
-  * Set it to true if you want to wait until files will be uploaded to your server.
+  * Enable this property if you want to wait until files are uploaded to complete the survey.
+  * 
+  * Default value: `false`
   */
   get waitForUpload(): boolean;
   set waitForUpload(val: boolean);
   /*
-  * Set it to false if you want to disable images preview.
+  * Specifies whether to show a preview of image files.
   */
   get allowImagesPreview(): boolean;
   set allowImagesPreview(val: boolean);
   /*
-  * Use this property to setup the maximum allowed file size.
+  * Maximum allowed file size, measured in bytes.
+  * 
+  * Default value: 0 (unlimited)
   */
   get maxSize(): number;
   set maxSize(val: number);
   /*
-  * Use this property to setup confirmation to remove file.
+  * Specifies whether users should confirm file deletion.
+  * 
+  * Default value: `false`
   */
   get needConfirmRemoveFile(): boolean;
   set needConfirmRemoveFile(val: boolean);
-  /*
-  * The remove file confirmation message.
-  */
   getConfirmRemoveMessage(fileName: string): string;
-  /*
-  * The remove file confirmation message template.
-  */
   get confirmRemoveMessage(): string;
   set confirmRemoveMessage(val: string);
   get locConfirmRemoveMessage(): LocalizableString;
-  /*
-  * The remove all files confirmation message.
-  */
   get confirmRemoveAllMessage(): string;
   set confirmRemoveAllMessage(val: string);
   get locConfirmRemoveAllMessage(): LocalizableString;
-  /*
-  * The no file chosen caption for modern theme.
-  */
   get noFileChosenCaption(): string;
   set noFileChosenCaption(val: string);
   get locNoFileChosenCaption(): LocalizableString;
-  /*
-  * The choose files button caption for modern theme.
-  */
   get chooseButtonCaption(): string;
   set chooseButtonCaption(val: string);
   get locChooseButtonCaption(): LocalizableString;
-  /*
-  * The clean files button caption.
-  */
-  get cleanButtonCaption(): string;
-  set cleanButtonCaption(val: string);
-  get locCleanButtonCaption(): LocalizableString;
-  /*
-  * The remove file button caption.
-  */
+  get clearButtonCaption(): string;
+  set clearButtonCaption(val: string);
+  get locClearButtonCaption(): LocalizableString;
   get removeFileCaption(): string;
   set removeFileCaption(val: string);
   get locRemoveFileCaption(): LocalizableString;
-  /*
-  * The loading file input title.
-  */
   get loadingFileTitle(): string;
   set loadingFileTitle(val: string);
   get locLoadingFileTitle(): LocalizableString;
-  /*
-  * The choose file input title.
-  */
   get chooseFileTitle(): string;
   set chooseFileTitle(val: string);
   get locChooseFileTitle(): LocalizableString;
   get dragAreaPlaceholder(): string;
   set dragAreaPlaceholder(val: string);
   get locDragAreaPlaceholder(): LocalizableString;
-  /*
-  * The input title value.
-  */
   get inputTitle(): string;
-  /*
-  * Clear value programmatically.
-  */
   clear(doneCallback?: any): void;
   get multipleRendered(): string;
   get showRemoveButton(): any;
@@ -7846,12 +7831,12 @@ export declare class QuestionFileModel extends Question {
   defaultImage(data: any): boolean;
   get imageWidthRendered(): string;
   /*
-  * Remove file item programmatically.
+  * Removes a file with a specified name.
   */
   removeFile(name: string): void;
   protected removeFileByContent(content: any): void;
   /*
-  * Load multiple files programmatically.
+  * Loads multiple files into the question.
   */
   loadFiles(files: any): void;
   canPreviewImage(fileItem: any): boolean;
@@ -7865,6 +7850,10 @@ export declare class QuestionFileModel extends Question {
   getReadOnlyFileCss(): string;
   get fileRootCss(): string;
   getFileDecoratorCss(): string;
+  rootElement: any;
+  afterRender(el: any): void;
+  dragCounter: number;
+  onDragEnter: (event: any) => void;
   onDragOver: (event: any) => boolean;
   onDrop: (event: any) => void;
   onDragLeave: (event: any) => void;
@@ -8013,9 +8002,12 @@ export declare class QuestionMultipleTextModel extends Question implements IMult
   getItemLabelCss(item: MultipleTextItemModel): string;
   getItemCss(): string;
   getItemTitleCss(): string;
+  protected getIsTooltipErrorInsideSupported(): boolean;
 }
 /*
-* A Model for non value question. This question doesn't add any new functionality. It hides some properties, including the value.
+* A base class for question types that cannot have a value ([Html](https://surveyjs.io/form-library/documentation/questionhtmlmodel), [Image](https://surveyjs.io/form-library/documentation/questionimagemodel)).
+* 
+* This class does not implement new functionality&mdash;it only redefines default values of certain properties inherited from the [`Question`](https://surveyjs.io/form-library/documentation/question) class.
 */
 export declare class QuestionNonValue extends Question {
   constructor(name: string);
@@ -8618,7 +8610,7 @@ export declare class QuestionSelectBase extends Question {
   */
   separateSpecialChoices: boolean;
   /*
-  * A placeholder for the comment area. Applies when the `hasOther` or `hasComment` property is `true`.
+  * A placeholder for the comment area. Applies when the `showOtherItem` or `showCommentArea` property is `true`.
   */
   get otherPlaceholder(): string;
   set otherPlaceholder(val: string);
@@ -8998,7 +8990,7 @@ export declare class QuestionCustomModel extends QuestionCustomModelBase {
   protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
   onSurveyValueChanged(newValue: any): void;
   protected getValueCore(): any;
-  protected initElement(el: SurveyElement): void;
+  protected initElement(el: any): void;
   updateElementCss(reNew?: boolean): void;
   protected updateElementCssCore(cssClasses: any): void;
   protected getDisplayValueCore(keyAsText: boolean, value: any): any;
@@ -9023,9 +9015,9 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
   get placeholder(): string;
   set placeholder(val: string);
   get locPlaceholder(): LocalizableString;
-  get cleanCaption(): string;
-  set cleanCaption(val: string);
-  get locCleanCaption(): LocalizableString;
+  get clearCaption(): string;
+  set clearCaption(val: string);
+  get locClearCaption(): LocalizableString;
   getType(): string;
   get selectedItem(): ItemValue;
   supportGoNextPageAutomatic(): boolean;
@@ -9129,9 +9121,9 @@ export declare class QuestionImageModel extends QuestionNonValue {
   /*
   * The image alt text.
   */
-  get text(): string;
-  set text(val: string);
-  get locText(): LocalizableString;
+  get altText(): string;
+  set altText(val: string);
+  get locAltText(): LocalizableString;
   /*
   * The image height.
   */
@@ -9420,6 +9412,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
   getRowHeaderWrapperComponentData(cell: MatrixDropdownCell): any;
   get showHorizontalScroll(): boolean;
   getRootCss(): string;
+  protected getIsTooltipErrorInsideSupported(): boolean;
 }
 /*
 * A Model for a simple matrix question.
@@ -10078,9 +10071,9 @@ export declare class QuestionTagboxModel extends QuestionCheckboxModel {
   get placeholder(): string;
   set placeholder(val: string);
   get locPlaceholder(): LocalizableString;
-  get cleanCaption(): string;
-  set cleanCaption(val: string);
-  get locCleanCaption(): LocalizableString;
+  get clearCaption(): string;
+  set clearCaption(val: string);
+  get locClearCaption(): LocalizableString;
   getType(): string;
   get popupModel(): any;
   getControlClass(): string;
@@ -10105,8 +10098,8 @@ export declare function getCurrecyCodes(): Array<any>;
 export declare function createPopupModalViewModel(options: IDialogOptions): PopupBaseViewModel;
 export declare function createPopupViewModel(model: any, targetElement: any): PopupBaseViewModel;
 export declare function checkLibraryVersion(ver: string, libraryName: string): void;
-export declare function showModal(componentName: string, data: any, onApply: any, onCancel?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): void;
-export declare function showDialog(dialogOptions: any): void;
+export declare function showModal(componentName: string, data: any, onApply: any, onCancel?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): PopupBaseViewModel;
+export declare function showDialog(dialogOptions: any): PopupBaseViewModel;
 export declare function attachKey2click(element: JSX.Element, viewModel?: any, options?: IAttachKey2clickOptions): JSX.Element;
 /*
 * Global survey settings
@@ -10835,6 +10828,7 @@ export declare var defaultBootstrapCss: {
     hasError: string,
     indent: number,
     formGroup: string,
+    disabled: string,
   },
   panel: {
     title: string,
@@ -11172,6 +11166,7 @@ export declare var defaultBootstrapMaterialCss: {
     hasError: string,
     indent: number,
     formGroup: string,
+    disabled: string,
   },
   panel: {
     title: string,
@@ -11450,6 +11445,7 @@ export declare var defaultBootstrapMaterialCss: {
 export declare var defaultV2Css: {
   root: string,
   rootMobile: string,
+  rootReadOnly: string,
   container: string,
   header: string,
   body: string,
@@ -11478,6 +11474,7 @@ export declare var defaultV2Css: {
     titleExpandable: string,
     titleExpanded: string,
     titleCollapsed: string,
+    titleDisabled: string,
     titleOnExpand: string,
     titleOnError: string,
     titleBar: string,
@@ -11567,6 +11564,7 @@ export declare var defaultV2Css: {
     titleExpandable: string,
     titleExpanded: string,
     titleCollapsed: string,
+    titleDisabled: string,
     titleBar: string,
     requiredText: string,
     number: string,
@@ -11585,6 +11583,7 @@ export declare var defaultV2Css: {
     nested: string,
     invisible: string,
     composite: string,
+    disabled: string,
   },
   image: {
     mainRoot: string,
@@ -11865,6 +11864,8 @@ export declare var defaultV2Css: {
     fileSign: string,
     fileList: string,
     fileSignBottom: string,
+    dragArea: string,
+    dragAreaActive: string,
     fileDecorator: string,
     onError: string,
     fileDecoratorDrag: string,