survey-react 1.11.4 → 1.11.6

package/survey.react.d.ts

@@ -191,6 +191,9 @@ declare module "surveyStrings" {
         localeNames: {
             [index: string]: any;
         };
+        localeDirections: {
+            [index: string]: any;
+        };
         supportedLocales: any[];
         currentLocale: string;
         defaultLocale: string;
@@ -989,6 +992,7 @@ declare module "list" {
         searchClearButtonIcon: string;
         loadingIndicator: string;
         itemSelected: string;
+        itemGroup: string;
         itemWithIcon: string;
         itemDisabled: string;
         itemFocused: string;
@@ -1059,6 +1063,7 @@ declare module "list" {
             searchClearButtonIcon: string;
             loadingIndicator: string;
             itemSelected: string;
+            itemGroup: string;
             itemWithIcon: string;
             itemDisabled: string;
             itemFocused: string;
@@ -1174,6 +1179,7 @@ declare module "actions/action" {
          * [View Demo](https://surveyjs.io/form-library/examples/add-custom-navigation-button/ (linkStyle))
          */
         action?: (context?: any) => void;
+        onFocus?: (isMouse: boolean, event: any) => void;
         /**
          * One or several CSS classes that you want to apply to the outer `<div>` element.
          *
@@ -1328,6 +1334,7 @@ declare module "actions/action" {
         get disabled(): boolean;
         get canShrink(): boolean;
         get hasTitle(): boolean;
+        get hasSubItems(): boolean;
         getActionBarItemTitleCss(): string;
         getActionBarItemCss(): string;
         getActionRootCss(): string;
@@ -1360,13 +1367,14 @@ declare module "actions/action" {
         private raiseUpdate;
         constructor(innerItem: IAction);
         private createLocTitle;
-        setItems(items: Array<IAction>, onSelectionChanged?: (item: Action, ...params: any[]) => void): void;
+        setSubItems(options: IListModel): void;
         location?: string;
         id: string;
         private _visible;
         locTooltipName?: string;
         private _enabled;
         action: (context?: any, isUserAction?: boolean) => void;
+        onFocus: (isMouse: boolean, event: any) => void;
         _component: string;
         items: any;
         _title: string;
@@ -1377,6 +1385,10 @@ declare module "actions/action" {
         get locTitleName(): string;
         set locTitleName(val: string);
         locStrsChanged(): void;
+        doAction(args: any): boolean;
+        private isMouseDown;
+        doMouseDown(): void;
+        doFocus(args: any): void;
         private locStrChangedInPopupModel;
         private locTitleChanged;
         private locTooltipChanged;
@@ -1555,6 +1567,7 @@ declare module "defaultCss/defaultV2Css" {
             titleExpanded: string;
             titleCollapsed: string;
             titleDisabled: string;
+            titleHidden: string;
             titleOnExpand: string;
             titleOnError: string;
             titleBar: string;
@@ -2837,7 +2850,7 @@ declare module "question_custom" {
          */
         onPropertyChanged?(question: Question, propertyName: string, newValue: any): void;
         /**
-         * A function that is called after the question value is changed.
+         * A function that is called after the question value is changed in the UI.
          *
          * Parameters:
          *
@@ -2847,10 +2860,12 @@ declare module "question_custom" {
          * The question's [name](https://surveyjs.io/Documentation/Library?id=Question#name).
          * - `newValue`: `any`\
          * A new value for the question.
+         *
+         * If you want to perform some actions when the value is changed in code as well as in the UI, implement the [`onValueSet`](https://surveyjs.io/form-library/documentation/api-reference/icustomquestiontypeconfiguration#onValueSet) function.
          */
         onValueChanged?(question: Question, name: string, newValue: any): void;
         /**
-         * A function that is called before a question value is changed.
+         * A function that is called before a question value is changed in the UI.
          *
          * This function should return the value you want to save: `newValue`, a custom value, or `undefined` if you want to clear the question value.
          *
@@ -2918,6 +2933,21 @@ declare module "question_custom" {
          * @returns An error text.
          */
         getErrorText?: (question: Question) => string;
+        /**
+         * A function that is called after the question value is set.
+         *
+         * Parameters:
+         *
+         * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question)\
+         * A custom question.
+         * - `newValue`: `any`\
+         * A new value for the question.
+         *
+         * Unlike the [`onValueChanged`](https://surveyjs.io/form-library/documentation/api-reference/icustomquestiontypeconfiguration#onValueChanged) function, which is called only when the question value is changed in the UI, `onValueSet` is called when the value is changed in code as well.
+         *
+         * [View Demo](https://surveyjs.io/survey-creator/examples/smart-search-input/ (linkStyle))
+         */
+        onValueSet?: (question: Question, newValue: any) => void;
         onSetQuestionValue?: (question: Question, newValue: any) => void;
         valueToQuestion?: (val: any) => any;
         valueFromQuestion?: (val: any) => any;
@@ -3459,6 +3489,8 @@ declare module "panel" {
         get questionTitleLocation(): string;
         set questionTitleLocation(value: string);
         getQuestionTitleLocation(): string;
+        availableQuestionTitleWidth(): boolean;
+        hasElementWithTitleLocationLeft(): boolean;
         /**
          * Sets consistent width for question titles in CSS values. Applies only when [`questionTitleLocation`](#questionTitleLocation) evaluates to `"left"`.
          *
@@ -4720,6 +4752,11 @@ declare module "question_baseselect" {
         get hasHeadItems(): boolean;
         get hasFootItems(): boolean;
         get columns(): any[];
+        protected getObservedElementSelector(): string;
+        protected supportResponsiveness(): boolean;
+        allowMultiColumns: boolean;
+        protected onBeforeSetCompactRenderer(): void;
+        protected onBeforeSetDesktopRenderer(): void;
         get hasColumns(): boolean;
         get rowLayout(): boolean;
         get blockedRow(): boolean;
@@ -4744,6 +4781,10 @@ declare module "question_baseselect" {
         protected getDefaultItemComponent(): string;
         /**
          * The name of a component used to render items.
+         *
+         * [View Dropdown Demo](https://surveyjs.io/form-library/examples/dropdown-box-with-custom-items/ (linkStyle))
+         *
+         * [View Ranking Demo](https://surveyjs.io/form-library/examples/dropdown-box-with-custom-items/ (linkStyle))
          */
         get itemComponent(): string;
         set itemComponent(value: string);
@@ -4963,7 +5004,7 @@ declare module "question_expression" {
         unlocCalculation(): void;
         runCondition(values: HashTable<any>, properties: HashTable<any>): void;
         protected canCollectErrors(): boolean;
-        protected hasRequiredError(): boolean;
+        hasRequiredError(): boolean;
         private createRunner;
         /**
          * The maximum number of fraction digits. Applies only if the `displayStyle` property is not `"none"`. Accepts values in the range from -1 to 20, where -1 disables the property.
@@ -6779,7 +6820,7 @@ declare module "question_paneldynamic" {
         private removedPanelIndex;
         removePanel(value: any): void;
         private getVisualPanelIndex;
-        private getPanelIndexById;
+        private getPanelVisibleIndexById;
         locStrsChanged(): void;
         clearIncorrectValues(): void;
         clearErrors(): void;
@@ -7978,6 +8019,7 @@ declare module "survey-events-api" {
          * A Boolean property that you can set to `false` if you want to cancel the drag and drop operation.
          */
         allow: boolean;
+        allowDropNextToAnother?: boolean;
         /**
          * Obsolete. Use `options.draggedElement` instead.
          */
@@ -10355,6 +10397,7 @@ declare module "survey" {
          *
          * You can override this property for individual Long Text questions: [`autoGrow`](https://surveyjs.io/form-library/documentation/api-reference/comment-field-model#autoGrow).
          * @see allowResizeComment
+         * @see commentAreaRows
          */
         get autoGrowComment(): boolean;
         set autoGrowComment(val: boolean);
@@ -10365,9 +10408,21 @@ declare module "survey" {
          *
          * You can override this property for individual Long Text questions: [`allowResize`](https://surveyjs.io/form-library/documentation/api-reference/comment-field-model#allowResize).
          * @see autoGrowComment
+         * @see commentAreaRows
          */
         get allowResizeComment(): boolean;
         set allowResizeComment(val: boolean);
+        /**
+         * Specifies the visible height of comment areas, measured in lines. Applies to the questions with the [`showCommentArea`](https://surveyjs.io/form-library/documentation/api-reference/question#showCommentArea) or [`showOtherItem`](https://surveyjs.io/form-library/documentation/api-reference/question#showOtherItem) property enabled.
+         *
+         * Default value: 2
+         *
+         * The value of this property is passed on to the `rows` attribute of the underlying `<textarea>` element.
+         * @see autoGrowComment
+         * @see allowResizeComment
+         */
+        get commentAreaRows(): number;
+        set commentAreaRows(val: number);
         /**
          * Specifies when to update the question value in questions with a text input field.
          *
@@ -10428,6 +10483,7 @@ declare module "survey" {
         get locale(): string;
         set locale(value: string);
         private onSurveyLocaleChanged;
+        get localeDir(): string;
         /**
          * Returns an array of locales whose translations are used in the survey.
          *
@@ -10871,6 +10927,24 @@ declare module "survey" {
          */
         mergeData(data: any): void;
         setDataCore(data: any, clearData?: boolean): void;
+        get isSurvey(): boolean;
+        /**
+         * Returns an object with survey results.
+         *
+         * If you want to get a survey results object that mirrors the survey structure, call the `getData()` method with an object that has the `includePages` and `includePanels` properties enabled. Without this object, the `getData()` method returns the [`data`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#data) property value.
+         *
+         * ```js
+         * import { Model } from "survey-core";
+         *
+         * const surveyJson = { ... };
+         * const survey = new Model(surveyJson);
+         * survey.getData({ includePages: true, includePanels: true });
+         * ```
+         */
+        getData(options?: {
+            includePages?: boolean;
+            includePanels?: boolean;
+        }): any;
         getStructuredData(includePages?: boolean, level?: number): any;
         setStructuredData(data: any, doMerge?: boolean): void;
         private collectDataFromPanel;
@@ -12132,55 +12206,6 @@ declare module "survey" {
         questionErrorComponent: string;
     }
 }
-declare module "knockout/kobase" {
-    import { Base } from "entries/core";
-    export class ImplementorBase {
-        element: Base;
-        private static doIterateProperties;
-        readonly implementedMark = "__surveyImplementedKo";
-        constructor(element: Base);
-        dispose(): void;
-    }
-}
-declare module "knockout/kopage" {
-    import { PageModel } from "entries/core";
-    import { PanelModelBase, PanelModel, QuestionRowModel } from "entries/core";
-    import { SurveyElement } from "entries/core";
-    import { ImplementorBase } from "knockout/kobase";
-    export class QuestionRow extends QuestionRowModel {
-        panel: PanelModelBase;
-        koElementAfterRender: any;
-        constructor(panel: PanelModelBase);
-        getElementType(el: any): "survey-panel" | "survey-question";
-        koAfterRender(htmlElements: any, element: SurveyElement): void;
-        private elementAfterRender;
-        rowAfterRender(elements: HTMLElement[], model: QuestionRow): void;
-        dispose(): void;
-    }
-    export class PanelImplementorBase extends ImplementorBase {
-        panel: PanelModelBase;
-        constructor(panel: PanelModelBase);
-    }
-    export class Panel extends PanelModel {
-        private _implementor;
-        koElementType: any;
-        constructor(name?: string);
-        protected onBaseCreating(): void;
-        createRow(): QuestionRowModel;
-        protected onCreating(): void;
-        protected onNumChanged(value: number): void;
-        dispose(): void;
-    }
-    export class Page extends PageModel {
-        private _implementor;
-        constructor(name?: string);
-        protected onBaseCreating(): void;
-        createRow(): QuestionRowModel;
-        protected onCreating(): void;
-        protected onNumChanged(value: number): void;
-        dispose(): void;
-    }
-}
 declare module "survey-element" {
     import { Base } from "base";
     import { IAction } from "actions/action";
@@ -12195,6 +12220,26 @@ declare module "survey-element" {
     export abstract class SurveyElementCore extends Base implements ILocalizableOwner {
         constructor();
         protected createLocTitleProperty(): LocalizableString;
+        /**
+         * Returns `true` if the survey element is a page.
+         * @see Base.getType
+         */
+        get isPage(): boolean;
+        /**
+         * Returns `true` if the survey element is a panel.
+         * @see Base.getType
+         */
+        get isPanel(): boolean;
+        /**
+         * Returns `true` if the survey element is a question.
+         * @see Base.getType
+         */
+        get isQuestion(): boolean;
+        /**
+         * Returns `true` if the element is a survey.
+         * @see Base.getType
+         */
+        get isSurvey(): boolean;
         /**
          * A title for the survey element. If `title` is undefined, the `name` property value is displayed instead.
          *
@@ -12462,21 +12507,6 @@ declare module "survey-element" {
         onFirstRendering(): void;
         endLoadingFromJson(): void;
         setVisibleIndex(index: number): number;
-        /**
-         * Returns `true` if the survey element is a page.
-         * @see Base.getType
-         */
-        get isPage(): boolean;
-        /**
-         * Returns `true` if the survey element is a panel.
-         * @see Base.getType
-         */
-        get isPanel(): boolean;
-        /**
-         * Returns `true` if the survey element is a question.
-         * @see Base.getType
-         */
-        get isQuestion(): boolean;
         delete(doDispose: boolean): void;
         locOwner: ILocalizableOwner;
         /**
@@ -13160,6 +13190,7 @@ declare module "question" {
         set hasOther(val: boolean);
         protected hasOtherChanged(): void;
         get requireUpdateCommentValue(): boolean;
+        readOnlyCallback: () => boolean;
         get isReadOnly(): boolean;
         get isInputReadOnly(): boolean;
         get renderedInputReadOnly(): string;
@@ -13197,6 +13228,7 @@ declare module "question" {
         protected initDataFromSurvey(): void;
         protected initCommentFromSurvey(): void;
         protected runExpression(expression: string): any;
+        get commentAreaRows(): number;
         private get autoGrowComment();
         private get allowResizeComment();
         private get questionValue();
@@ -13397,6 +13429,7 @@ declare module "question" {
         protected isValueExpression(val: any): boolean;
         protected setValueAndRunExpression(runner: ExpressionRunner, defaultValue: any, setFunc: (val: any) => void, values?: HashTable<any>, properties?: HashTable<any>): void;
         protected convertFuncValuetoQuestionValue(val: any): any;
+        private runExpressionSetValueCore;
         private runExpressionSetValue;
         private runDefaultValueExpression;
         /**
@@ -13458,7 +13491,7 @@ declare module "question" {
         protected canRunValidators(isOnValueChanged: boolean): boolean;
         private fireSurveyValidation;
         protected onCheckForErrors(errors: Array<SurveyError>, isOnValueChanged: boolean): void;
-        protected hasRequiredError(): boolean;
+        hasRequiredError(): boolean;
         private validatorRunner;
         private isRunningValidatorsValue;
         onCompletedAsyncValidators: (hasErrors: boolean) => void;
@@ -13751,6 +13784,7 @@ declare module "martixBase" {
         protected onColumnsChanged(): void;
         protected onRowsChanged(): void;
         protected updateVisibilityBasedOnRows(): void;
+        protected isVisibleCore(): boolean;
         protected shouldRunColumnExpression(): boolean;
         protected hasRowsAsItems(): boolean;
         protected runItemsCondition(values: HashTable<any>, properties: HashTable<any>): boolean;
@@ -13824,6 +13858,7 @@ declare module "question_matrixdropdownbase" {
         onTotalValueChanged(): any;
         getSurvey(): ISurvey;
         getDataFilteredValues(): any;
+        isMatrixReadOnly(): boolean;
     }
     export class MatrixDropdownCell {
         column: MatrixDropdownColumn;
@@ -13871,6 +13906,8 @@ declare module "question_matrixdropdownbase" {
         get rowName(): any;
         get dataName(): string;
         get text(): any;
+        isRowEnabled(): boolean;
+        protected isRowHasEnabledCondition(): boolean;
         get value(): any;
         set value(value: any);
         get locText(): LocalizableString;
@@ -13923,7 +13960,7 @@ declare module "question_matrixdropdownbase" {
         locStrsChanged(): void;
         updateCellQuestionOnColumnChanged(column: MatrixDropdownColumn, name: string, newValue: any): void;
         updateCellQuestionOnColumnItemValueChanged(column: MatrixDropdownColumn, propertyName: string, obj: ItemValue, name: string, newValue: any, oldValue: any): void;
-        onQuestionReadOnlyChanged(parentIsReadOnly: boolean): void;
+        onQuestionReadOnlyChanged(): void;
         private validationValues;
         hasErrors(fireCallback: boolean, rec: any, raiseOnCompletedAsyncValidators: () => void): boolean;
         protected updateCellOnColumnChanged(cell: MatrixDropdownCell, name: string, newValue: any): void;
@@ -14302,6 +14339,7 @@ declare module "question_matrixdropdownbase" {
         onTotalValueChanged(): any;
         getDataFilteredValues(): any;
         getParentTextProcessor(): ITextProcessor;
+        isMatrixReadOnly(): boolean;
         getQuestionFromArray(name: string, index: number): IQuestion;
         private isMatrixValueEmpty;
         private get SurveyModel();
@@ -14391,6 +14429,7 @@ declare module "base-interfaces" {
         isUpdateValueTextOnTyping: boolean;
         autoGrowComment: boolean;
         allowResizeComment: boolean;
+        commentAreaRows: number;
         state: string;
         isLazyRendering: boolean;
         lazyRenderingFirstBatchSize: number;
@@ -15919,11 +15958,18 @@ declare module "settings" {
          */
         ratingMaximumRateValueCount: number;
         /**
-         * Specifies whether to close the drop-down menu of a [TagBox](https://surveyjs.io/form-library/examples/how-to-create-multiselect-tag-box/) question after a user selects a value.
+         * Specifies whether to close the drop-down menu of a [Multi-Select Dropdown (Tag Box)](https://surveyjs.io/form-library/examples/how-to-create-multiselect-tag-box/) question after a user selects a value.
          *
-         * This setting applies to all TagBox questions on a page. You can use the [closeOnSelect](https://surveyjs.io/form-library/documentation/api-reference/dropdown-tag-box-model#closeOnSelect) property to specify the same setting for an individual TagBox question.
+         * This setting applies to all Multi-Select Dropdown questions on a web page. You can use the [`closeOnSelect`](https://surveyjs.io/form-library/documentation/api-reference/dropdown-tag-box-model#closeOnSelect) property to specify the same setting for an individual Multi-Select Dropdown question.
          */
         tagboxCloseOnSelect: boolean;
+        /**
+         * A time interval in milliseconds between the last entered character and the beginning of search in [Single-](https://surveyjs.io/form-library/examples/create-dropdown-menu-in-javascript/) and [Multi-Select Dropdown](https://surveyjs.io/form-library/examples/how-to-create-multiselect-tag-box/) questions. Applies only to questions with the [`choicesLazyLoadEnabled`](https://surveyjs.io/form-library/documentation/api-reference/dropdown-menu-model#choicesLazyLoadEnabled) property set to `true`.
+         *
+         * Default value: 500
+         *
+         * [View Demo](https://surveyjs.io/form-library/examples/lazy-loading-dropdown/ (linkStyle))
+         */
         dropdownSearchDelay: number;
         /**
          * A function that activates a browser confirm dialog.
@@ -16179,6 +16225,8 @@ declare module "question_matrixdropdown" {
         get rowName(): string;
         get text(): string;
         get locText(): LocalizableString;
+        isRowEnabled(): boolean;
+        protected isRowHasEnabledCondition(): boolean;
     }
     /**
       * A class that describes the Multi-Select Matrix question type. Multi-Select Matrix allows you to use the [Dropdown](https://surveyjs.io/form-library/documentation/questiondropdownmodel), [Checkbox](https://surveyjs.io/form-library/documentation/questioncheckboxmodel), [Radiogroup](https://surveyjs.io/form-library/documentation/questionradiogroupmodel), [Text](https://surveyjs.io/form-library/documentation/questiontextmodel), and [Comment](https://surveyjs.io/form-library/documentation/questioncommentmodel) question types as cell editors.
@@ -16243,7 +16291,6 @@ declare module "dropdownListModel" {
         protected readonly itemSelector = ".sv-list__item";
         protected getFocusFirstInputSelector(): string;
         private itemsSettings;
-        private isRunningLoadQuestionChoices;
         protected listModel: ListModel<ItemValue>;
         protected popupCssClasses: string;
         protected listModelFilterStringChanged: (newValue: string) => void;
@@ -16883,6 +16930,7 @@ declare module "question_checkbox" {
         get checkBoxSvgPath(): string;
         get isNewA11yStructure(): boolean;
         get a11y_input_ariaRole(): string;
+        get a11y_input_ariaRequired(): "true" | "false";
     }
 }
 declare module "multiSelectListModel" {
@@ -17213,6 +17261,7 @@ declare module "dragdrop/choices" {
         private imagepickerControlsNode;
         protected get draggedElementType(): string;
         protected createDraggedElementShortcut(text: string, draggedElementNode: HTMLElement, event: PointerEvent): HTMLElement;
+        onShortcutCreated: (node: HTMLElement) => void;
         private createImagePickerShortcut;
         protected getDropTargetByDataAttributeValue(dataAttributeValue: string): ItemValue;
         private getVisibleChoices;
@@ -17241,7 +17290,7 @@ declare module "dragdrop/ranking-choices" {
         protected isDropTargetValid(dropTarget: ItemValue, dropTargetNode?: HTMLElement): boolean;
         protected calculateIsBottom(clientY: number, dropTargetNode?: HTMLElement): boolean;
         protected doDragOver: () => any;
-        getIndixies(model: any, fromChoicesArray: Array<ItemValue>, toChoicesArray: Array<ItemValue>): {
+        getIndices(model: any, fromChoicesArray: Array<ItemValue>, toChoicesArray: Array<ItemValue>): {
             fromIndex: number;
             toIndex: number;
         };
@@ -17332,7 +17381,7 @@ declare module "question_ranking" {
         endLoadingFromJson(): void;
         private setDragDropRankingChoices;
         protected createDragDropRankingChoices(): DragDropRankingChoices;
-        private draggedChoise;
+        private draggedChoiceValue;
         private draggedTargetNode;
         handlePointerDown: (event: PointerEvent, choice: ItemValue, node: HTMLElement) => void;
         startDrag: (event: PointerEvent) => void;
@@ -17366,9 +17415,6 @@ declare module "question_ranking" {
         */
         get longTap(): boolean;
         set longTap(val: boolean);
-        /**
-         * The name of a component used to render items.
-         */
         protected getDefaultItemComponent(): string;
         /**
          * Specifies whether users can select choices they want to rank.
@@ -17786,9 +17832,14 @@ declare module "question_rating" {
         getItemClassByText(item: ItemValue, text: string): string;
         private getRenderedItemColor;
         getItemStyle(item: ItemValue, highlight?: "none" | "highlighted" | "unhighlighted"): {
-            borderColor: string;
-            fill: string;
-            backgroundColor: string;
+            "--sd-rating-item-color"?: undefined;
+            "--sd-rating-item-color-light"?: undefined;
+        } | {
+            "--sd-rating-item-color": string;
+            "--sd-rating-item-color-light": string;
+        } | {
+            "--sd-rating-item-color": string;
+            "--sd-rating-item-color-light"?: undefined;
         };
         getItemClass(item: ItemValue, highlight?: "none" | "highlighted" | "unhighlighted"): string;
         getControlClass(): string;