survey-react 1.9.23 → 1.9.26

package/survey.react.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey JavaScript library for React v1.9.23
+* Type definition for Survey JavaScript library for React v1.9.26
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
@@ -93,96 +93,96 @@ export interface IExpresionExecutor {
   onComplete: any;
 }
 /*
-* 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.
+* An action item.
+* Action items are used in the Toolbar, matrix rows, titles of pages, panels, questions, and other survey elements.
 */
 export interface IAction {
   /*
-  * Unique string id
+  * A unique action item identifier.
   */
   id: string;
   /*
-  * Set this property to false to make the toolbar item invisible.
+  * Specifies the action item's visibility.
   */
   visible?: boolean;
   /*
-  * Toolbar item title
+  * The action item's title.
   */
   title?: string;
   /*
-  * Toolbar item tooltip
+  * The action item's tooltip.
   */
   tooltip?: string;
   /*
-  * Set this property to false to disable the toolbar item.
+  * Specifies whether users can interact with the action item.
   */
   enabled?: boolean;
   /*
-  * Set this property to false to hide the toolbar item title.
+  * Specifies the visibility of the action item's title.
   */
   showTitle?: boolean;
   /*
-  * A callback that calls on toolbar item click.
+  * A function that is executed when users click the action item.
   */
   action?: any;
   /*
-  * Toolbar item css class
+  * One or several CSS classes that you want to apply to the outer `<div>` element.
+  * In the markup, an action item is rendered as an `<input>` wrapped in a `<div>`. The `css` property applies classes to the `<div>`.
+  * To apply several classes, separate them with a space character: "myclass1 myclass2".
   */
   css?: string;
   /*
-  * Toolbar inner element css class
+  * One or several CSS classes that you want to apply to the inner `<input>` element.
+  * In the markup, an action item is rendered as an `<input>` wrapped in a `<div>`. The `innerCss` property applies classes to the `<input>`.
+  * To apply several classes, separate them with a space character: "myclass1 myclass2".
   */
   innerCss?: string;
   /*
-  * Toolbar item data object. Used as data for custom template or component rendering
+  * The action item's data object. Use it to pass required data to a custom template or component.
   */
   data?: any;
   popupModel?: any;
   needSeparator?: boolean;
   /*
-  * Set this property to true to activate the toolbar item (page)
+  * Specifies whether the action item is active.
+  * Use it as a flag to specify different action item appearances in different states.
   */
   active?: boolean;
   pressed?: boolean;
   /*
-  * Toolbar item template name
+  * Specifies the name of a template used to render the action item.
   */
   template?: string;
   /*
-  * Toolbar item component name
+  * Specifies the name of a component used to render the action item.
   */
   component?: string;
   /*
-  * Toolbar item icon name
+  * The action item's icon name.
   */
   iconName?: string;
   /*
-  * Toolbar item icon size
+  * The action item's icon size in pixels.
   */
   iconSize?: number;
   /*
-  * Toolbar item child items. Can be used as contianer for options
-  */
-  items?: any;
-  /*
-  * Gets or sets an action's location in a matrix question's row.
+  * The action item's location in a matrix question's row.
   * 
-  * The following options are available:
+  * The following values are available:
   * 
-  * - `start` - An action is located at the beginning of a row.
-  * - `end` - An action is located at the end of a row.
+  * - `"start"` - The action item is located at the beginning of the row.
+  * - `"end"` - The action is located at the end of the row.
   */
   location?: string;
   /*
-  * Set it to true to make the tabIndex -1 to disable keyboard navigation to this item
+  * Set this property to `true` if you want to disable keyboard navigation for the action item (sets the `tabIndex` attribute to -1).
   */
   disableTabStop?: boolean;
   /*
-  * Set it to false to force action "large" mode even if has icon and does not fit to action bar space
+  * Set this property to `true` if you want the item's `title` to be always visible.
+  * If you set it to `false`, the `title` hides when the screen space is limited, and the item displays only the icon.
   */
   disableShrink?: boolean;
-  /*
-  * Action button display mode
-  */
   mode?: any;
   visibleIndex?: number;
   needSpace?: boolean;
@@ -479,6 +479,11 @@ export interface IFindElement {
   element: Base;
   str: LocalizableString;
 }
+export interface IExpressionRunnerInfo {
+  onExecute: any;
+  canRun?: any;
+  runner?: ExpressionRunner;
+}
 export interface IValidatorOwner {
   getValidators(): Array<SurveyValidator>;
   validatedValue: any;
@@ -589,6 +594,7 @@ export declare class Base {
   localizableStrings: any;
   arraysInfo: any;
   eventList: any;
+  expressionInfo: any;
   bindingsValue: Bindings;
   isDisposedValue: boolean;
   onPropChangeFunctions: any;
@@ -648,6 +654,10 @@ export declare class Base {
   getType(): string;
   getSurvey(isLive?: boolean): ISurvey;
   /*
+  * Returns true if the question in design mode right now.
+  */
+  get isDesignMode(): boolean;
+  /*
   * Returns true if the object is inluded into survey, otherwise returns false.
   */
   get inSurvey(): boolean;
@@ -709,6 +719,11 @@ export declare class Base {
   protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
   protected propertyValueChanged(name: string, oldValue: any, newValue: any, arrayChanges?: ArrayChanges, target?: Base): void;
   protected get isInternal(): boolean;
+  addExpressionProperty(name: string, onExecute: any, canRun?: any): void;
+  getDataFilteredValues(): any;
+  getDataFilteredProperties(): any;
+  protected runConditionCore(values: any, properties: any): void;
+  protected canRunConditions(): boolean;
   /*
   * Register a function that will be called on a property value changed.
   */
@@ -1097,6 +1112,7 @@ export declare class OperandMaker {
   static signs: any;
 }
 export declare class PopupUtils {
+  static bottomIndent: number;
   static calculatePosition(targetRect: any, height: number, width: number, verticalPosition: any, horizontalPosition: any, showPointer: boolean): INumberPosition;
   static updateVerticalDimensions(top: number, height: number, windowHeight: number): any;
   static updateHorizontalDimensions(left: number, width: number, windowWidth: number, horizontalPosition: any): any;
@@ -1499,9 +1515,11 @@ export declare class ActionContainer<T extends Action = Action> extends Base {
   get visibleActions(): any;
   getRootCss(): string;
   get cssClasses(): any;
+  addAction(val: IAction, sortByVisibleIndex?: boolean): Action;
   setItems(items: any, sortByVisibleIndex?: boolean): void;
   initResponsivityManager(container: any): void;
   resetResponsivityManager(): void;
+  getActionById(id: string): T;
 }
 export declare class AnswerRequiredError extends SurveyError {
   constructor(text?: string, errorOwner?: ISurveyErrorOwner);
@@ -1918,6 +1936,7 @@ export declare class JsonObjectProperty implements IObject {
   onGetValue: any;
   onSetValue: any;
   visibleIf: any;
+  onExecuteExpression: any;
   onPropertyEditorUpdate: any;
   get id(): number;
   get classInfo(): JsonMetadataClass;
@@ -2015,6 +2034,7 @@ export declare class LocalizableString implements ILocalizableString {
   localizationName: string;
   onGetTextCallback: any;
   onGetDefaultTextCallback: any;
+  onGetLocalizationTextCallback: any;
   onStrChanged: any;
   onSearchChanged: any;
   sharedData: LocalizableString;
@@ -2163,7 +2183,7 @@ export declare class MatrixDropdownColumn extends Base implements ILocalizableOw
   updateCellQuestion(cellQuestion: Question, data: any, onUpdateJson?: any): void;
   defaultCellTypeChanged(): void;
   protected calcCellQuestionType(row: MatrixDropdownRowModelBase): string;
-  protected updateTemplateQuestion(): void;
+  protected updateTemplateQuestion(newCellType?: string): void;
   protected createNewQuestion(cellType: string): Question;
   previousChoicesId: string;
   protected setQuestionProperties(question: Question, onUpdateJson?: any): void;
@@ -2726,18 +2746,6 @@ export declare class SurveyElementCore extends Base implements ILocalizableOwner
   getRendererContext(locStr: LocalizableString): any;
   getProcessedText(text: string): string;
 }
-export declare class SurveyNavigation extends SurveyNavigationBase {
-  constructor(props: any);
-  handlePrevClick(event: any): void;
-  handleNextClick(event: any): void;
-  handleNextMouseDown(event: any): any;
-  handleMouseDown(event: any): any;
-  handleCompleteClick(event: any): void;
-  handlePreviewClick(event: any): void;
-  handleStartClick(event: any): void;
-  render(): any;
-  protected renderButton(click: any, mouseDown: any, text: string, btnClassName: string): any;
-}
 export declare class SurveyPanelBase extends SurveyElementBase<any, any> {
   constructor(props: any);
   protected rootRef: any;
@@ -3162,6 +3170,7 @@ export declare class ImageItemValue extends ItemValue implements ILocalizableOwn
   */
   get imageLink(): string;
   set imageLink(val: string);
+  aspectRatio: number;
   get locImageLink(): LocalizableString;
   getLocale(): string;
   getMarkdownHtml(text: string, name: string): string;
@@ -3356,6 +3365,9 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   get titleTabIndex(): number;
   get titleAriaExpanded(): boolean;
   setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
+  protected canRunConditions(): boolean;
+  getDataFilteredValues(): any;
+  getDataFilteredProperties(): any;
   protected get surveyImpl(): ISurveyImpl;
   __setData(data: ISurveyData): void;
   get data(): ISurveyData;
@@ -3365,10 +3377,6 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   get survey(): ISurvey;
   getSurvey(live?: boolean): ISurvey;
   protected setSurveyCore(value: ISurvey): void;
-  /*
-  * Returns true if the question in design mode right now.
-  */
-  get isDesignMode(): boolean;
   isContentElement: boolean;
   isEditableTemplateElement: boolean;
   isInteractiveDesignElement: boolean;
@@ -3533,6 +3541,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   localeValue: string;
   textPreProcessor: TextPreProcessor;
   timerModelValue: SurveyTimerModel;
+  navigationBarValue: any;
   /*
   * 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.
@@ -4194,7 +4203,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   get cssNavigationStart(): string;
   get cssNavigationNext(): string;
   get bodyCss(): string;
-  get completedCss(): string;
+  completedCss: string;
+  containerCss: string;
   get completedStateCss(): string;
   getCompletedStateCss(): string;
   lazyRenderingValue: boolean;
@@ -4506,6 +4516,16 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   set loadingHtml(val: string);
   get locLoadingHtml(): LocalizableString;
   /*
+  * Default value for loadingHtml property
+  */
+  get defaultLoadingHtml(): string;
+  get navigationBar(): any;
+  /*
+  * Adds a custom navigation item similar to the Previous Page, Next Page, and Complete buttons.
+  * Accepts an object described in the [IAction](https://surveyjs.io/Documentation/Library?id=IAction) help section.
+  */
+  addNavigationItem(val: IAction): Action;
+  /*
   * Gets or sets the 'Start' button caption.
   * The 'Start' button is shown on the started page. Set the `firstPageIsStarted` property to `true`, to display the started page.
   */
@@ -5151,6 +5171,10 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   setJsonObject(jsonObj: any): void;
   isEndLoadingFromJson: string;
   endLoadingFromJson(): void;
+  updateNavigationItemTitlesCallback: any;
+  updateNavigationItemCssCallback: any;
+  protected createNavigationBar(): ActionContainer;
+  protected createNavigationActions(): Array<IAction>;
   protected onBeforeCreating(): void;
   protected onCreating(): void;
   getBuiltInVariableValue(name: string): number;
@@ -5338,6 +5362,12 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   dispose(): void;
   disposeCallback: any;
 }
+export declare class SurveyNavigationButton extends ReactSurveyElement {
+  constructor(props: any);
+  protected get item(): Action;
+  protected canRender(): boolean;
+  protected renderElement(): any;
+}
 export declare class SurveyPage extends SurveyPanelBase {
   constructor(props: any);
   protected getPanelBase(): PanelModelBase;
@@ -5468,6 +5498,7 @@ export declare class SurveyQuestionImagePicker extends SurveyQuestionElementBase
   constructor(props: any);
   protected get question(): any;
   protected renderElement(): any;
+  protected getColumns(cssClasses: any): any;
   protected getItems(cssClasses: any): Array<any>;
   protected get textStyle(): any;
   protected renderItem(key: string, item: any, cssClasses: any): any;
@@ -6012,15 +6043,12 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   constructor(name: string);
   static TextPreprocessorValuesMap: any;
   static questionCounter: number;
-  conditionRunner: ConditionRunner;
   isCustomWidgetRequested: boolean;
   customWidgetValue: QuestionCustomWidget;
   customWidgetData: any;
   focusCallback: any;
   surveyLoadCallback: any;
   displayValueCallback: any;
-  conditionEnabelRunner: ConditionRunner;
-  conditionRequiredRunner: ConditionRunner;
   defaultValueRunner: ExpressionRunner;
   isChangingViaDefaultValue: boolean;
   isValueChangedDirectly: boolean;
@@ -6128,8 +6156,6 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   moveTo(container: IPanel, insertBefore?: any): boolean;
   getProgressInfo(): IProgressInfo;
   setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
-  getDataFilteredValues(): any;
-  getDataFilteredProperties(): any;
   /*
   * A parent element. It can be panel or page.
   */
@@ -6535,10 +6561,14 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   transformToDesktopView(): void;
   needResponsiveWidth(): boolean;
   protected supportResponsiveness(): boolean;
+  protected needResponsiveness(): boolean;
+  protected checkForResponsiveness(el: any): void;
   resizeObserver: any;
+  protected getObservedElementSelector(): string;
+  onMobileChangedCallback: any;
   protected getCompactRenderAs(): string;
   protected getDesktopRenderAs(): string;
-  protected processResponsiveness(requiredWidth: number, availableWidth: number): void;
+  protected processResponsiveness(requiredWidth: number, availableWidth: number): any;
   dispose(): void;
 }
 export declare class SurveyFlowPanel extends SurveyPanel {
@@ -7992,6 +8022,7 @@ export declare class QuestionSelectBase extends Question {
   getColumnClass(): string;
   getItemIndex(item: any): number;
   getItemClass(item: any): string;
+  protected getCurrentColCount(): number;
   protected getItemClassCore(item: any, options: any): string;
   getLabelClass(item: ItemValue): string;
   getControlLabelClass(item: ItemValue): string;
@@ -8012,7 +8043,7 @@ export declare class QuestionSelectBase extends Question {
   getItemId(item: ItemValue): string;
   get questionName(): string;
   getItemEnabled(item: ItemValue): any;
-  rootElement: any;
+  protected rootElement: any;
   afterRender(el: any): void;
   prevIsOtherSelected: boolean;
   protected onValueChanged(): void;
@@ -8891,14 +8922,16 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
   /*
   * The image height.
   */
-  get imageHeight(): string;
-  set imageHeight(val: string);
+  get imageHeight(): number;
+  set imageHeight(val: number);
+  responsiveImageHeight: number;
   get renderedImageHeight(): string;
   /*
   * The image width.
   */
-  get imageWidth(): string;
-  set imageWidth(val: string);
+  get imageWidth(): number;
+  set imageWidth(val: number);
+  responsiveImageWidth: number;
   get renderedImageWidth(): string;
   /*
   * The image fit mode.
@@ -8911,8 +8944,24 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
   get contentMode(): string;
   set contentMode(val: string);
   protected convertDefaultValue(val: any): any;
-  get hasColumns(): boolean;
   get inputType(): "checkbox" | "radio";
+  protected isFootChoice(_item: ItemValue, _question: QuestionSelectBase): boolean;
+  getSelectBaseRootCss(): string;
+  isResponsiveValue: boolean;
+  maxImageWidth: number;
+  minImageWidth: number;
+  maxImageHeight: number;
+  minImageHeight: number;
+  protected getObservedElementSelector(): string;
+  protected supportResponsiveness(): boolean;
+  protected needResponsiveness(): boolean;
+  _width: number;
+  onContentLoaded: any;
+  responsiveColCount: number;
+  protected getCurrentColCount(): number;
+  protected processResponsiveness(_: number, availableWidth: number): boolean;
+  gapBetweenItems: number;
+  afterRender(el: any): void;
 }
 /*
 * A Model for a matrix dropdown question. You may use a dropdown, checkbox, radiogroup, text and comment questions as a cell editors.
@@ -8997,6 +9046,7 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
   */
   get allowRowsDragAndDrop(): boolean;
   set allowRowsDragAndDrop(val: boolean);
+  get iconDragElement(): string;
   protected createRenderedTable(): QuestionMatrixDropdownRenderedTable;
   /*
   * The minimum row count. A user could not delete a row if the rowCount equals to minRowCount
@@ -9672,6 +9722,7 @@ export declare var defaultStandardCss: {
     itemInline: string,
     itemText: string,
     clearButton: string,
+    column: string,
   },
   rating: {
     root: string,
@@ -9721,6 +9772,9 @@ export declare var defaultStandardCss: {
       buttonCollapsed: string,
     },
   },
+  variables: {
+    themeMark: string,
+  },
 };
 export declare var surveyTimerFunctions: {
   setTimeout: any,
@@ -10655,6 +10709,7 @@ export declare var defaultV2Css: {
   imagepicker: {
     mainRoot: string,
     root: string,
+    rootColumn: string,
     item: string,
     itemOnError: string,
     itemInline: string,
@@ -10669,6 +10724,10 @@ export declare var defaultV2Css: {
     itemText: string,
     clearButton: string,
     other: string,
+    itemNoImage: string,
+    itemNoImageSvgIcon: string,
+    itemNoImageSvgIconId: string,
+    column: string,
   },
   matrix: {
     mainRoot: string,
@@ -10729,6 +10788,8 @@ export declare var defaultV2Css: {
     buttonRemove: string,
     iconAdd: string,
     iconRemove: string,
+    dragElementDecorator: string,
+    iconDragElement: string,
     footer: string,
     emptyRowsSection: string,
     iconDrag: string,
@@ -10843,6 +10904,17 @@ export declare var defaultV2Css: {
     itemDragMod: string,
     itemOnError: string,
   },
+  buttongroup: {
+    root: string,
+    item: string,
+    itemIcon: string,
+    itemDecorator: string,
+    itemCaption: string,
+    itemHover: string,
+    itemSelected: string,
+    itemDisabled: string,
+    itemControl: string,
+  },
   actionBar: {
     root: string,
     item: string,
@@ -10853,6 +10925,8 @@ export declare var defaultV2Css: {
   },
   variables: {
     mobileWidth: string,
+    imagepickerGapBetweenItems: string,
+    themeMark: string,
   },
 };
 export declare var modernCss: {
@@ -11093,6 +11167,7 @@ export declare var modernCss: {
   },
   imagepicker: {
     root: string,
+    column: string,
     item: string,
     itemInline: string,
     itemChecked: string,
@@ -11223,6 +11298,9 @@ export declare var modernCss: {
       buttonCollapsed: string,
     },
   },
+  variables: {
+    themeMark: string,
+  },
 };
 export declare var SvgRegistry: SvgIconRegistry;
 export declare var SvgBundleViewModel: any;