survey-react 1.9.18 → 1.9.21

package/survey.react.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey JavaScript library for React v1.9.18
+* Type definition for Survey JavaScript library for React v1.9.21
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
@@ -84,6 +84,40 @@ export interface IParseOptions {
   tracer?: any;
 }
 /*
+* Base interface for expression execution
+*/
+export interface IExpresionExecutor {
+  /*
+  * This call back runs on executing expression if there is at least one async function
+  */
+  onComplete: any;
+  /*
+  * The expression as string, property with get/set
+  */
+  expression: string;
+  /*
+  * Returns true if the expression is valid and can be executed
+  */
+  canRun(): boolean;
+  /*
+  * Run the expression. Returns the result of execution.
+  * The result can be undefined if there is an asyn function. In this case result will be returned onComplete callback.
+  */
+  run(values: any, properties: any): any;
+  /*
+  * Returns the list of variables that used in the expression. They defined as: {variableName} in default parser.
+  */
+  getVariables(): Array<any>;
+  /*
+  * Returns true if there is a function in the expression
+  */
+  hasFunction(): boolean;
+  /*
+  * Returns true if there is an async function in the expression
+  */
+  isAsync: boolean;
+}
+/*
 * Defines an individual action. Action items can be displayed in certain survey elements - in Toolbar (or action bar), in titles (of pages, panels, questions), in matrix rows (as 'expand details' or 'remove row' buttons), and etc.
 */
 export interface IAction {
@@ -176,6 +210,7 @@ export interface IAction {
   */
   mode?: "popup" | "large" | "small";
   visibleIndex?: number;
+  needSpace?: boolean;
 }
 export interface IDimensions {
   scroll: number;
@@ -544,6 +579,12 @@ export interface IListProps {
 export interface ILogoImageProps {
   data: any;
 }
+export declare class ActionDropdownViewModel {
+  constructor(item: Action);
+  popupModel: any;
+  funcKey: string;
+  dispose(): void;
+}
 export declare class ArrayChanges {
   constructor(index: number, deleteCount: number, itemsToAdd: any, deletedItems: any);
   index: number;
@@ -894,13 +935,7 @@ export declare class Event<T, Options> {
 }
 export declare class ExpressionRunnerBase {
   constructor(expression: string);
-  expressionValue: string;
-  operand: Operand;
-  processValue: ProcessValue;
-  parser: ConditionsParser;
-  isAsyncValue: boolean;
-  hasFunctionValue: boolean;
-  asyncFuncList: any;
+  expressionExecutor: IExpresionExecutor;
   get expression(): string;
   set expression(val: string);
   getVariables(): Array<any>;
@@ -1020,6 +1055,7 @@ export declare class MatrixCells {
   cellsOwner: IMatrixCellsOwner;
   values: any;
   get isEmpty(): boolean;
+  onValuesChanged: any;
   setCellText(row: any, column: any, val: string): void;
   setDefaultCellText(column: any, val: string): void;
   getCellLocText(row: any, column: any): LocalizableString;
@@ -1172,6 +1208,7 @@ export declare class ReactQuestionFactory {
 export declare class ReactSurveyElementsWrapper {
   static wrapRow(survey: any, element: any, row: any): any;
   static wrapElement(survey: any, element: any, question: any): any;
+  static wrapQuestionContent(survey: any, element: any, question: any): any;
   static wrapItemValue(survey: any, element: any, question: any, item: any): any;
   static wrapMatrixCell(survey: any, element: any, cell: any, reason?: string): any;
 }
@@ -1230,6 +1267,10 @@ export declare class SurveyElementBase<P, S> extends React.Component<P, S> {
   componentDidMount(): void;
   componentWillUnmount(): void;
   componentDidUpdate(prevProps: any, prevState: any): void;
+  _allowComponentUpdate: boolean;
+  protected allowComponentUpdate(): void;
+  protected denyComponentUpdate(): void;
+  shouldComponentUpdate(nextProps: any, nextState: any): boolean;
   render(): any;
   protected wrapElement(element: any): any;
   protected get isRendering(): boolean;
@@ -1320,6 +1361,7 @@ export declare class SvgIconRegistry {
   registerIconFromSymbol(iconId: string, iconSymbolSvg: string): void;
   registerIconFromSvgViaElement(iconId: string, iconSvg: string, iconPrefix?: string): void;
   registerIconFromSvg(iconId: string, iconSvg: string, iconPrefix?: string): boolean;
+  registerIconsFromFolder(r: any): void;
   iconsRenderedHtml(): any;
   renderIcons(): void;
 }
@@ -1432,6 +1474,7 @@ export declare class Action extends Base implements IAction {
   mode: "popup" | "large" | "small";
   disableTabStop: boolean;
   disableShrink: boolean;
+  needSpace: boolean;
   cssClassesValue: any;
   get cssClasses(): any;
   get disabled(): boolean;
@@ -1701,6 +1744,24 @@ export declare class ExceedSizeError extends SurveyError {
   getErrorType(): string;
   getDefaultText(): string;
 }
+export declare class ExpressionExecutor implements IExpresionExecutor {
+  static createExpressionExecutor: any;
+  onComplete: any;
+  expressionValue: string;
+  operand: Operand;
+  processValue: ProcessValue;
+  parser: ConditionsParser;
+  isAsyncValue: boolean;
+  hasFunctionValue: boolean;
+  asyncFuncList: any;
+  get expression(): string;
+  set expression(val: string);
+  getVariables(): Array<any>;
+  hasFunction(): boolean;
+  get isAsync(): boolean;
+  canRun(): boolean;
+  run(values: any, properties?: any): any;
+}
 /*
 * Base class for HtmlConditionItem and UrlConditionItem classes.
 */
@@ -2337,7 +2398,7 @@ export declare class Popup extends SurveyElementBase<IPopupProps, any> {
   protected getStateElement(): any;
   componentDidMount(): void;
   componentWillUnmount(): void;
-  shouldComponentUpdate(nextProps: IPopupProps): boolean;
+  shouldComponentUpdate(nextProps: IPopupProps, nextState: any): boolean;
   render(): any;
 }
 export declare class PopupBaseViewModel extends Base {
@@ -2735,8 +2796,10 @@ export declare class SurveyQuestion extends SurveyElementBase<any, any> {
   componentWillUnmount(): void;
   componentDidUpdate(prevProps: any, prevState: any): void;
   protected canRender(): boolean;
+  protected renderQuestionContent(): any;
   protected renderElement(): any;
   protected wrapElement(element: any): any;
+  protected wrapQuestionContent(element: any): any;
   protected renderQuestion(): any;
   protected renderDescription(cssClasses: any, isUnderInput?: boolean): any;
   protected renderComment(cssClasses: any): any;
@@ -2754,7 +2817,7 @@ export declare class SurveyQuestionElementBase extends SurveyElementBase<any, an
   protected getRenderedElement(): Base;
   protected get creator(): ISurveyCreator;
   protected canRender(): boolean;
-  shouldComponentUpdate(): boolean;
+  shouldComponentUpdate(nextProps: any, nextState: any): boolean;
   protected get isDisplayMode(): boolean;
   protected wrapCell(cell: any, element: any, reason: string): any;
 }
@@ -2919,7 +2982,7 @@ export declare class UploadingFileError extends SurveyError {
   protected getDefaultText(): string;
 }
 export declare class VerticalResponsivityManager extends ResponsivityManager {
-  constructor(container: any, model: any, itemsSelector: string, dotsItemSize?: number);
+  constructor(container: any, model: any, itemsSelector: string, dotsItemSize?: number, minDimension?: number);
   protected getDimensions(): IDimensions;
   protected getAvailableSpace(): number;
   protected calcItemSize(item: any): number;
@@ -3220,7 +3283,9 @@ export declare class RegexValidator extends SurveyValidator {
 }
 export declare class SurveyActionBarItemDropdown extends SurveyActionBarItem {
   constructor(props: any);
+  viewModel: any;
   renderButtonContent(): any;
+  componentWillUnmount(): void;
 }
 export declare class SurveyCustomWidget extends SurveyQuestionElementBase {
   constructor(props: any);
@@ -4392,6 +4457,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   get isLogoAfter(): boolean;
   get logoClassNames(): string;
   get renderedHasTitle(): boolean;
+  get renderedHasDescription(): boolean;
   get hasTitle(): boolean;
   get renderedHasLogo(): boolean;
   get renderedHasHeader(): boolean;
@@ -4931,12 +4997,15 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   isCalculatingProgressText: boolean;
   updateProgressText(onValueChanged?: boolean): void;
   getProgressText(): string;
+  getRootCss(): string;
+  resizeObserver: any;
   afterRenderSurvey(htmlElement: any): void;
   updateQuestionCssClasses(question: IQuestion, cssClasses: any): void;
   updatePanelCssClasses(panel: IPanel, cssClasses: any): void;
   updatePageCssClasses(page: IPage, cssClasses: any): void;
   updateChoiceItemCss(question: IQuestion, options: any): void;
   isFirstPageRendering: boolean;
+  isCurrentPageRendering: boolean;
   afterRenderPage(htmlElement: any): void;
   afterRenderHeader(htmlElement: any): void;
   afterRenderQuestion(question: IQuestion, htmlElement: any): void;
@@ -5150,17 +5219,25 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   processTextEx(text: string, returnDisplayValue: boolean, doEncoding: boolean): any;
   getSurveyMarkdownHtml(element: Base, text: string, name: string): string;
   /*
-  * Returns an amount of corrected quiz answers.
+  * Deprecated. Use the getCorrectAnswerCount method instead.
   */
   getCorrectedAnswerCount(): number;
   /*
+  * Returns an amount of corrected quiz answers.
+  */
+  getCorrectAnswerCount(): number;
+  /*
   * Returns quiz question number. It may be different from `getQuizQuestions.length` because some widgets like matrix may have several questions.
   */
   getQuizQuestionCount(): number;
   /*
-  * Returns an amount of incorrect quiz answers.
+  * Deprecated. Use the getInCorrectAnswerCount method instead.
   */
   getInCorrectedAnswerCount(): number;
+  /*
+  * Returns an amount of incorrect quiz answers.
+  */
+  getInCorrectAnswerCount(): number;
   getCorrectedAnswers(): number;
   getInCorrectedAnswers(): number;
   /*
@@ -5242,6 +5319,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   */
   focusQuestion(name: string): boolean;
   getElementWrapperComponentName(element: any, reason?: string): string;
+  getQuestionContentWrapperComponentName(element: any): string;
   getRowWrapperComponentName(row: QuestionRowModel): string;
   getElementWrapperComponentData(element: any, reason?: string): any;
   getRowWrapperComponentData(row: QuestionRowModel): any;
@@ -5317,9 +5395,13 @@ export declare class SurveyQuestionCheckbox extends SurveyQuestionElementBase {
   constructor(props: any);
   protected get question(): QuestionCheckboxModel;
   protected renderElement(): any;
+  protected getHeader(): any;
+  protected getFooter(): any;
+  protected getColumnedBody(cssClasses: any): any;
   protected getColumns(cssClasses: any): any;
   protected getItems(cssClasses: any): Array<any>;
   protected get textStyle(): any;
+  protected renderOther(): any;
   protected renderItem(key: string, item: any, isFirst: boolean, cssClasses: any, index: string): any;
 }
 export declare class SurveyQuestionCheckboxItem extends ReactSurveyElement {
@@ -5330,14 +5412,13 @@ export declare class SurveyQuestionCheckboxItem extends ReactSurveyElement {
   protected get textStyle(): any;
   protected get isFirst(): any;
   protected get index(): number;
-  shouldComponentUpdate(): boolean;
+  shouldComponentUpdate(nextProps: any, nextState: any): boolean;
   handleOnChange: any;
   selectAllChanged: any;
   protected canRender(): boolean;
   protected renderElement(): any;
   protected get inputStyle(): any;
   protected renderCheckbox(isChecked: boolean, otherItem: any): any;
-  protected renderOther(): any;
 }
 export declare class SurveyQuestionCommentItem extends ReactSurveyElement {
   constructor(props: any);
@@ -5457,10 +5538,6 @@ export declare class SurveyQuestionPanelDynamic extends SurveyQuestionElementBas
   protected get question(): any;
   componentDidMount(): void;
   componentWillUnmount(): void;
-  handleOnPanelAddClick(event: any): void;
-  handleOnPanelPrevClick(event: any): void;
-  handleOnPanelNextClick(event: any): void;
-  handleOnRangeChange(event: any): void;
   protected renderElement(): any;
   protected renderNavigator(): any;
   protected rendrerPrevButton(): any;
@@ -5470,6 +5547,10 @@ export declare class SurveyQuestionPanelDynamic extends SurveyQuestionElementBas
   protected renderNavigatorV2(): any;
   protected renderPlaceholder(): any;
 }
+export declare class SurveyQuestionPanelDynamicAction extends ReactSurveyElement {
+  constructor(props: any);
+  protected get question(): any;
+}
 export declare class SurveyQuestionRadioItem extends ReactSurveyElement {
   constructor(props: any);
   protected getStateElement(): Base;
@@ -5478,19 +5559,21 @@ export declare class SurveyQuestionRadioItem extends ReactSurveyElement {
   protected get textStyle(): any;
   protected get index(): number;
   protected get isChecked(): boolean;
-  shouldComponentUpdate(): boolean;
+  shouldComponentUpdate(nextProps: any, nextState: any): boolean;
   handleOnChange(event: any): void;
   protected canRender(): boolean;
   protected renderElement(): any;
-  protected renderOther(cssClasses: any): any;
 }
 export declare class SurveyQuestionRadiogroup extends SurveyQuestionElementBase {
   constructor(props: any);
   protected get question(): any;
   protected renderElement(): any;
+  protected getFooter(): any;
+  protected getColumnedBody(cssClasses: any): any;
   protected getColumns(cssClasses: any): any;
   protected getItems(cssClasses: any): Array<any>;
   protected get textStyle(): any;
+  protected renderOther(cssClasses: any): any;
 }
 export declare class SurveyQuestionRanking extends SurveyQuestionElementBase {
   constructor(props: any);
@@ -5613,7 +5696,7 @@ export declare class Variable extends Const {
 export declare class DragDropRankingChoices extends DragDropChoices {
   constructor(surveyValue?: ISurvey, creator?: any);
   protected get draggedElementType(): string;
-  protected createDraggedElementShortcut(text: string, draggedElementNode: any): any;
+  protected createDraggedElementShortcut(text: string, draggedElementNode: any, event: any): any;
   protected getDropTargetByDataAttributeValue(dataAttributeValue: string): ItemValue;
   isDragOverRootNode: boolean;
   protected findDropTargetNodeByDragOverNode(dragOverNode: any): any;
@@ -6418,6 +6501,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   protected supportResponsiveness(): boolean;
   resizeObserver: any;
   protected getCompactRenderAs(): string;
+  protected getDesktopRenderAs(): string;
   protected processResponsiveness(requiredWidth: number, availableWidth: number): void;
   dispose(): void;
 }
@@ -6491,6 +6575,11 @@ export declare class SurveyQuestionMatrixDynamic extends SurveyQuestionMatrixDro
   protected renderNoRowsContent(cssClasses: any): any;
   protected renderAddRowButton(cssClasses: any, isEmptySection?: boolean): any;
 }
+export declare class SurveyQuestionPanelDynamicAddButton extends SurveyQuestionPanelDynamicAction {
+  constructor(props: any);
+  protected handleClick: any;
+  protected renderElement(): any;
+}
 export declare class SurveyQuestionPanelDynamicItem extends SurveyPanel {
   constructor(props: any);
   protected getSurvey(): SurveyModel;
@@ -6499,6 +6588,20 @@ export declare class SurveyQuestionPanelDynamicItem extends SurveyPanel {
   render(): any;
   protected renderButton(): any;
 }
+export declare class SurveyQuestionPanelDynamicNextButton extends SurveyQuestionPanelDynamicAction {
+  constructor(props: any);
+  protected handleClick: any;
+  protected renderElement(): any;
+}
+export declare class SurveyQuestionPanelDynamicPrevButton extends SurveyQuestionPanelDynamicAction {
+  constructor(props: any);
+  protected handleClick: any;
+  protected renderElement(): any;
+}
+export declare class SurveyQuestionPanelDynamicProgressText extends SurveyQuestionPanelDynamicAction {
+  constructor(props: any);
+  protected renderElement(): any;
+}
 export declare class SurveyQuestionText extends SurveyQuestionUncontrolledElement<QuestionTextModel> {
   constructor(props: any);
   _isWaitingForEnter: boolean;
@@ -6598,6 +6701,7 @@ export declare class PageModel extends PanelModelBase implements IPage {
   get navigationDescription(): string;
   set navigationDescription(val: string);
   get locNavigationDescription(): LocalizableString;
+  navigationLocStrChanged(): void;
   get passed(): boolean;
   set passed(val: boolean);
   delete(): void;
@@ -7518,6 +7622,7 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
   getPlainData(options?: any): any;
   updateElementCss(reNew?: boolean): void;
   get progressText(): string;
+  get progress(): string;
   getRootCss(): string;
   getPanelWrapperCss(): string;
   getPanelRemoveButtonCss(): string;
@@ -7531,6 +7636,11 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
   set noEntriesText(val: string);
   get locNoEntriesText(): LocalizableString;
   getShowNoEntriesPlaceholder(): boolean;
+  needResponsiveWidth(): boolean;
+  footerToolbarValue: any;
+  get footerToolbar(): any;
+  legacyNavigation: boolean;
+  updateFooterActionsCallback: any;
 }
 /*
 * A Model for a rating question.
@@ -7594,11 +7704,13 @@ export declare class QuestionRatingModel extends Question {
   * are displayed as plain non-clickable texts.
   */
   displayRateDescriptionsAsExtremeItems: boolean;
+  useDropdown: "auto" | "always" | "never";
   protected valueToData(val: any): any;
   /*
   * Click value again to clear.
   */
   setValueFromClick(value: any): void;
+  get ratingRootCss(): string;
   getItemClass(item: ItemValue): string;
   getControlClass(): string;
   get optionsCaption(): string;
@@ -7609,8 +7721,10 @@ export declare class QuestionRatingModel extends Question {
   set renderedValue(val: boolean);
   get visibleChoices(): any;
   get readOnlyText(): any;
+  needResponsiveWidth(): boolean;
   protected supportResponsiveness(): boolean;
   protected getCompactRenderAs(): string;
+  protected getDesktopRenderAs(): string;
 }
 /*
 * It is a base class for checkbox, dropdown and radiogroup questions.
@@ -7760,6 +7874,10 @@ export declare class QuestionSelectBase extends Question {
   set otherText(val: string);
   get locOtherText(): LocalizableString;
   /*
+  * Use this property to show "Select All", "None" and "Other" choices in multi columns .
+  */
+  separateSpecialChoices: boolean;
+  /*
   * Use this property to set the place holder text for other or comment field  .
   */
   get otherPlaceHolder(): string;
@@ -7839,6 +7957,10 @@ export declare class QuestionSelectBase extends Question {
   protected getItemClassCore(item: any, options: any): string;
   getLabelClass(item: ItemValue): string;
   getControlLabelClass(item: ItemValue): string;
+  get headItems(): any;
+  get footItems(): any;
+  get hasHeadItems(): boolean;
+  get hasFootItems(): boolean;
   get columns(): any;
   get hasColumns(): boolean;
   choicesLoaded(): void;
@@ -7852,6 +7974,10 @@ export declare class QuestionSelectBase extends Question {
   getItemId(item: ItemValue): string;
   get questionName(): string;
   getItemEnabled(item: ItemValue): any;
+  rootElement: any;
+  afterRender(el: any): void;
+  prevIsOtherSelected: boolean;
+  protected onValueChanged(): void;
 }
 /*
 * A Model for signature pad question.
@@ -8203,6 +8329,7 @@ export declare class QuestionImageModel extends QuestionNonValue {
   * The rendered mode.
   */
   get renderedMode(): string;
+  getImageCss(): string;
   protected calculateRenderedMode(): void;
 }
 /*
@@ -8475,6 +8602,7 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
   get cells(): MatrixCells;
   set cells(val: MatrixCells);
   get hasCellText(): boolean;
+  protected updateHasCellText(): void;
   setCellText(row: any, column: any, val: string): void;
   getCellText(row: any, column: any): string;
   setDefaultCellText(column: any, val: string): void;
@@ -9448,6 +9576,8 @@ export declare var defaultStandardCss: {
     buttonRemove: string,
     buttonRemoveRight: string,
     buttonPrev: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     buttonNext: string,
     progressContainer: string,
     progress: string,
@@ -9555,6 +9685,7 @@ export declare var surveyTimerFunctions: {
   setTimeout: any,
   clearTimeout: any,
 };
+export declare var keyFocusedClassName: any;
 export declare var matrixDropdownColumnTypes: {
   dropdown: {
     onCellQuestionUpdate: any,
@@ -9799,6 +9930,8 @@ export declare var defaultBootstrapCss: {
     buttonRemoveRight: string,
     buttonPrev: string,
     buttonNext: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     progressContainer: string,
     progress: string,
     progressBar: string,
@@ -10122,6 +10255,8 @@ export declare var defaultBootstrapMaterialCss: {
     buttonRemoveRight: string,
     buttonPrev: string,
     buttonNext: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     progressContainer: string,
     progress: string,
     progressBar: string,
@@ -10227,6 +10362,7 @@ export declare var defaultBootstrapMaterialCss: {
 };
 export declare var defaultV2Css: {
   root: string,
+  rootMobile: string,
   container: string,
   header: string,
   body: string,
@@ -10239,6 +10375,7 @@ export declare var defaultV2Css: {
   headerText: string,
   navigationButton: string,
   completedPage: string,
+  timerRoot: string,
   navigation: {
     complete: string,
     prev: string,
@@ -10276,9 +10413,9 @@ export declare var defaultV2Css: {
     button: string,
     buttonRemove: string,
     buttonAdd: string,
-    progressTop: string,
-    progressBottom: string,
     buttonPrev: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     buttonNext: string,
     progressContainer: string,
     progress: string,
@@ -10357,6 +10494,7 @@ export declare var defaultV2Css: {
     mainRoot: string,
     root: string,
     image: string,
+    adaptive: string,
     withFrame: string,
   },
   html: {
@@ -10561,6 +10699,7 @@ export declare var defaultV2Css: {
   rating: {
     rootDropdown: string,
     root: string,
+    rootWrappable: string,
     item: string,
     itemOnError: string,
     itemHover: string,
@@ -10596,6 +10735,7 @@ export declare var defaultV2Css: {
     noFileChosen: string,
     chooseFile: string,
     chooseFileAsText: string,
+    chooseFileAsTextDisabled: string,
     chooseFileAsIcon: string,
     chooseFileIconId: string,
     disabled: string,
@@ -10668,10 +10808,15 @@ export declare var defaultV2Css: {
     itemPressed: string,
     itemAsIcon: string,
     itemIcon: string,
+    itemTitle: string,
+  },
+  variables: {
+    mobileWidth: string,
   },
 };
 export declare var modernCss: {
   root: string,
+  timerRoot: string,
   container: string,
   header: string,
   headerClose: string,
@@ -10720,6 +10865,8 @@ export declare var modernCss: {
     progressBottom: string,
     buttonPrev: string,
     buttonNext: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     progressContainer: string,
     progress: string,
     progressBar: string,
@@ -11037,4 +11184,5 @@ export declare var modernCss: {
   },
 };
 export declare var SvgRegistry: SvgIconRegistry;
-export declare var SvgBundleViewModel: any;
+export declare var SvgBundleViewModel: any;
+export declare var path: any;