survey-react 1.9.13 → 1.9.16

package/survey.react.d.ts

@@ -1,10 +1,12 @@
 /*
-* Type definition for Survey JavaScript library for React v1.9.13
+* Type definition for Survey JavaScript library for React v1.9.16
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
 import * as React from "react";
 
+export { SurveyModel as Model };
+
 export enum DragTypeOverMeEnum {
   InsideEmptyPanel = 1,
   MultilineRight,
@@ -1246,6 +1248,7 @@ export declare class SurveyError {
   text: string;
   locTextValue: LocalizableString;
   visible: boolean;
+  equalsTo(error: SurveyError): boolean;
   get locText(): LocalizableString;
   getText(): string;
   getErrorType(): string;
@@ -1301,11 +1304,6 @@ export declare class SurveyTimer {
   stop(func?: any): void;
   doTimer(): void;
 }
-export declare class SurveyTimerPanel extends React.Component<any, any> {
-  constructor(props: any);
-  protected get survey(): any;
-  render(): any;
-}
 export declare class SvgIcon extends React.Component<any, any> {
   constructor(props: any);
   svgIconRef: any;
@@ -1703,6 +1701,9 @@ export declare class ExceedSizeError extends SurveyError {
   getErrorType(): string;
   getDefaultText(): string;
 }
+/*
+* Base class for HtmlConditionItem and UrlConditionItem classes.
+*/
 export declare class ExpressionItem extends Base implements ILocalizableOwner {
   constructor(expression?: string);
   locOwner: ILocalizableOwner;
@@ -2107,6 +2108,7 @@ export declare class MatrixDropdownColumn extends Base implements ILocalizableOw
   protected calcCellQuestionType(row: MatrixDropdownRowModelBase): string;
   protected updateTemplateQuestion(): void;
   protected createNewQuestion(cellType: string): Question;
+  previousChoicesId: string;
   protected setQuestionProperties(question: Question, onUpdateJson?: any): void;
   protected propertyValueChanged(name: string, oldValue: any, newValue: any): void;
 }
@@ -2776,6 +2778,7 @@ export declare class SurveyTimerModel extends Base {
   text: string;
   spent: number;
   get survey(): ISurvey;
+  onCreating(): void;
   timerFunc: any;
   start(): void;
   stop(): void;
@@ -3877,10 +3880,14 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   */
   onFocusInPanel: EventBase<SurveyModel>;
   /*
-  * You can use this event to decide whether show or hide choice item in checkbox, dropdown and radiogroup like questions
-  * <br/> `sender` - the survey object that fires the event
-  * <br/> `options.question` - a question that contains choices.
-  * <br/> `options.item` - an item of the question.
+  * Use this event to change the visibility of an individual choice item in [Checkbox](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel), [Dropdown](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel), [Radiogroup](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel), and other similar question types.
+  * 
+  * The event handler accepts the following arguments:
+  * 
+  * - `sender` - A Survey instance that raised the event.
+  * - `options.question` - A Question instance to which the choice item belongs.
+  * - `options.item` - The choice item as specified in the [choices](https://surveyjs.io/Documentation/Library?id=QuestionSelectBase#choices) array.
+  * - `options.visible` - A Boolean value that specifies the item visibility. Set it to `false` to hide the item.
   */
   onShowingChoiceItem: EventBase<SurveyModel>;
   /*
@@ -5047,6 +5054,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   protected updateQuestionValue(valueName: string, newValue: any): void;
   protected notifyQuestionOnValueChanged(valueName: string, newValue: any): void;
   isRunningElementsBindings: boolean;
+  updateVisibleIndexAfterBindings: boolean;
   isTriggerIsRunning: boolean;
   triggerValues: any;
   triggerKeys: any;
@@ -5076,6 +5084,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   endLoadingFromJson(): void;
   protected onBeforeCreating(): void;
   protected onCreating(): void;
+  getBuiltInVariableValue(name: string): number;
   hasVisibleQuestionByValueName(valueName: string): boolean;
   questionCountByValueName(valueName: string): number;
   /*
@@ -5508,7 +5517,6 @@ export declare class SurveyQuestionRating extends SurveyQuestionElementBase {
   handleOnClick(event: any): void;
   protected renderElement(): any;
   protected renderItem(key: string, item: any, index: number, cssClasses: any): any;
-  protected renderOther(cssClasses: any): any;
 }
 export declare class SurveyQuestionSignaturePad extends SurveyQuestionElementBase {
   constructor(props: any);
@@ -5523,6 +5531,12 @@ export declare class SurveyQuestionUncontrolledElement<T> extends SurveyQuestion
   protected getValueCore(): any;
   protected updateDomElement(): void;
 }
+export declare class SurveyTimerPanel extends ReactSurveyElement {
+  constructor(props: any);
+  protected getStateElement(): Base;
+  protected get timerModel(): any;
+  render(): any;
+}
 /*
 * It extends the Trigger base class and add properties required for SurveyJS classes.
 */
@@ -5630,8 +5644,10 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
   getType(): string;
   setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
   endLoadingFromJson(): void;
+  showTitle: boolean;
   get hasTitle(): boolean;
   protected canShowTitle(): boolean;
+  showDescription: boolean;
   get _showDescription(): boolean;
   localeChanged(): void;
   locStrsChanged(): void;
@@ -5909,6 +5925,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   */
   onReadyChanged: EventBase<Question>;
   isReadOnlyRenderDiv(): boolean;
+  isMobile: boolean;
   protected createLocTitleProperty(): LocalizableString;
   getSurvey(live?: boolean): ISurvey;
   getValueName(): string;
@@ -6395,7 +6412,14 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   get validatedValue(): any;
   set validatedValue(val: any);
   getAllValues(): any;
+  transformToMobileView(): void;
+  transformToDesktopView(): void;
   needResponsiveWidth(): boolean;
+  protected supportResponsiveness(): boolean;
+  resizeObserver: any;
+  protected getCompactRenderAs(): string;
+  protected processResponsiveness(requiredWidth: number, availableWidth: number): void;
+  dispose(): void;
 }
 export declare class SurveyFlowPanel extends SurveyPanel {
   constructor(props: any);
@@ -6429,6 +6453,11 @@ export declare class SurveyQuestionBooleanCheckbox extends SurveyQuestionBoolean
   constructor(props: any);
   protected renderElement(): any;
 }
