survey-react 1.9.71 → 1.9.74

package/survey.react.d.ts

@@ -215,7 +215,7 @@ declare module "settings" {
          */
         customIcons: {};
         /**
-         * Specifies which part of a choice item item responds to a drag gesture in Ranking questions.
+         * Specifies which part of a choice item responds to a drag gesture in Ranking questions.
          *
          * Possible values:
          *
@@ -253,6 +253,8 @@ declare module "helpers" {
         static createCopy(obj: any): any;
         static isConvertibleToNumber(value: any): boolean;
         static isNumber(value: any): boolean;
+        static getNumber(value: any): number;
+        private static prepareStringToNumber;
         static getMaxLength(maxLength: number, surveyLength: number): any;
         static getNumberByIndex(index: number, startIndexStr: string): string;
         static isCharNotLetterAndDigit(ch: string): boolean;
@@ -1111,7 +1113,7 @@ declare module "conditions" {
         /**
          * The expression as string, property with get
          */
-        get expression(): string;
+        expression: string;
         /**
          * Returns true if the expression is valid and can be executed
          */
@@ -2700,6 +2702,7 @@ declare module "defaultCss/defaultV2Css" {
             controlDisabled: string;
             controlEmpty: string;
             filterStringInput: string;
+            popup: string;
             onError: string;
         };
         comment: {
@@ -3143,7 +3146,7 @@ declare module "surveytimer" {
         static get instance(): SurveyTimer;
         private listenerCounter;
         private timerId;
-        onTimer: Event<() => any, any>;
+        onTimer: Event<() => any, SurveyTimer, any>;
         start(func?: () => any): void;
         stop(func?: () => any): void;
         doTimer(): void;
@@ -3790,6 +3793,7 @@ declare module "question_baseselect" {
          */
         get colCount(): number;
         set colCount(value: number);
+        clickItemHandler(item: ItemValue, checked: boolean): void;
         protected onParentChanged(): void;
         protected onParentQuestionChanged(): void;
         protected getSearchableItemValueKeys(keys: Array<string>): void;
@@ -3914,7 +3918,6 @@ declare module "question_paneldynamic" {
         private loadingPanelCount;
         private isValueChangingInternally;
         private changingValueQuestion;
-        private currentIndexValue;
         renderModeChangedCallback: () => void;
         panelCountChangedCallback: () => void;
         currentIndexChangedCallback: () => void;
@@ -3989,6 +3992,8 @@ declare module "question_paneldynamic" {
          */
         get currentIndex(): number;
         set currentIndex(val: number);
+        private get currentIndexValue();
+        private set currentIndexValue(value);
         /**
          * A `PanelModel` object that is the currently displayed panel.
          *
@@ -4930,6 +4935,19 @@ declare module "survey" {
          * @see QuestionHtmlModel.html
          */
         onProcessHtml: EventBase<SurveyModel>;
+        /**
+         * Use this event to change a question's display text.
+         *
+         * Parameters:
+         *
+         * - `sender`: `SurveyModel`\
+         * A survey instance that raised the event.
+         * - `options.question`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+         * A Question instance for which the event is raised.
+         * - `options.displayValue`: `String`\
+         * A question's display text. You can assign a custom value to this parameter.
+         */
+        onGetQuestionDisplayValue: EventBase<SurveyModel>;
         /**
          * Use this event to change the question title in code. If you want to remove question numbering then set showQuestionNumbers to "off".
          * - `sender`: `SurveyModel` - A survey instance that raised the event.
@@ -5369,6 +5387,20 @@ declare module "survey" {
          * @see QuestionMatrixDropdownModel
          */
         onMatrixCellValidate: EventBase<SurveyModel>;
+        /**
+         * An event that is raised on adding a new column in Matrix Dynamic or Matrix Dropdown question.
+         * - `sender`: `SurveyModel` - A survey instance that raised the event.
+         * - `options.question` - a matrix question.
+         * - `options.column` - a new added column.
+         */
+        onMatrixColumnAdded: EventBase<SurveyModel>;
+        /**
+         * An event that is raised on adding a new item in Multiple Text question.
+         * - `sender`: `SurveyModel` - A survey instance that raised the event.
+         * - `options.question` - a multiple text question.
+         * - `options.item` - a new added item.
+         */
+        onMultipleTextItemAdded: EventBase<SurveyModel>;
         /**
          * An event that is raised after a new panel is added to a [Dynamic Panel](https://surveyjs.io/form-library/examples/questiontype-paneldynamic/) question.
          *
@@ -5887,6 +5919,7 @@ declare module "survey" {
         getLocString(str: string): string;
         getErrorCustomText(text: string, error: SurveyError): string;
         getSurveyErrorCustomText(obj: Base, text: string, error: SurveyError): string;
+        getQuestionDisplayValue(question: IElement, displayValue: any): any;
         /**
          * Returns the text displayed when a survey has no visible pages and questions.
          */
@@ -6088,7 +6121,7 @@ declare module "survey" {
          *
          * [View Demo](https://surveyjs.io/form-library/examples/survey-options/ (linkStyle))
          */
-        get showQuestionNumbers(): string;
+        get showQuestionNumbers(): string | boolean;
         set showQuestionNumbers(value: string | boolean);
         /**
          * Gets or sets the survey progress bar position.
@@ -6735,6 +6768,8 @@ declare module "survey" {
         }): void;
         matrixBeforeRowAdded(options: any): void;
         matrixRowAdded(question: IQuestion, row: any): void;
+        matrixColumnAdded(question: IQuestion, column: any): void;
+        multipleTextItemAdded(question: IQuestion, item: any): void;
         getQuestionByValueNameFromArray(valueName: string, name: string, index: number): IQuestion;
         matrixRowRemoved(question: IQuestion, rowIndex: number, row: any): void;
         matrixRowRemoving(question: IQuestion, rowIndex: number, row: any): boolean;
@@ -7938,7 +7973,7 @@ declare module "questionCustomWidgets" {
         static Instance: CustomWidgetCollection;
         private widgetsValues;
         private widgetsActivatedBy;
-        onCustomWidgetAdded: Event<(customWidget: QuestionCustomWidget) => any, any>;
+        onCustomWidgetAdded: Event<(customWidget: QuestionCustomWidget) => any, QuestionCustomWidget, any>;
         get widgets(): Array<QuestionCustomWidget>;
         add(widgetJson: any, activatedBy?: string): void;
         addCustomWidget(widgetJson: any, activatedBy?: string): QuestionCustomWidget;
@@ -8015,6 +8050,7 @@ declare module "question" {
         afterRenderQuestionCallback: (question: Question, element: any) => any;
         valueFromDataCallback: (val: any) => any;
         valueToDataCallback: (val: any) => any;
+        onUpdateCssClassesCallback: (css: any) => void;
         onGetSurvey: () => ISurvey;
         private locProcessedTitle;
         protected isReadyValue: boolean;
@@ -9074,7 +9110,7 @@ declare module "dragdrop/core" {
         private creator?;
         private longTap?;
         isBottom: boolean;
-        onGhostPositionChanged: EventBase<Base>;
+        onGhostPositionChanged: EventBase<{}>;
         protected ghostPositionChanged(): void;
         static PreventScrolling: boolean;
         onBeforeDrop: EventBase<DragDropCore<T>>;
@@ -10125,6 +10161,7 @@ declare module "base-interfaces" {
         requiredText: string;
         beforeSettingQuestionErrors(question: IQuestion, errors: Array<SurveyError>): void;
         beforeSettingPanelErrors(question: IPanel, errors: Array<SurveyError>): void;
+        getQuestionDisplayValue(question: IElement, displayValue: any): any;
         getSurveyErrorCustomText(obj: Base, text: string, error: SurveyError): string;
         getElementTitleTagName(element: Base, tagName: string): string;
         questionTitlePattern: string;
@@ -10170,6 +10207,7 @@ declare module "base-interfaces" {
             setItems: (displayValues: Array<string>) => void;
         }): void;
         matrixRowAdded(question: IQuestion, row: any): any;
+        matrixColumnAdded(question: IQuestion, column: any): void;
         matrixBeforeRowAdded(options: {
             question: IQuestion;
             canAddRow: boolean;
@@ -10184,6 +10222,7 @@ declare module "base-interfaces" {
         matrixCellValueChanging(question: IQuestion, options: any): any;
         isValidateOnValueChanging: boolean;
         isValidateOnValueChanged: boolean;
+        multipleTextItemAdded(question: IQuestion, item: any): void;
         matrixCellValidate(question: IQuestion, options: any): SurveyError;
         dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): void;
         dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): void;
@@ -10224,8 +10263,8 @@ declare module "base-interfaces" {
         toggleState(): void;
         stateChangedCallback(): void;
         getTitleToolbar(): AdaptiveActionContainer;
-        get isCollapsed(): boolean;
-        get isExpanded(): boolean;
+        isCollapsed: boolean;
+        isExpanded: boolean;
         expand(): void;
         collapse(): void;
     }
@@ -10500,10 +10539,10 @@ declare module "base" {
          * The name of the property to which an array of `ItemValue` objects is assigned (for example, `"choices"` or `"rows"`).
          * - `options.name`: `"text"` | `"value"`\
          * The name of the changed property.
-         * - `options.newValue: `any`\
+         * - `options.newValue`: `any`\
          * A new value for the property.
          */
-        onItemValuePropertyChanged: Event<(sender: Base, options: any) => any, any>;
+        onItemValuePropertyChanged: Event<(sender: Base, options: any) => any, Base, any>;
         getPropertyValueCoreHandler: (propertiesHash: any, name: string) => any;
         setPropertyValueCoreHandler: (propertiesHash: any, name: string, val: any) => void;
         createArrayCoreHandler: (propertiesHash: any, name: string) => Array<any>;
@@ -10512,7 +10551,7 @@ declare module "base" {
         constructor();
         dispose(): void;
         get isDisposed(): boolean;
-        protected addEvent<T>(): EventBase<T>;
+        protected addEvent<T, Options = any>(): EventBase<T, Options>;
         protected onBaseCreating(): void;
         /**
          * Returns the object type as it is used in the JSON schema.
@@ -10671,20 +10710,20 @@ declare module "base" {
         deletedItems: any[];
         constructor(index: number, deleteCount: number, itemsToAdd: any[], deletedItems: any[]);
     }
-    export class Event<T extends Function, Options> {
+    export class Event<CallbackFunction extends Function, Sender, Options> {
         onCallbacksChanged: () => void;
-        protected callbacks: Array<T>;
+        protected callbacks: Array<CallbackFunction>;
         get isEmpty(): boolean;
         get length(): number;
         fireByCreatingOptions(sender: any, createOptions: () => Options): void;
-        fire(sender: any, options: Options): void;
+        fire(sender: Sender, options: Options): void;
         clear(): void;
-        add(func: T): void;
-        remove(func: T): void;
-        hasFunc(func: T): boolean;
+        add(func: CallbackFunction): void;
+        remove(func: CallbackFunction): void;
+        hasFunc(func: CallbackFunction): boolean;
         private fireCallbackChanged;
     }
-    export class EventBase<T> extends Event<(sender: T, options: any) => any, any> {
+    export class EventBase<Sender, Options = any> extends Event<(sender: Sender, options: Options) => any, Sender, Options> {
     }
 }
 declare module "validator" {
@@ -10905,7 +10944,10 @@ declare module "dropdownListModel" {
         readonly minPageSize = 25;
         readonly loadingItemHeight = 40;
         private _popupModel;
-        private focusFirstInputSelector;
+        private get focusFirstInputSelector();
+        protected readonly selectedItemSelector = ".sv-list__item--selected";
+        protected readonly itemSelector = ".sv-list__item";
+        protected getFocusFirstInputSelector(): string;
         private itemsSettings;
         private isRunningLoadQuestionChoices;
         protected listModel: ListModel;
@@ -10933,6 +10975,7 @@ declare module "dropdownListModel" {
         get popupModel(): PopupModel;
         get inputReadOnly(): boolean;
         get filterStringEnabled(): boolean;
+        get inputMode(): "none" | "text";
         setSearchEnabled(newValue: boolean): void;
         updateItems(): void;
         onClick(event: any): void;
@@ -11400,6 +11443,11 @@ declare module "question_multipletext" {
         getItemDefaultValue(name: string): any;
         getIsRequiredText(): string;
     }
+    /**
+     * A class that describes an item in a [Multiple Text](https://surveyjs.io/form-library/documentation/api-reference/multiple-text-entry-question-model) question.
+     *
+     * [View Demo](/form-library/examples/multiple-text-box-question/)
+     */
     export class MultipleTextItemModel extends Base implements IValidatorOwner, ISurveyData, ISurveyImpl {
         private editorValue;
         private data;
@@ -11520,7 +11568,18 @@ declare module "question_multipletext" {
         private editorsOnSurveyLoad;
         private performForEveryEditor;
         /**
-         * An array of `MultipleTextItemModel` objects that represent input items.
+         * Gets or sets an array of `MultipleTextItemModel` objects that represent input items.
+         *
+         * This property accepts an array of objects with the following structure:
+         *
+         * ```js
+         * {
+         *   "name": any, // A unique value used to identify an input item and save an item value to survey results.
+         *   "title": String // An item caption. When `title` is undefined, `name` is used. This property supports Markdown.
+         * }
+         * ```
+         *
+         * To enable Markdown support for the `title` property, implement Markdown-to-HTML conversion in the [onTextMarkdown](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#onTextMarkdown) event handler. For an example, refer to the following demo: [Convert Markdown to HTML with Showdown](https://surveyjs.io/form-library/examples/edit-survey-questions-markdown/).
          * @see addItem
          */
         get items(): Array<MultipleTextItemModel>;
@@ -11818,6 +11877,7 @@ declare module "dropdownMultiSelectListModel" {
         private updateListState;
         private syncFilterStringPlaceholder;
         private getSelectedActions;
+        protected getFocusFirstInputSelector(): string;
         protected createListModel(): MultiSelectListModel;
         previousValue: any;
         doneButtonCaption: string;
@@ -12071,7 +12131,6 @@ declare module "question_ranking" {
     import { DragDropRankingChoices } from "dragdrop/ranking-choices";
     import { ItemValue } from "itemvalue";
     import { QuestionCheckboxModel } from "question_checkbox";
-    import { QuestionSelectBase } from "question_baseselect";
     /**
      * A class that describes the Ranking question type.
      *
@@ -12114,10 +12173,6 @@ declare module "question_ranking" {
         private handleArrowDown;
         private focusItem;
         setValue: () => void;
-        protected getChoicesFromQuestion(question: QuestionSelectBase): Array<ItemValue>;
-        private setValueFromUI;
-        private syncNumbers;
-        private setGhostText;
         getIconHoverCss(): string;
         getIconFocusCss(): string;
         /**
@@ -12329,6 +12384,7 @@ declare module "question_file" {
         getFileDecoratorCss(): string;
         private onChange;
         protected onChangeQuestionValue(newValue: any): void;
+        endLoadingFromJson(): void;
         private rootElement;
         afterRender(el: HTMLElement): void;
         private dragCounter;
@@ -12406,6 +12462,7 @@ declare module "question_radiogroup" {
         get clearButtonCaption(): string;
         supportGoNextPageAutomatic(): boolean;
         get showClearButtonInContent(): boolean;
+        clickItemHandler(item: ItemValue): void;
         protected getDefaultTitleActions(): Array<Action>;
     }
 }
@@ -12414,6 +12471,7 @@ declare module "question_rating" {
     import { Question } from "question";
     import { LocalizableString } from "localizablestring";
     import { Base } from "base";
+    import { DropdownListModel } from "dropdownListModel";
     export class RenderedRatingItem extends Base {
         itemValue: ItemValue;
         private locString;
@@ -12553,7 +12611,7 @@ declare module "question_rating" {
         get locPlaceholder(): LocalizableString;
         get allowClear(): boolean;
         get searchEnabled(): boolean;
-        get renderedValue(): boolean;
+        get renderedValue(): any;
         set renderedValue(val: any);
         isItemSelected(item: ItemValue): boolean;
         get visibleChoices(): ItemValue[];
@@ -12562,11 +12620,17 @@ declare module "question_rating" {
         protected supportResponsiveness(): boolean;
         protected getCompactRenderAs(): string;
         protected getDesktopRenderAs(): string;
+        private dropdownListModelValue;
+        set dropdownListModel(val: DropdownListModel);
+        get dropdownListModel(): DropdownListModel;
+        protected updateCssClasses(res: any, css: any): void;
+        protected calcCssClasses(css: any): any;
     }
 }
 declare module "question_boolean" {
     import { Question } from "question";
     import { LocalizableString } from "localizablestring";
+    import { ActionContainer } from "actions/container";
     /**
      * A class that describes the Boolean question type.
      *
@@ -12658,6 +12722,7 @@ declare module "question_boolean" {
         getRadioItemClass(css: any, value: any): string;
         protected supportResponsiveness(): boolean;
         protected getCompactRenderAs(): string;
+        protected createActionContainer(allowAdaptiveActions?: boolean): ActionContainer;
     }
 }
 declare module "question_image" {
@@ -13000,6 +13065,19 @@ declare module "question_custom" {
          * An HTML element that represents a nested question.
          */
         onAfterRenderContentElement?(question: Question, element: Question, htmlElement: any): void;
+        /**
+         * A function that is called each time a question nested within a [composite question](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types) requires an update of its CSS classes.
+         *
+         * Parameters:
+         *
+         * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question)\
+         * A composite question.
+         * - `element`: [Question](https://surveyjs.io/Documentation/Library?id=Question)\
+         * A nested question.
+         * - `cssClasses`: `any`\
+         * An object with CSS classes applied to a nested question, for example, `{ root: "class1", button: "class2" }`. You can modify this object to apply custom CSS classes.
+         */
+        onUpdateQuestionCssClasses?(question: Question, element: Question, cssClasses: any): void;
         /**
          * A function that is called when a custom question type property is changed. Use it to handle property changes.
          *
@@ -13084,6 +13162,7 @@ declare module "question_custom" {
         onLoaded(question: Question): void;
         onAfterRender(question: Question, htmlElement: any): void;
         onAfterRenderContentElement(question: Question, element: Question, htmlElement: any): void;
+        onUpdateQuestionCssClasses(question: Question, element: Question, css: any): void;
         onPropertyChanged(question: Question, propertyName: string, newValue: any): void;
         onValueChanged(question: Question, name: string, newValue: any): void;
         onItemValuePropertyChanged(question: Question, item: ItemValue, propertyName: string, name: string, newValue: any): void;
@@ -13120,6 +13199,7 @@ declare module "question_custom" {
         onSurveyLoad(): void;
         afterRenderQuestionElement(el: HTMLElement): void;
         afterRender(el: any): void;
+        protected onUpdateQuestionCssClasses(element: Question, css: any): void;
         protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
         protected setNewValue(newValue: any): void;
         getSurveyData(): ISurveyData;
@@ -13267,6 +13347,9 @@ declare module "popup-dropdown-view-model" {
         targetElement?: HTMLElement;
         private scrollEventCallBack;
         private resizeEventCallback;
+        private clientY;
+        private touchStartEventCallback;
+        private touchMoveEventCallback;
         private _updatePosition;
         protected getActualHorizontalPosition(): "left" | "center" | "right";
         protected getStyleClass(): CssClassBuilder;
@@ -18095,6 +18178,7 @@ declare module "localization/portuguese" {
         noneItemText: string;
         selectAllItemText: string;
         progressText: string;
+        indexText: string;
         panelDynamicProgressText: string;
         questionsProgressText: string;
         emptySurvey: string;
@@ -18102,11 +18186,14 @@ declare module "localization/portuguese" {
         completingSurveyBefore: string;
         loadingSurvey: string;
         placeholder: string;
+        ratingOptionsCaption: string;
         value: string;
         requiredError: string;
         requiredErrorInPanel: string;
         requiredInAllRowsError: string;
         numericError: string;
+        minError: string;
+        maxError: string;
         textMinLength: string;
         textMaxLength: string;
         textMinMaxLength: string;
@@ -18126,16 +18213,19 @@ declare module "localization/portuguese" {
         loadingFile: string;
         chooseFile: string;
         noFileChosen: string;
+        fileDragAreaPlaceholder: string;
         confirmDelete: string;
         keyDuplicationError: string;
         addColumn: string;
         addRow: string;
         removeRow: string;
+        emptyRowsText: string;
         addPanel: string;
         removePanel: string;
         choices_Item: string;
         matrix_column: string;
         matrix_row: string;
+        multipletext_itemname: string;
         savingData: string;
         savingDataError: string;
         savingDataSuccess: string;
@@ -18149,6 +18239,7 @@ declare module "localization/portuguese" {
         timerLimitPage: string;
         timerLimitSurvey: string;
         clearCaption: string;
+        signaturePlaceHolder: string;
         chooseFileCaption: string;
         removeFileCaption: string;
         booleanCheckedLabel: string;
@@ -18156,6 +18247,13 @@ declare module "localization/portuguese" {
         confirmRemoveFile: string;
         confirmRemoveAllFiles: string;
         questionTitlePatternText: string;
+        modalCancelButtonText: string;
+        modalApplyButtonText: string;
+        filterStringPlaceholder: string;
+        emptyMessage: string;
+        noEntriesText: string;
+        more: string;
+        tagboxDoneButtonCaption: string;
     };
 }
 declare module "localization/portuguese-br" {