survey-react 1.8.71 → 1.8.75

package/survey.react.d.ts

@@ -1,4 +1,4 @@
-/*Type definitions for Survey JavaScript library v1.8.71
+/*Type definitions for Survey JavaScript library v1.8.75
 Copyright (c) 2015-2021 Devsoft Baltic OÜ  - http://surveyjs.io/
 Definitions by: Devsoft Baltic OÜ <https://github.com/surveyjs/>
 */
@@ -180,6 +180,7 @@ export declare var defaultStandardCss: {
         cell: string;
         headerCell: string;
         row: string;
+        rowAdditional: string;
         detailRow: string;
         detailRowText: string;
         detailCell: string;
@@ -491,6 +492,7 @@ export declare var defaultBootstrapCss: {
         cell: string;
         headerCell: string;
         row: string;
+        rowAdditional: string;
         detailRow: string;
         detailRowText: string;
         detailCell: string;
@@ -803,6 +805,7 @@ export declare var defaultBootstrapMaterialCss: {
         itemValue: string;
         headerCell: string;
         row: string;
+        rowAdditional: string;
         detailRow: string;
         detailRowText: string;
         detailCell: string;
@@ -1212,6 +1215,7 @@ export declare var modernCss: {
         cell: string;
         headerCell: string;
         row: string;
+        rowAdditional: string;
         detailRow: string;
         detailRowText: string;
         detailCell: string;
@@ -1456,8 +1460,9 @@ export interface IAction {
         visibleIndex?: number;
 }
 export declare class Action extends Base implements IAction {
+        innerItem: IAction;
         updateCallback: () => void;
-        constructor(item: IAction);
+        constructor(innerItem: IAction);
         location?: string;
         id: string;
         iconName: string;
@@ -1494,6 +1499,7 @@ export declare class Action extends Base implements IAction {
 export declare class AdaptiveActionContainer<T extends Action = Action> extends ActionContainer<T> {
     protected dotsItem: Action;
     protected dotsItemPopupModel: PopupModel;
+    minVisibleItemsCount: number;
     constructor();
     protected onSet(): void;
     protected onPush(item: T): void;
@@ -1630,7 +1636,7 @@ export declare class SurveyRow extends SurveyElementBase<any, any> {
     componentDidMount(): void;
     shouldComponentUpdate(nextProps: any, nextState: any): boolean;
     componentWillUnmount(): void;
-    protected createElement(element: IElement): JSX.Element;
+    protected createElement(element: IElement, elementIndex?: number): JSX.Element;
 }
 
 export declare class SurveyPanel extends SurveyPanelBase {
@@ -2094,6 +2100,7 @@ export declare class SurveyButtonGroupItem extends SurveyElementBase<any, any> {
 
 export declare class SurveyQuestionCustom extends SurveyQuestionUncontrolledElement<QuestionCustomModel> {
     constructor(props: any);
+    protected getStateElements(): Array<Base>;
     protected renderElement(): JSX.Element;
 }
 export declare class SurveyQuestionComposite extends SurveyQuestionUncontrolledElement<QuestionCompositeModel> {
@@ -2118,6 +2125,7 @@ export declare class Popup extends SurveyElementBase<IPopupProps, any> {
     protected getStateElement(): PopupModel<any>;
     componentDidMount(): void;
     componentWillUnmount(): void;
+    shouldComponentUpdate(nextProps: IPopupProps): boolean;
     render(): JSX.Element;
 }
 export declare class PopupContainer extends SurveyElementBase<any, any> {
@@ -2147,6 +2155,7 @@ export declare class List extends SurveyElementBase<IListProps, any> {
     getStateElement(): ListModel;
     render(): JSX.Element;
     renderItems(): JSX.Element[];
+    searchElementContent(): JSX.Element;
 }
 export {};
 
@@ -2289,6 +2298,12 @@ export declare var settings: {
             * separator that can allow to set value and text of ItemValue object in one string as: "value|text"
             */
         itemValueSeparator: string;
+        /**
+            * Set it to true to serialize itemvalue instance always as object even if text property is empty
+            * const item = new Survey.ItemValue(5);
+            * item.toJSON(); //will return {value: 5}, instead of 5 by default.
+            */
+        itemValueAlwaysSerializeAsObject: boolean;
         /**
             * default locale name for localizable strings that uses during serialization, {"default": "My text", "de": "Mein Text"}
             */
@@ -2346,9 +2361,13 @@ export declare var settings: {
             */
         executeSkipTriggerOnValueChanged: boolean;
         /**
-            * Set this property to change readOnlyCommentRenderMode: "textarea" (default) or (div)
+            * Set this property to change readOnlyCommentRenderMode: "textarea" (default) or "div"
             */
         readOnlyCommentRenderMode: string;
+        /**
+            * Set this property to change readOnlyTextRenderMode: "input" (default) or "div"
+            */
+        readOnlyTextRenderMode: string;
         /**
             * Override this function, set your function, if you want to show your own dialog confirm window instead of standard browser window.
             * @param message
@@ -2443,6 +2462,8 @@ export declare class Helpers {
     static getNumberByIndex(index: number, startIndexStr: string): string;
     static isCharNotLetterAndDigit(ch: string): boolean;
     static isCharDigit(ch: string): boolean;
+    static correctAfterPlusMinis(a: number, b: number, res: number): number;
+    static correctAfterMultiple(a: number, b: number, res: number): number;
 }
 
 export declare class ValidatorResult {
@@ -2950,6 +2971,7 @@ export interface ISurvey extends ITextProcessor, ISurveyErrorOwner {
     updateQuestionCssClasses(question: IQuestion, cssClasses: any): any;
     updatePanelCssClasses(panel: IPanel, cssClasses: any): any;
     updatePageCssClasses(panel: IPanel, cssClasses: any): any;
+    updateChoiceItemCss(question: IQuestion, options: any): any;
     afterRenderQuestion(question: IQuestion, htmlElement: HTMLElement): any;
     afterRenderQuestionInput(question: IQuestion, htmlElement: HTMLElement): any;
     afterRenderPanel(panel: IElement, htmlElement: HTMLElement): any;
@@ -3027,6 +3049,7 @@ export interface IElement extends IConditionRunner, ISurveyElement {
     clearIncorrectValues(): any;
     clearErrors(): any;
     dispose(): void;
+    needResponsiveWidth(): boolean;
 }
 export interface IQuestion extends IElement, ISurveyErrorOwner {
     hasTitle: boolean;
@@ -3451,6 +3474,7 @@ export declare class LocalizableString implements ILocalizableString {
         static editableRenderer: string;
         localizationName: string;
         onGetTextCallback: (str: string) => string;
+        onGetDefaultTextCallback: () => string;
         onStrChanged: (oldValue: string, newValue: string) => void;
         onSearchChanged: () => void;
         sharedData: LocalizableString;
@@ -3596,7 +3620,7 @@ export declare class ChoicesRestful extends Base {
         getData(): any;
         /**
             * Gets or sets a link to a web service. You can use text preprocessing here.
-            * For example, the following url: _https://restcountries.eu/rest/v2/region/{region}_ is changed based on the _region_ question's value.
+            * For example, the following url: _https://surveyjs.io/api/CountriesExample?region={region}_ is changed based on the _region_ question's value.
             * SurveyJS automatically gets data from the web service when the value of the _region_ question changes.
             * @see path
             * @see valueName
@@ -3708,6 +3732,9 @@ export declare abstract class Operand {
     hasFunction(): boolean;
     hasAsyncFunction(): boolean;
     addToAsyncList(list: Array<FunctionOperand>): void;
+    isEqual(op: Operand): boolean;
+    protected abstract isContentEqual(op: Operand): boolean;
+    protected areOperatorsEquals(op1: Operand, op2: Operand): boolean;
 }
 export declare class BinaryOperand extends Operand {
     constructor(operatorName: string, left?: any, right?: any, isArithmeticOp?: boolean);
@@ -3718,6 +3745,7 @@ export declare class BinaryOperand extends Operand {
     get operator(): string;
     get leftOperand(): any;
     get rightOperand(): any;
+    protected isContentEqual(op: Operand): boolean;
     evaluate(processValue?: ProcessValue): any;
     toString(func?: (op: Operand) => string): string;
     setVariables(variables: Array<string>): void;
@@ -3731,6 +3759,7 @@ export declare class UnaryOperand extends Operand {
     get expression(): Operand;
     getType(): string;
     toString(func?: (op: Operand) => string): string;
+    protected isContentEqual(op: Operand): boolean;
     evaluate(processValue?: ProcessValue): boolean;
     setVariables(variables: Array<string>): void;
 }
@@ -3744,6 +3773,7 @@ export declare class ArrayOperand extends Operand {
     hasFunction(): boolean;
     hasAsyncFunction(): boolean;
     addToAsyncList(list: Array<FunctionOperand>): void;
+    protected isContentEqual(op: Operand): boolean;
 }
 export declare class Const extends Operand {
     constructor(value: any);
@@ -3753,6 +3783,7 @@ export declare class Const extends Operand {
     evaluate(): any;
     setVariables(variables: Array<string>): void;
     protected getCorrectValue(value: any): any;
+    protected isContentEqual(op: Operand): boolean;
 }
 export declare class Variable extends Const {
     static DisableConversionChar: string;
@@ -3763,6 +3794,7 @@ export declare class Variable extends Const {
     evaluate(processValue?: ProcessValue): any;
     setVariables(variables: Array<string>): void;
     protected getCorrectValue(value: any): any;
+    protected isContentEqual(op: Operand): boolean;
 }
 export declare class FunctionOperand extends Operand {
     onAsyncReady: () => void;
@@ -3776,6 +3808,7 @@ export declare class FunctionOperand extends Operand {
     hasFunction(): boolean;
     hasAsyncFunction(): boolean;
     addToAsyncList(list: Array<FunctionOperand>): void;
+    protected isContentEqual(op: Operand): boolean;
 }
 export declare class OperandMaker {
     static throwInvalidOperatorError(op: string): void;
@@ -3819,8 +3852,9 @@ export interface IPropertyDecoratorOptions {
         defaultValue?: any;
         defaultSource?: string;
         localizable?: {
-                name: string;
+                name?: string;
                 onGetTextCallback?: (str: string) => string;
+                defaultStr?: string;
         } | boolean;
         onSet?: (val: any, target: any) => void;
 }
@@ -4155,6 +4189,10 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
         dispose(): void;
         get hasSingleInput(): boolean;
         get isRowsDynamic(): boolean;
+        protected get isUpdateLocked(): boolean;
+        beginUpdate(): void;
+        endUpdate(): void;
+        protected updateColumnsAndRows(): void;
         itemValuePropertyChanged(item: ItemValue, name: string, oldValue: any, newValue: any): void;
         /**
             * Set columnLayout to 'vertical' to place columns vertically and rows horizontally. It makes sense when we have many columns and few rows.
@@ -4507,7 +4545,6 @@ export declare class QuestionMatrixDropdownRenderedCell {
     panel: PanelModel;
     isShowHideDetail: boolean;
     isActionsCell: boolean;
-    className: string;
     isDragHandlerCell: boolean;
     constructor();
     get hasQuestion(): boolean;
@@ -4522,7 +4559,8 @@ export declare class QuestionMatrixDropdownRenderedCell {
     get choiceValue(): any;
     get isCheckbox(): boolean;
     get isFirstChoice(): boolean;
-    get css(): string;
+    set className(val: string);
+    get className(): string;
     get headers(): string;
     calculateFinalClassName(matrixCssClasses: any): string;
 }
@@ -4530,6 +4568,7 @@ export declare class QuestionMatrixDropdownRenderedRow extends Base {
     cssClasses: any;
     isDetailRow: boolean;
     ghostPosition: string;
+    isAdditionalClasses: boolean;
     row: MatrixDropdownRowModelBase;
     cells: Array<QuestionMatrixDropdownRenderedCell>;
     constructor(cssClasses: any, isDetailRow?: boolean);
@@ -5402,8 +5441,9 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
         onAnyValueChanged(name: string): void;
         checkBindings(valueName: string, value: any): void;
         protected dragDropAddTarget(dragDropInfo: DragDropInfo): void;
-        protected dragDropFindRow(findElement: ISurveyElement): QuestionRowModel;
+        dragDropFindRow(findElement: ISurveyElement): QuestionRowModel;
         dragDropMoveElement(src: IElement, target: IElement, targetIndex: number): void;
+        needResponsiveWidth(): boolean;
         get no(): string;
         dispose(): void;
 }
@@ -5527,6 +5567,7 @@ export declare class PanelModel extends PanelModelBase implements IElement {
         get cssError(): string;
         protected getCssError(cssClasses: any): string;
         protected onVisibleChanged(): void;
+        needResponsiveWidth(): boolean;
 }
 
 /**
@@ -6207,6 +6248,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
         get validatedValue(): any;
         set validatedValue(val: any);
         getAllValues(): any;
+        needResponsiveWidth(): boolean;
 }
 
 /**
@@ -6463,6 +6505,7 @@ export declare class QuestionSelectBase extends Question {
         getColumnClass(): string;
         getItemIndex(item: any): number;
         getItemClass(item: any): string;
+        protected getItemClassCore(item: any, options: any): string;
         getLabelClass(item: ItemValue): string;
         getControlLabelClass(item: ItemValue): string;
         get columns(): ItemValue[][];
@@ -6546,7 +6589,7 @@ export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
         get selectedItems(): Array<ItemValue>;
         protected onEnableItemCallBack(item: ItemValue): boolean;
         protected onAfterRunItemsEnableCondition(): void;
-        getItemClass(item: any): string;
+        protected getItemClassCore(item: any, options: any): string;
         protected setNewValue(newValue: any): void;
         protected getIsMultipleValue(): boolean;
         protected getCommentFromValue(newValue: any): string;
@@ -6580,7 +6623,7 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
     constructor(name: string);
     getType(): string;
     get rootClass(): string;
-    getItemClass(item: ItemValue): string;
+    protected getItemClassCore(item: ItemValue, options: any): string;
     protected isItemCurrentDropTarget(item: ItemValue): boolean;
     get ghostPositionCssClass(): string;
     getNumberByIndex(index: number): string;
@@ -6622,10 +6665,10 @@ export declare class QuestionCommentModel extends QuestionTextBase {
         get cols(): number;
         set cols(val: number);
         /**
-            * Returns or sets a boolean that specifies whether a question can accept and display multiple lines of text.
+            * Accepts pressing the Enter key by end-users and accepts carriage return symbols - \n - in the question value assigned.
             */
-        get multiLine(): boolean;
-        set multiLine(val: boolean);
+        get acceptCarriageReturn(): boolean;
+        set acceptCarriageReturn(val: boolean);
         /**
             * Specifies whether the question's text area automatically expands its height to avoid the vertical scrollbar and to display the entire multi-line contents entered by respondents.
             * Default value is false.
@@ -7120,6 +7163,7 @@ export declare class QuestionTextModel extends QuestionTextBase {
         protected setNewValue(newValue: any): void;
         protected correctValueType(newValue: any): any;
         protected hasPlaceHolder(): boolean;
+        isReadOnlyRenderDiv(): boolean;
         get inputStyle(): any;
 }
 
@@ -7899,6 +7943,16 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
             * @see onMatrixCellValueChanged
             */
         onValueChanged: EventBase<SurveyModel>;
+        /**
+            * The event is fired when setVariable function is called. It can be called on changing a calculated value.
+            * <br/> `sender` - the survey object that fires the event.
+            * <br/> `options.name` - the variable name that has been changed.
+            * <br/> `options.value` - a new value.
+            * @see setVariable
+            * @see onValueChanged
+            * @see calculatedValues
+            */
+        onVariableChanged: EventBase<SurveyModel>;
         /**
             * The event is fired when a question visibility has been changed.
             * <br/> `sender` - the survey object that fires the event.
@@ -8207,6 +8261,14 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
             * <br/> `options.cssClasses` - an object with CSS classes. For example `{title: "sv_p_title", description: "small"}`. You can change them to your own CSS classes.
             */
         onUpdatePageCssClasses: EventBase<SurveyModel>;
+        /**
+            * The event is fired before rendering a choice item in radiogroup, checkbox or dropdown questions. Use it to override the default choice item css.
+            * <br/> `sender` - the survey object that fires the event.
+            * <br/> `options.question` - a question where choice item is rendered.
+            * <br/> `options.item` - a choice item of ItemValue type. You can get value or text choice properties as options.item.value or options.choice.text
+            * <br/> `options.css` - a string with css classes divided by space. You can change it.
+            */
+        onUpdateChoiceItemCss: EventBase<SurveyModel>;
         /**
             * The event is fired right after survey is rendered in DOM.
             * <br/> `sender` - the survey object that fires the event.
@@ -8857,6 +8919,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
         get logoFit(): string;
         set logoFit(val: string);
         setIsMobile(newVal?: boolean): void;
+        protected isLogoImageChoosen(): string;
         get titleMaxWidth(): string;
         /**
             * Gets or sets the HTML content displayed on the complete page. Use this property to change the default complete page text.
@@ -9498,6 +9561,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
         updateQuestionCssClasses(question: IQuestion, cssClasses: any): void;
         updatePanelCssClasses(panel: IPanel, cssClasses: any): void;
         updatePageCssClasses(page: IPage, cssClasses: any): void;
+        updateChoiceItemCss(question: IQuestion, options: any): void;
         afterRenderPage(htmlElement: HTMLElement): void;
         afterRenderHeader(htmlElement: HTMLElement): void;
         afterRenderQuestion(question: IQuestion, htmlElement: HTMLElement): void;
@@ -9818,6 +9882,18 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
             */
         get showTimerPanelMode(): string;
         set showTimerPanelMode(val: string);
+        /**
+             * Gets or sets a value that specifies how the survey width is calculated.
+             *
+             * The available options:
+             *
+             * - `static` - A survey has a fixed width that mostly depends upon the applied theme. Resizing a browser window does not affect the survey width.
+             * - `responsive` - A survey takes all available horizontal space. A survey stretches or shrinks horizonally according to the screen size.
+             * - `auto` - Depends on the question type and corresponds to the static or responsive mode.
+         */
+        get widthMode(): string;
+        set widthMode(val: string);
+        calculateWidthMode(): string;
         get timerInfoText(): string;
         /**
             * Starts a timer that will calculate how much time end-user spends on the survey or on pages.
@@ -10194,6 +10270,7 @@ export declare var englishStrings: {
     questionTitlePatternText: string;
     modalCancelButtonText: string;
     modalApplyButtonText: string;
+    filteredTextPlaceholder: string;
 };
 
 export declare var surveyLocalization: {
@@ -10294,6 +10371,7 @@ export declare var surveyStrings: {
     questionTitlePatternText: string;
     modalCancelButtonText: string;
     modalApplyButtonText: string;
+    filteredTextPlaceholder: string;
 };
 
 export declare class QuestionCustomWidget {
@@ -10489,21 +10567,25 @@ export declare class StylesManager {
     initializeStyles(sheet: CSSStyleSheet): void;
 }
 
-export declare class ListModel extends Base {
-    onItemSelect: (item: IAction) => void;
+export declare class ListModel extends ActionContainer {
+    onItemSelect: (item: Action) => void;
     allowSelection: boolean;
+    needFilter: boolean;
     isExpanded: boolean;
     selectedItem: IAction;
+    filteredText: string;
     static INDENT: number;
-    constructor(items: Array<IAction>, onItemSelect: (item: IAction) => void, allowSelection: boolean, selectedItem?: IAction);
-    get items(): Array<IAction>;
-    set items(value: Array<IAction>);
-    selectItem: (itemValue: IAction) => void;
-    isItemDisabled: (itemValue: IAction) => boolean;
-    isItemSelected: (itemValue: IAction) => boolean;
-    getItemClass: (itemValue: IAction) => string;
+    static MINELEMENTCOUNT: number;
+    constructor(items: Array<IAction>, onItemSelect: (item: Action) => void, allowSelection: boolean, selectedItem?: IAction, onFilteredTextChange?: (text: string) => void);
+    protected onSet(): void;
+    selectItem: (itemValue: Action) => void;
+    isItemDisabled: (itemValue: Action) => boolean;
+    isItemSelected: (itemValue: Action) => boolean;
+    getItemClass: (itemValue: Action) => string;
     getItemIndent: (itemValue: any) => string;
+    get filteredTextPlaceholder(): any;
     onKeyDown(event: KeyboardEvent): void;
+    refresh(): void;
 }
 
 export declare class PopupModel<T = any> extends Base {
@@ -10651,6 +10733,7 @@ export declare class DragDropChoices extends DragDropCore<QuestionSelectBase> {
     protected calculateIsBottom(clientY: number): boolean;
     protected afterDragOver(dropTargetNode: HTMLElement): void;
     protected doDrop(): any;
+    protected doClear(): void;
 }
 
 export declare class SurveyPanelBase extends SurveyElementBase<any, any> {
@@ -10740,6 +10823,7 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
         protected clearGeneratedRows(): void;
         clearIncorrectValues(): void;
         protected clearInvisibleValuesInRows(): void;
+        needResponsiveWidth(): boolean;
 }
 
 export declare class DragDropMatrixRows extends DragDropCore<QuestionMatrixDynamicModel> {
@@ -10748,11 +10832,13 @@ export declare class DragDropMatrixRows extends DragDropCore<QuestionMatrixDynam
     protected getShortcutText(draggedElement: any): string;
     protected getDropTargetByDataAttributeValue(dataAttributeValue: any): MatrixDropdownRowModelBase;
     protected isDropTargetValid(dropTarget: any): boolean;
+    protected findDropTargetNodeByDragOverNode(dragOverNode: HTMLElement): HTMLElement;
     protected calculateIsBottom(clientY: number): boolean;
     protected doDrop: () => QuestionMatrixDynamicModel;
 }
 
 export declare class DragDropRankingChoices extends DragDropChoices {
+    protected get draggedElementType(): string;
     protected createDraggedElementShortcut(text: string, draggedElementNode: HTMLElement): HTMLElement;
     protected getDropTargetByDataAttributeValue(dataAttributeValue: string): ItemValue;
     protected isDropTargetValid(dropTarget: ItemValue, isBottom: boolean, dropTargetNode?: HTMLElement): boolean;
@@ -10847,7 +10933,7 @@ export declare abstract class DragDropCore<T> extends Base {
     dropTarget: any;
     protected get dropTargetDataAttributeName(): string;
     protected get survey(): SurveyModel;
-    protected prevDropTarget: any;
+    prevDropTarget: any;
     protected draggedElementShortcut: HTMLElement;
     constructor(surveyValue?: ISurvey, creator?: any);
     startDrag(event: PointerEvent, draggedElement: any, parentElement?: any, draggedElementNode?: HTMLElement): void;