+export declare class SurveyQuestionBooleanRadio extends SurveyQuestionBoolean {
+  constructor(props: any);
+  handleOnChange: any;
+  protected renderElement(): any;
+}
 export declare class SurveyQuestionComment extends SurveyQuestionUncontrolledElement<QuestionCommentModel> {
   constructor(props: any);
   protected renderElement(): any;
@@ -6443,13 +6472,11 @@ export declare class SurveyQuestionCustom extends SurveyQuestionUncontrolledElem
   protected getStateElements(): Array<Base>;
   protected renderElement(): any;
 }
-export declare class SurveyQuestionDropdown extends SurveyQuestionUncontrolledElement<QuestionDropdownModel> {
+export declare class SurveyQuestionDropdownBase<T> extends SurveyQuestionUncontrolledElement<T> {
   constructor(props: any);
   protected setValueCore(newValue: any): void;
   protected getValueCore(): any;
-  protected renderElement(): any;
   protected renderSelect(cssClasses: any): any;
-  protected renderOther(cssClasses: any): any;
 }
 export declare class SurveyQuestionMatrixDropdown extends SurveyQuestionMatrixDropdownBase {
   constructor(props: any);
@@ -6790,6 +6817,9 @@ export declare class QuestionBooleanModel extends Question {
   protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
   onLabelClick(event: any, value: boolean): boolean;
   onSwitchClickModel(event: any): boolean;
+  getRadioItemClass(css: any, value: any): string;
+  protected supportResponsiveness(): boolean;
+  protected getCompactRenderAs(): string;
 }
 export declare class QuestionCustomModelBase extends Question implements ISurveyImpl, ISurveyData, IPanel {
   constructor(name: string, customQuestion: ComponentQuestionJSON);
@@ -6915,6 +6945,15 @@ export declare class QuestionFileModel extends Question {
   onStateChanged: EventBase<QuestionFileModel>;
   previewValue: any;
   currentState: string;
+  indexToShow: number;
+  containsMultiplyFiles: boolean;
+  mobileFileNavigator: any;
+  prevFileAction: Action;
+  nextFileAction: Action;
+  fileIndexAction: Action;
+  get mobileFileNavigatorVisible(): boolean;
+  protected updateElementCssCore(cssClasses: any): void;
+  isPreviewVisible(index: number): boolean;
   getType(): string;
   clearOnDeletingContainer(): void;
   /*
@@ -7047,7 +7086,7 @@ export declare class QuestionFileModel extends Question {
   supportComment(): boolean;
   getChooseFileCss(): string;
   getReadOnlyFileCss(): string;
-  getFileRootCss(): string;
+  get fileRootCss(): string;
   getFileDecoratorCss(): string;
   onDragOver: any;
   onDrop: any;
@@ -7561,6 +7600,17 @@ export declare class QuestionRatingModel extends Question {
   */
   setValueFromClick(value: any): void;
   getItemClass(item: ItemValue): string;
+  getControlClass(): string;
+  get optionsCaption(): string;
+  set optionsCaption(val: string);
+  get locOptionsCaption(): LocalizableString;
+  get showOptionsCaption(): boolean;
+  get renderedValue(): boolean;
+  set renderedValue(val: boolean);
+  get visibleChoices(): any;
+  get readOnlyText(): any;
+  protected supportResponsiveness(): boolean;
+  protected getCompactRenderAs(): string;
 }
 /*
 * It is a base class for checkbox, dropdown and radiogroup questions.
@@ -7568,6 +7618,7 @@ export declare class QuestionRatingModel extends Question {
 export declare class QuestionSelectBase extends Question {
   constructor(name: string);
   visibleChoicesChangedCallback: any;
+  loadedChoicesFromServerCallback: any;
   filteredChoicesValue: any;
   conditionChoicesVisibleIfRunner: ConditionRunner;
   conditionChoicesEnableIfRunner: ConditionRunner;
@@ -7895,6 +7946,11 @@ export declare class QuestionTextBase extends Question {
   protected hasPlaceHolder(): boolean;
   getControlClass(): string;
 }
+export declare class SurveyQuestionDropdown extends SurveyQuestionDropdownBase<Question> {
+  constructor(props: any);
+  protected renderElement(): any;
+  protected renderOther(cssClasses: any): any;
+}
 export declare class SurveyQuestionMatrixDropdownCell extends SurveyQuestionAndErrorsCell {
   constructor(props: any);
   protected getQuestion(): Question;
@@ -7904,6 +7960,10 @@ export declare class SurveyQuestionMatrixDropdownCell extends SurveyQuestionAndE
   protected getHeaderText(): string;
   protected renderQuestion(): any;
 }
+export declare class SurveyQuestionRatingDropdown extends SurveyQuestionDropdownBase<QuestionRatingModel> {
+  constructor(props: any);
+  protected renderElement(): any;
+}
 /*
 * The flow panel object. It is a container with flow layout where you can mix questions with markdown text.
 */
@@ -8321,6 +8381,8 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
   protected getConditionObjectRowText(index: number): string;
   protected getConditionObjectsRowIndeces(): Array<any>;
   getProgressInfo(): IProgressInfo;
+  protected updateProgressInfoByValues(res: IProgressInfo): void;
+  protected updateProgressInfoByRow(res: IProgressInfo, rowValue: any): void;
   protected onBeforeValueChanged(val: any): void;
   protected setQuestionValue(newValue: any): void;
   supportGoNextPageAutomatic(): boolean;
@@ -8365,6 +8427,8 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
   getColumnHeaderWrapperComponentData(cell: MatrixDropdownCell): any;
   getRowHeaderWrapperComponentName(cell: MatrixDropdownCell): string;
   getRowHeaderWrapperComponentData(cell: MatrixDropdownCell): any;
+  get showHorizontalScroll(): boolean;
+  getRootCss(): string;
 }
 /*
 * A Model for a simple matrix question.
@@ -8710,6 +8774,7 @@ export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownM
   protected generateRows(): Array<MatrixDropdownRowModel>;
   protected createMatrixRow(item: ItemValue, value: any): MatrixDropdownRowModel;
   protected getSearchableItemValueKeys(keys: any): void;
+  protected updateProgressInfoByValues(res: IProgressInfo): void;
 }
 /*
 * A Model for a matrix dymanic question. You may use a dropdown, checkbox, radiogroup, text and comment questions as a cell editors.
@@ -8758,6 +8823,7 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
   */
   get rowCount(): number;
   set rowCount(val: number);
+  protected updateProgressInfoByValues(res: IProgressInfo): void;
   /*
   * Set this property to true, to allow rows drag and drop.
   */
@@ -9148,6 +9214,7 @@ export declare var surveyStrings: any;
 * An alias for the metadata object. It contains object properties' runtime information and allows you to modify it.
 */
 export declare var Serializer: JsonMetadata;
+export declare var surveyBuiltInVarible: string;
 export declare var registerFunction: any;
 export declare var parse: any;
 export declare var defaultActionBarCss: {
@@ -9259,6 +9326,7 @@ export declare var defaultStandardCss: {
   },
   boolean: {
     root: string,
+    rootRadio: string,
     item: string,
     control: string,
     itemChecked: string,
@@ -9609,6 +9677,7 @@ export declare var defaultBootstrapCss: {
   },
   boolean: {
     root: string,
+    rootRadio: string,
     item: string,
     control: string,
     itemChecked: string,
@@ -9925,6 +9994,7 @@ export declare var defaultBootstrapMaterialCss: {
   },
   boolean: {
     root: string,
+    rootRadio: string,
     item: string,
     control: string,
     itemChecked: string,
@@ -10346,7 +10416,13 @@ export declare var defaultV2Css: {
   boolean: {
     mainRoot: string,
     root: string,
+    rootRadio: string,
     item: string,
+    radioItem: string,
+    radioItemChecked: string,
+    radioLabel: string,
+    radioControlLabel: string,
+    radioFieldset: string,
     itemOnError: string,
     control: string,
     itemChecked: string,
@@ -10357,8 +10433,11 @@ export declare var defaultV2Css: {
     disabledLabel: string,
     itemDecorator: string,
     materialDecorator: string,
+    itemRadioDecorator: string,
+    materialRadioDecorator: string,
     sliderText: string,
     slider: string,
+    itemControl: string,
   },
   text: {
     root: string,
@@ -10378,7 +10457,6 @@ export declare var defaultV2Css: {
   dropdown: {
     root: string,
     small: string,
-    control: string,
     selectWrapper: string,
     other: string,
     onError: string,
@@ -10389,9 +10467,10 @@ export declare var defaultV2Css: {
     itemHover: string,
     itemControl: string,
     itemDecorator: string,
+    control: string,
     controlDisabled: string,
-    controlLabel: string,
     controlEmpty: string,
+    controlLabel: string,
     materialDecorator: string,
   },
   imagepicker: {
@@ -10433,6 +10512,7 @@ export declare var defaultV2Css: {
   },
   matrixdropdown: {
     mainRoot: string,
+    rootScroll: string,
     root: string,
     cell: string,
     headerCell: string,
@@ -10450,6 +10530,7 @@ export declare var defaultV2Css: {
   },
   matrixdynamic: {
     mainRoot: string,
+    rootScroll: string,
     empty: string,
     root: string,
     cell: string,
@@ -10478,6 +10559,7 @@ export declare var defaultV2Css: {
     cellQuestionWrapper: string,
   },
   rating: {
+    rootDropdown: string,
     root: string,
     item: string,
     itemOnError: string,
@@ -10487,6 +10569,10 @@ export declare var defaultV2Css: {
     itemText: string,
     maxText: string,
     itemDisabled: string,
+    control: string,
+    controlDisabled: string,
+    controlEmpty: string,
+    onError: string,
   },
   comment: {
     root: string,
@@ -10521,11 +10607,15 @@ export declare var defaultV2Css: {
     removeFileSvgIconId: string,
     wrapper: string,
     defaultImage: string,
+    defaultImageIconId: string,
+    leftIconId: string,
+    rightIconId: string,
     removeFileButton: string,
     dragAreaPlaceholder: string,
     imageWrapper: string,
     single: string,
     singleImage: string,
+    mobile: string,
   },
   signaturepad: {
     mainRoot: string,
@@ -10775,6 +10865,7 @@ export declare var modernCss: {
   },
   boolean: {
     root: string,
+    rootRadio: string,
     small: string,
     item: string,
     control: string,