survey-react 1.9.31 → 1.9.34

package/survey.react.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey JavaScript library for React v1.9.31
+* Type definition for Survey JavaScript library for React v1.9.34
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
@@ -207,6 +207,7 @@ export interface ISize {
 export interface ISurveyTriggerOwner {
   getObjects(pages: any, questions: any): Array<any>;
   setCompleted(): any;
+  triggerExecuted(trigger: Trigger): void;
   setTriggerValue(name: string, value: any, isVariable: boolean): any;
   copyTriggerValue(name: string, fromName: string): any;
   focusQuestion(name: string): boolean;
@@ -654,6 +655,10 @@ export declare class Base {
   * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
   */
   getType(): string;
+  /*
+  * Use this method to find out if the current instance is of the given `typeName` or inherited from it.
+  */
+  isDescendantOf(typeName: string): boolean;
   getSurvey(isLive?: boolean): ISurvey;
   /*
   * Returns true if the question in design mode right now.
@@ -743,6 +748,9 @@ export declare class Base {
   */
   unRegisterFunctionOnPropertiesValueChanged(names: any, key?: string): void;
   createCustomLocalizableObj(name: string): void;
+  getLocale(): string;
+  getLocalizationString(strName: string): string;
+  getLocalizationFormatString(strName: string, args: any): string;
   protected createLocalizableString(name: string, owner: ILocalizableOwner, useMarkDown?: boolean, defaultStr?: string | boolean): LocalizableString;
   getLocalizableString(name: string): LocalizableString;
   getLocalizableStringText(name: string, defaultStr?: string): string;
@@ -1112,7 +1120,7 @@ export declare class PopupUtils {
   static updateVerticalPosition(targetRect: any, height: number, verticalPosition: any, showPointer: boolean, windowHeight: number): any;
   static calculatePopupDirection(verticalPosition: any, horizontalPosition: any): string;
   static calculatePointerTarget(targetRect: any, top: number, left: number, verticalPosition: any, horizontalPosition: any, marginLeft?: number, marginRight?: number): INumberPosition;
-  static updatePopupWidthBeforeShow(popupModel: any, e: any): void;
+  static updatePopupWidthBeforeShow(popupModel: any, target: JSX.Element, e: any): void;
 }
 export declare class ProcessValue {
   constructor();
@@ -1305,6 +1313,8 @@ export declare class SurveyError {
   getText(): string;
   getErrorType(): string;
   protected getDefaultText(): string;
+  protected getLocale(): string;
+  protected getLocalizationString(locStrName: string): string;
 }
 export declare class SurveyHeader extends React.Component<ISurveyHeaderProps, any> {
   constructor(props: ISurveyHeaderProps);
@@ -1325,7 +1335,9 @@ export declare class SurveyLocStringViewer extends React.Component<any, any> {
   componentDidMount(): void;
   componentWillUnmount(): void;
   componentDidUpdate(prevProps: any, prevState: any): void;
+  isRendering: boolean;
   render(): JSX.Element;
+  protected renderString(): JSX.Element;
 }
 export declare class SurveyNavigationBase extends React.Component<any, any> {
   constructor(props: any);
@@ -1701,7 +1713,7 @@ export declare class CustomError extends SurveyError {
   getErrorType(): string;
 }
 export declare class DragDropCore<T> extends Base {
-  constructor(surveyValue?: ISurvey, creator?: any);
+  constructor(surveyValue?: ISurvey, creator?: any, longTap?: boolean);
   isBottom: boolean;
   onGhostPositionChanged: EventBase<Base>;
   protected ghostPositionChanged(): void;
@@ -2418,6 +2430,7 @@ export declare class Popup extends SurveyElementBase<IPopupProps, any> {
   get model(): any;
   protected getStateElement(): any;
   componentDidMount(): void;
+  componentDidUpdate(prevProps: any, prevState: any): void;
   componentWillUnmount(): void;
   shouldComponentUpdate(nextProps: IPopupProps, nextState: any): boolean;
   render(): JSX.Element;
@@ -2452,8 +2465,8 @@ export declare class PopupBaseViewModel extends Base {
   clickOutside(): void;
   cancel(): void;
   apply(): void;
-  get cancelButtonText(): any;
-  get applyButtonText(): any;
+  get cancelButtonText(): string;
+  get applyButtonText(): string;
   dispose(): void;
   initializePopupContainer(): void;
   unmountPopupContainer(): void;
@@ -2492,10 +2505,10 @@ export declare class PopupModel<T = any> extends Base {
   title: string;
   displayMode: "popup" | "overlay";
   widthMode: "contentWidth" | "fixedWidth";
+  onVisibilityChanged: EventBase<PopupModel<any>>;
   get isVisible(): boolean;
   set isVisible(val: boolean);
   toggleVisibility(): void;
-  onVisibilityChanged: (isVisible: boolean) => void;
 }
 export declare class QuestionMatrixDropdownRenderedRow extends Base {
   constructor(cssClasses: any, isDetailRow?: boolean);
@@ -2971,6 +2984,7 @@ export declare class Trigger extends Base {
   check(value: any): void;
   protected onSuccess(values: any, properties: any): void;
   protected onFailure(): void;
+  protected onSuccessExecuted(): void;
   endLoadingFromJson(): void;
   buildExpression(): string;
 }
@@ -3067,7 +3081,7 @@ export declare class ChoicesRestfull extends ChoicesRestful {
   static set onBeforeSendRequest(val: (sender: ChoicesRestful, options: any) => void);
 }
 export declare class DragDropChoices extends DragDropCore<QuestionSelectBase> {
-  constructor(surveyValue?: ISurvey, creator?: any);
+  constructor(surveyValue?: ISurvey, creator?: any, longTap?: boolean);
   protected get draggedElementType(): string;
   protected createDraggedElementShortcut(text: string, draggedElementNode: any, event: any): any;
   protected findDropTargetNodeByDragOverNode(dragOverNode: any): any;
@@ -3079,7 +3093,7 @@ export declare class DragDropChoices extends DragDropCore<QuestionSelectBase> {
   protected doClear(): void;
 }
 export declare class DragDropMatrixRows extends DragDropCore<QuestionMatrixDynamicModel> {
-  constructor(surveyValue?: ISurvey, creator?: any);
+  constructor(surveyValue?: ISurvey, creator?: any, longTap?: boolean);
   protected get draggedElementType(): string;
   protected createDraggedElementShortcut(text: string, draggedElementNode: any, event: any): any;
   fromIndex: number;
@@ -3093,7 +3107,7 @@ export declare class DragDropMatrixRows extends DragDropCore<QuestionMatrixDynam
   protected doClear(): void;
 }
 export declare class DragDropSurveyElements extends DragDropCore<any> {
-  constructor(surveyValue?: ISurvey, creator?: any);
+  constructor(surveyValue?: ISurvey, creator?: any, longTap?: boolean);
   static newGhostPage: PageModel;
   static restrictDragQuestionBetweenPages: boolean;
   static edgeHeight: number;
@@ -3132,7 +3146,7 @@ export declare class EmailValidator extends SurveyValidator {
   re: any;
   getType(): string;
   validate(value: any, name?: string, values?: any, properties?: any): ValidatorResult;
-  protected getDefaultErrorText(name: string): any;
+  protected getDefaultErrorText(name: string): string;
 }
 /*
 * Show error if expression returns false
@@ -3147,7 +3161,7 @@ export declare class ExpressionValidator extends SurveyValidator {
   get isRunning(): boolean;
   validate(value: any, name?: string, values?: any, properties?: any): ValidatorResult;
   protected generateError(res: boolean, value: any, name: string): ValidatorResult;
-  protected getDefaultErrorText(name: string): any;
+  protected getDefaultErrorText(name: string): string;
   protected ensureConditionRunner(): boolean;
   /*
   * The expression property.
@@ -3213,7 +3227,7 @@ export declare class ListModel extends ActionContainer {
   isItemSelected: (itemValue: Action) => boolean;
   getItemClass: (itemValue: Action) => string;
   getItemIndent: (itemValue: any) => string;
-  get filteredTextPlaceholder(): any;
+  get filteredTextPlaceholder(): string;
   onKeyDown(event: any): void;
   onPointerDown(event: any, item: any): void;
   refresh(): void;
@@ -3255,7 +3269,7 @@ export declare class NumericValidator extends SurveyValidator {
   constructor(minValue?: number, maxValue?: number);
   getType(): string;
   validate(value: any, name?: string, values?: any, properties?: any): ValidatorResult;
-  protected getDefaultErrorText(name: string): any;
+  protected getDefaultErrorText(name: string): string;
   /*
   * The minValue property.
   */
@@ -3475,7 +3489,9 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   protected setPage(parent: IPanel, newPage: IPage): void;
   protected getSearchableLocKeys(keys: any): void;
   protected get isDefaultV2Theme(): boolean;
+  get showErrorsAboveQuestion(): boolean;
   get isErrorsModeTooltip(): boolean;
+  protected getIsErrorsModeTooltip(): boolean;
   get hasParent(): boolean;
   protected get hasFrameV2(): boolean;
   /*
@@ -3550,11 +3566,16 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   valuesHash: any;
   variablesHash: any;
   editingObjValue: Base;
-  localeValue: string;
   textPreProcessor: TextPreProcessor;
   timerModelValue: SurveyTimerModel;
   navigationBarValue: any;
   /*
+  * The event is fired after a trigger has been executed
+  * <br/> `sender` - the survey object that fires the event.
+  * <br/> `options.trigger` - An instance of a trigger that has been just perform it's action.
+  */
+  onTriggerExecuted: EventBase<SurveyModel>;
+  /*
   * The event is fired before the survey is completed and the `onComplete` event is fired. You can prevent the survey from completing by setting `options.allowComplete` to `false`
   * <br/> `sender` - the survey object that fires the event.
   * <br/> `options.allowComplete` - Specifies whether a user can complete a survey. Set this property to `false` to prevent the survey from completing. The default value is `true`.
@@ -4445,7 +4466,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   getRendererContextForString(element: Base, locStr: LocalizableString): LocalizableString;
   getExpressionDisplayValue(question: IQuestion, value: any, displayValue: string): string;
   getProcessedText(text: string): string;
-  getLocString(str: string): any;
+  getLocString(str: string): string;
   getErrorCustomText(text: string, error: SurveyError): string;
   getSurveyErrorCustomText(obj: Base, text: string, error: SurveyError): string;
   /*
@@ -5348,6 +5369,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   getObjects(pages: any, questions: any): Array<any>;
   setTriggerValue(name: string, value: any, isVariable: boolean): void;
   copyTriggerValue(name: string, fromName: string): void;
+  triggerExecuted(trigger: Trigger): void;
   isFocusingQuestion: boolean;
   isMovingQuestion: boolean;
   startMovingQuestion(): void;
@@ -5695,6 +5717,7 @@ export declare class SurveyTrigger extends Trigger {
   setOwner(owner: ISurveyTriggerOwner): void;
   getSurvey(live?: boolean): ISurvey;
   get isOnNextPage(): boolean;
+  protected onSuccessExecuted(): void;
 }
 export declare class SurveyWindow extends Survey {
   constructor(props: any);
@@ -5714,7 +5737,7 @@ export declare class TextValidator extends SurveyValidator {
   constructor();
   getType(): string;
   validate(value: any, name?: string, values?: any, properties?: any): ValidatorResult;
-  protected getDefaultErrorText(name: string): any;
+  protected getDefaultErrorText(name: string): string;
   /*
   * The minLength property.
   */
@@ -5759,7 +5782,7 @@ export declare class Variable extends Const {
   protected isContentEqual(op: Operand): boolean;
 }
 export declare class DragDropRankingChoices extends DragDropChoices {
-  constructor(surveyValue?: ISurvey, creator?: any);
+  constructor(surveyValue?: ISurvey, creator?: any, longTap?: boolean);
   protected get draggedElementType(): string;
   protected createDraggedElementShortcut(text: string, draggedElementNode: any, event: any): any;
   protected getDropTargetByDataAttributeValue(dataAttributeValue: string): ItemValue;
@@ -5975,6 +5998,7 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
   protected onAddElement(element: IElement, index: number): void;
   protected onRemoveElement(element: IElement): void;
   protected canRenderFirstRows(): boolean;
+  protected getDragDropInfo(): any;
   protected updateRowsRemoveElementFromRow(element: IElement, row: QuestionRowModel): void;
   elementWidthChanged(el: IElement): void;
   /*
@@ -6307,6 +6331,10 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   get cssDescription(): string;
   protected setCssDescription(val: string): void;
   protected getCssDescription(cssClasses: any): string;
+  protected getIsErrorsModeTooltip(): boolean;
+  showErrorOnCore(location: string): boolean;
+  get showErrorOnTop(): boolean;
+  get showErrorOnBottom(): boolean;
   get cssError(): string;
   protected setCssError(val: string): void;
   protected getCssError(cssClasses: any): string;
@@ -6325,6 +6353,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   protected fireCallback(callback: any): void;
   getOthersMaxLength(): any;
   protected onCreating(): void;
+  getFirstQuestionToFocus(withError: boolean): Question;
   protected getFirstInputElementId(): string;
   protected getFirstErrorInputElementId(): string;
   protected getProcessedTextValue(textValue: TextPreProcessorValue): void;
@@ -6653,6 +6682,7 @@ export declare class SurveyQuestionCustom extends SurveyQuestionUncontrolledElem
 }
 export declare class SurveyQuestionDropdownBase<T> extends SurveyQuestionUncontrolledElement<T> {
   constructor(props: any);
+  onClick: (event: any) => void;
   protected setValueCore(newValue: any): void;
   protected getValueCore(): any;
   protected renderSelect(cssClasses: any): JSX.Element;
@@ -6849,6 +6879,7 @@ export declare class PageModel extends PanelModelBase implements IPage {
   protected onNumChanged(value: number): void;
   protected onVisibleChanged(): void;
   dragDropInfo: DragDropInfo;
+  protected getDragDropInfo(): any;
   dragDropStart(src: IElement, target: IElement, nestedPanelDepth?: number): void;
   dragDropMoveTo(destination: ISurveyElement, isBottom?: boolean, isEdge?: boolean): boolean;
   dragDropFinish(isCancel?: boolean): IElement;
@@ -7270,6 +7301,11 @@ export declare class QuestionFileModel extends Question {
   * Clear value programmatically.
   */
   clear(doneCallback?: any): void;
+  get multipleRendered(): string;
+  get showRemoveButton(): any;
+  get showRemoveButtonBottom(): any;
+  defaultImage(data: any): boolean;
+  get imageWidthRendered(): string;
   /*
   * Remove file item programmatically.
   */
@@ -7457,6 +7493,7 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
   panelCountChangedCallback: any;
   currentIndexChangedCallback: any;
   get hasSingleInput(): boolean;
+  getFirstQuestionToFocus(withError: boolean): Question;
   setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
   getType(): string;
   get isCompositeQuestion(): boolean;
@@ -7775,6 +7812,7 @@ export declare class QuestionRatingModel extends Question {
   get renderedRateItems(): any;
   getType(): string;
   protected getFirstInputElementId(): string;
+  getInputId(index: number): string;
   supportGoNextPageAutomatic(): boolean;
   supportComment(): boolean;
   supportOther(): boolean;
@@ -8000,6 +8038,7 @@ export declare class QuestionSelectBase extends Question {
   protected updateVisibleChoices(): void;
   protected canUseFilteredChoices(): boolean;
   setCanShowOptionItemCallback(func: (item: ItemValue) => boolean): void;
+  get newItem(): ItemValue;
   protected addToVisibleChoices(items: any, isAddAll: boolean): void;
   protected canShowOptionItem(item: ItemValue, isAddAll: boolean, hasItem: boolean): boolean;
   /*
@@ -8280,7 +8319,6 @@ export declare class QuestionCompositeModel extends QuestionCustomModelBase {
   textProcessing: QuestionCompositeTextProcessor;
   protected createWrapper(): void;
   getTemplate(): string;
-  protected getCssType(): string;
   protected getElement(): SurveyElement;
   get contentPanel(): PanelModel;
   hasErrors(fireCallback?: boolean, rec?: any): boolean;
@@ -8368,13 +8406,19 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
   */
   get autoComplete(): string;
   set autoComplete(val: string);
+  showClearButton: boolean;
+  itemComponent: string;
   denySearch: boolean;
   dropdownWidthMode: "contentWidth" | "editorWidth";
   getControlClass(): string;
   get readOnlyText(): any;
+  onClear(event: any): void;
   protected onVisibleChoicesChanged(): void;
   _popupModel: any;
   get popupModel(): any;
+  onOpened: EventBase<QuestionDropdownModel>;
+  onOpenedCallBack(): void;
+  onClick(event: any): void;
 }
 /*
 * A Model for html question. Unlike other questions it doesn't have value and title.
@@ -8630,6 +8674,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
   protected getIsRunningValidators(): boolean;
   getAllErrors(): Array<SurveyError>;
   protected getUniqueColumns(): Array<MatrixDropdownColumn>;
+  getFirstQuestionToFocus(withError: boolean): Question;
   protected getFirstInputElementId(): string;
   protected getFirstErrorInputElementId(): string;
   protected getFirstCellQuestion(onError: boolean): Question;
@@ -8841,6 +8886,7 @@ export declare class QuestionTextModel extends QuestionTextBase {
 export declare class SurveyQuestionDropdownSelect extends SurveyQuestionDropdown {
   constructor(props: any);
   protected renderSelect(cssClasses: any): JSX.Element;
+  createClearButton(): JSX.Element;
 }
 /*
 * A Model for a button group question.
@@ -9222,7 +9268,7 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
   get showClearButton(): boolean;
   set showClearButton(val: boolean);
   get canShowClearButton(): boolean;
-  get clearButtonCaption(): any;
+  get clearButtonCaption(): string;
   supportGoNextPageAutomatic(): boolean;
 }
 /*
@@ -9263,6 +9309,11 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
   setGhostText: (text: string) => void;
   getIconHoverCss(): string;
   getIconFocusCss(): string;
+  /*
+  * For mobile devices. Set this property to false, to disable the "long tap" before drag start. Default is true.
+  */
+  get longTap(): boolean;
+  set longTap(val: boolean);
 }
 export declare function property(options?: any): (target: any, key: string) => void;
 export declare function propertyArray(options?: IArrayPropertyDecoratorOptions): (target: any, key: string) => void;
@@ -9286,6 +9337,11 @@ export declare var settings: {
     caseSensitive: boolean,
   },
   /*
+  * Set this value to false, if you want to have UTC fuctions, for example setUTCHours inside our functions, like today.
+  * By default it uses setHours function, with local date
+  */
+  useLocalTimeZone: boolean,
+  /*
   * The prefix that uses to store the question comment, as {questionName} + {commentPrefix}.
   * The default
   */
@@ -9601,6 +9657,7 @@ export declare var defaultStandardCss: {
     rootRadio: string,
     item: string,
     control: string,
+    controlCheckbox: string,
     itemChecked: string,
     itemIndeterminate: string,
     itemDisabled: string,
@@ -9652,6 +9709,10 @@ export declare var defaultStandardCss: {
     control: string,
     selectWrapper: string,
     other: string,
+    cleanButton: string,
+    cleanButtonSvg: string,
+    cleanButtonIconId: string,
+    controlValue: string,
   },
   html: {
     root: string,
@@ -9959,6 +10020,7 @@ export declare var defaultBootstrapCss: {
     rootRadio: string,
     item: string,
     control: string,
+    controlCheckbox: string,
     itemChecked: string,
     itemIndeterminate: string,
     itemDisabled: string,
@@ -10279,6 +10341,7 @@ export declare var defaultBootstrapMaterialCss: {
     rootRadio: string,
     item: string,
     control: string,
+    controlCheckbox: string,
     itemChecked: string,
     itemIndeterminate: string,
     itemDisabled: string,
@@ -10637,7 +10700,6 @@ export declare var defaultV2Css: {
     footer: string,
     formGroup: string,
     hasError: string,
-    disabled: string,
     collapsed: string,
     nested: string,
     invisible: string,
@@ -10715,6 +10777,7 @@ export declare var defaultV2Css: {
     radioFieldset: string,
     itemOnError: string,
     control: string,
+    controlCheckbox: string,
     itemChecked: string,
     itemIndeterminate: string,
     itemDisabled: string,
@@ -10757,7 +10820,11 @@ export declare var defaultV2Css: {
     itemHover: string,
     itemControl: string,
     itemDecorator: string,
+    cleanButton: string,
+    cleanButtonSvg: string,
+    cleanButtonIconId: string,
     control: string,
+    controlValue: string,
     controlDisabled: string,
     controlEmpty: string,
     controlLabel: string,
@@ -10813,6 +10880,7 @@ export declare var defaultV2Css: {
     cell: string,
     headerCell: string,
     rowTextCell: string,
+    cellRequiredText: string,
     detailButton: string,
     detailButtonExpanded: string,
     detailIcon: string,
@@ -10832,6 +10900,7 @@ export declare var defaultV2Css: {
     cell: string,
     headerCell: string,
     rowTextCell: string,
+    cellRequiredText: string,
     button: string,
     detailRow: string,
     detailButton: string,
@@ -11189,6 +11258,7 @@ export declare var modernCss: {
     small: string,
     item: string,
     control: string,
+    controlCheckbox: string,
     itemChecked: string,
     itemIndeterminate: string,
     itemDisabled: string,
@@ -11201,6 +11271,9 @@ export declare var modernCss: {
     checkedPath: string,
     uncheckedPath: string,
     indeterminatePath: string,
+    svgIconCheckedId: string,
+    svgIconUncheckedId: string,
+    svgIconIndId: string,
   },
   text: {
     root: string,
@@ -11222,6 +11295,10 @@ export declare var modernCss: {
     selectWrapper: string,
     other: string,
     onError: string,
+    cleanButton: string,
+    cleanButtonSvg: string,
+    cleanButtonIconId: string,
+    controlValue: string,
   },
   imagepicker: {
     root: string,